アプリケーション - ファイルマネージャー
ファイルの一覧表示
アプリケーションのファイルを一覧表示します。
GET
/
v2
/
apps
/
{app_id}
/
files
ファイルの一覧表示
curl --request GET \
--url https://api.squarecloud.app/v2/apps/{app_id}/files \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/files"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/apps/{app_id}/files"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/files")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": [
{
"type": "file",
"name": ".env",
"size": 86,
"lastModified": 1676168978000
},
{
"type": "file",
"name": ".gitignore",
"size": 8,
"lastModified": 1675125328000
},
{
"type": "file",
"name": "index.js",
"size": 614,
"lastModified": 1676168350000
},
{
"type": "file",
"name": "squarecloud.app",
"size": 65,
"lastModified": 1676169188000
},
{
"type": "directory",
"name": "src",
"lastModified": 1676155738000
}
]
}
ファイルの一覧表示は、アプリケーション内の指定したパスにあるファイルとディレクトリを返し、各エントリには種類、サイズ、最終更新日時が含まれます。特定のファイルを読み取り、書き込み、削除する前に、ダッシュボードやスクリプトからアプリケーションのストレージを閲覧する際に使用してください。
一覧はリクエスト時点でのクラスターノード上のアプリケーションのストレージを反映しており、キャッシュされません。ファイルの内容を取得するには ファイルの読み取り と、ファイルを書き込むには ファイルの作成・変更 と組み合わせて使用してください。
path を省略するとアプリケーションのルートが一覧表示されます。
ワークスペースで共有されているアプリケーションでは、呼び出し元に Maintainer または Administrator ロールが必要です。制限ファイルへのアクセス権限を持たないメンバーには結果に .env や .env.production が表示されず、それらのエントリはエラーではなくレスポンスから除外されます。
Parameters
string
必須
アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
string
必須
ファイルを一覧表示したいディレクトリのパス。デフォルトはルートディレクトリです。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。array
{
"status": "success",
"response": [
{
"type": "file",
"name": ".env",
"size": 86,
"lastModified": 1676168978000
},
{
"type": "file",
"name": ".gitignore",
"size": 8,
"lastModified": 1675125328000
},
{
"type": "file",
"name": "index.js",
"size": 614,
"lastModified": 1676168350000
},
{
"type": "file",
"name": "squarecloud.app",
"size": 65,
"lastModified": 1676169188000
},
{
"type": "directory",
"name": "src",
"lastModified": 1676155738000
}
]
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_PATH | 400 | クエリパラメータ path の検証に失敗した、またはクラスターがディレクトリを読み取れませんでした。 |
BLOCKED_PATH | 403 | リクエストされたパスがプラットフォームのブロック対象パスの一覧に含まれています。 |
⌘I
ファイルの一覧表示
curl --request GET \
--url https://api.squarecloud.app/v2/apps/{app_id}/files \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/files"
headers = {"Authorization": "<authorization>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<authorization>'}};
fetch('https://api.squarecloud.app/v2/apps/{app_id}/files', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.squarecloud.app/v2/apps/{app_id}/files",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/apps/{app_id}/files"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<authorization>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.squarecloud.app/v2/apps/{app_id}/files")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/files")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<authorization>'
response = http.request(request)
puts response.read_body{
"status": "success",
"response": [
{
"type": "file",
"name": ".env",
"size": 86,
"lastModified": 1676168978000
},
{
"type": "file",
"name": ".gitignore",
"size": 8,
"lastModified": 1675125328000
},
{
"type": "file",
"name": "index.js",
"size": 614,
"lastModified": 1676168350000
},
{
"type": "file",
"name": "squarecloud.app",
"size": 65,
"lastModified": 1676169188000
},
{
"type": "directory",
"name": "src",
"lastModified": 1676155738000
}
]
}

