Datei lesen - Square Cloud

GET

apps

{app_id}

files

content

Datei lesen

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))

}

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
        ]
    }
}

string

erforderlich

Der API-Schlüssel für Ihr Konto. Sie finden ihn in Ihren Kontoeinstellungen.

Datei lesen gibt die Rohbytes einer einzelnen Datei innerhalb einer laufenden Anwendung zurück, kodiert als JSON-Objekt { type: "Buffer", data: number[] } statt als Stream. Der Endpunkt ist für das Ansehen oder Herunterladen einzelner Dateien (Konfigurationen, Logs, kleine Assets) über die API gedacht, nicht für Massentransfers, nutze stattdessen Snapshot erstellen, um eine vollständige Kopie der Anwendung zu erhalten. Um vorab zu sehen, was verfügbar ist, rufe zuerst Dateien auflisten auf. Um eine Datei zurückzuschreiben, nutze Datei erstellen/ändern, das für Binärinhalte dasselbe Buffer-Format akzeptiert. Bei Workspace-geteilten Anwendungen benötigt der Aufrufer die Rolle Maintainer oder Administrator, und Mitglieder ohne die Berechtigung für eingeschränkte Dateien können .env oder .env.production nicht lesen, die Anfrage wird mit PERMISSION_DENIED abgelehnt, bevor die Datei angefasst wird.

Parameter

string

erforderlich

Die ID der Anwendung. Du findest sie in der URL des Dashboards deiner Anwendung.

string

erforderlich

Der Pfad zur Datei, die du lesen möchtest. Dieser ist relativ zum Stammverzeichnis deiner Anwendung.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war. success bei Erfolg, error andernfalls.

object

Der Inhalt der Datei.

Anzeigen Objekt umschalten

string

Der Typ der Daten. Bei Binärdaten ist er “Buffer”.

array

Die Daten der Datei, dargestellt als Array von Zahlen. Diese Zahlen repräsentieren die Bytes der Datei.

{
    "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
        ]
    }
}

Häufige Fehler

Code	HTTP	Bedeutung
`INVALID_PATH`	400	Der Query-Parameter `path` hat die Validierung nicht bestanden (Traversal, ungültige Zeichen oder zu lang).
`PERMISSION_DENIED`	403	Dem Aufrufer fehlt die Workspace-Berechtigung, um eine eingeschränkte Datei (`.env`, `.env.production`) zu lesen.
`FILE_NOT_FOUND`	404	Unter dem angegebenen Pfad existiert keine Datei.
`FILE_TOO_LARGE`	413	Die Datei ist zu groß, um über den Dateimanager gelesen zu werden.

Zurück

Dateien auflistenDie Dateien deiner Anwendung auflisten.

Weiter

Datei lesen

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))

}

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
        ]
    }
}

​Parameter

​Antwort

​Häufige Fehler

Parameter

Antwort

Häufige Fehler