アプリケーション - ファイルマネージャー
ファイルの読み取り
アプリケーションからファイルを読み取ります。
GET
/
v2
/
apps
/
{app_id}
/
files
/
content
ファイルの読み取り
curl --request GET \
--url https://api.squarecloud.app/v2/apps/{app_id}/files/content \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/files/content"
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/content', 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/content",
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/content"
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/content")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/files/content")
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": "Buffer",
"data": [
112,
111,
120,
97,
44,
32,
116,
97,
32,
113,
117,
101,
114,
101,
110,
100,
111,
32,
99,
111,
112,
105,
97,
114,
32,
97,
116,
195,
169,
32,
111,
32,
98,
117,
102,
102,
101,
114,
63
]
}
}
ファイルの読み取りは、実行中のアプリケーション内にある 1 つのファイルの生バイト列を、ストリームではなく JSON の
{ type: "Buffer", data: number[] } オブジェクトとして返します。これは設定ファイルやログ、小さなアセットなど個々のファイルを API 経由で確認・ダウンロードするためのものであり、一括転送を目的としていません。アプリケーション全体のコピーを取得したい場合は、代わりに スナップショットの作成 を使用してください。
読み取る前に利用可能なファイルを確認するには、まず ファイルの一覧表示 を呼び出してください。ファイルを書き戻すには、バイナリコンテンツに同じ Buffer 形式を受け付ける ファイルの作成・変更 を使用します。
ワークスペースで共有されているアプリケーションでは、呼び出し元に Maintainer または Administrator ロールが必要です。制限ファイルへのアクセス権限を持たないメンバーは .env や .env.production を読み取ることができず、ファイルに触れる前にリクエストは PERMISSION_DENIED で拒否されます。
Parameters
string
必須
アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
string
必須
読み取りたいファイルのパス。これはアプリケーションのルートからの相対パスです。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。object
{
"status": "success",
"response": {
"type": "Buffer",
"data": [
112,
111,
120,
97,
44,
32,
116,
97,
32,
113,
117,
101,
114,
101,
110,
100,
111,
32,
99,
111,
112,
105,
97,
114,
32,
97,
116,
195,
169,
32,
111,
32,
98,
117,
102,
102,
101,
114,
63
]
}
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_PATH | 400 | クエリパラメータ path の検証に失敗しました（パストラバーサル、無効な文字、または長すぎる）。 |
PERMISSION_DENIED | 403 | 呼び出し元に、制限されたファイル（.env、.env.production）を読み取るためのワークスペース権限がありません。 |
FILE_NOT_FOUND | 404 | 指定されたパスにファイルが存在しません。 |
FILE_TOO_LARGE | 413 | ファイルマネージャー経由で読み取るにはファイルが大きすぎます。 |
⌘I
ファイルの読み取り
curl --request GET \
--url https://api.squarecloud.app/v2/apps/{app_id}/files/content \
--header 'Authorization: <authorization>'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/files/content"
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/content', 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/content",
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/content"
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/content")
.header("Authorization", "<authorization>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.squarecloud.app/v2/apps/{app_id}/files/content")
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": "Buffer",
"data": [
112,
111,
120,
97,
44,
32,
116,
97,
32,
113,
117,
101,
114,
101,
110,
100,
111,
32,
99,
111,
112,
105,
97,
114,
32,
97,
116,
195,
169,
32,
111,
32,
98,
117,
102,
102,
101,
114,
63
]
}
}