アプリケーション - ファイルマネージャー
ファイルの移動
アプリケーション内のファイルを移動します。
PATCH
/
v2
/
apps
/
{app_id}
/
files
ファイルの移動
curl --request PATCH \
--url https://api.squarecloud.app/v2/apps/{app_id}/files \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"path": "<string>",
"to": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/files"
payload = {
"path": "<string>",
"to": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: '<string>', to: '<string>'})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'path' => '<string>',
'to' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/apps/{app_id}/files"
payload := strings.NewReader("{\n \"path\": \"<string>\",\n \"to\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.squarecloud.app/v2/apps/{app_id}/files")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"path\": \"<string>\",\n \"to\": \"<string>\"\n}")
.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::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"path\": \"<string>\",\n \"to\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success"
}
ファイルの移動は、アプリケーションのストレージ内にあるファイルの内容をダウンロード・再アップロードすることなく、
path から to へ 1 つのファイルの名前変更または再配置を行います。ディレクトリ構造の整理や設定ファイルの名前変更をその場で行いたい場合に使用してください。
path と to はどちらもパスの検証を通過し、かつ互いに異なる値である必要があります。両方に同じ値を送信すると INVALID_PATH で拒否されます。この操作は実行中のアプリケーションのストレージ上でファイルを移動するだけで、プロセスは再起動されません。そのため、古いパスを読み込んでいる実行中のプロセスは、再読み込みされるかアプリケーションが 再起動 されるまで変更に気付きません。移動ではなくファイルを削除するには ファイルの削除 を参照してください。
ワークスペースで共有されているアプリケーションでは、呼び出し元に Maintainer または Administrator ロールが必要です。制限ファイルのチェックは移動元と移動先の両方の名前に適用されるため、その権限を持たないメンバーは、許可されているファイルを .env のような保護された名前にリネームして仕込んだり上書きしたりすることはできません。
Parameters
string
必須
アプリケーションのID。アプリケーションのダッシュボードのURLで確認できます。
string
必須
移動するファイルのパス。
string
必須
ファイルの移動先のパス。
Response
string
呼び出しが成功したかどうかを示します。成功した場合は
success、失敗した場合は error です。{
"status": "success"
}
一般的なエラー
| コード | HTTP | 説明 |
|---|---|---|
INVALID_PATH | 400 | path または to の検証に失敗した、あるいは path と to が同一でした。 |
RENAME_FAILED | 400 | クラスターがファイルの名前を変更できませんでした。 |
PERMISSION_DENIED | 403 | 呼び出し元に、制限されたファイルの名前を変更するためのワークスペース権限がありません(移動元と移動先の両方の名前でチェックされます)。 |
⌘I
ファイルの移動
curl --request PATCH \
--url https://api.squarecloud.app/v2/apps/{app_id}/files \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"path": "<string>",
"to": "<string>"
}
'import requests
url = "https://api.squarecloud.app/v2/apps/{app_id}/files"
payload = {
"path": "<string>",
"to": "<string>"
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({path: '<string>', to: '<string>'})
};
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 => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'path' => '<string>',
'to' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.squarecloud.app/v2/apps/{app_id}/files"
payload := strings.NewReader("{\n \"path\": \"<string>\",\n \"to\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.squarecloud.app/v2/apps/{app_id}/files")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"path\": \"<string>\",\n \"to\": \"<string>\"\n}")
.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::Patch.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"path\": \"<string>\",\n \"to\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success"
}

