Kontoinformationen abrufen

GET

users

curl --request GET \
  --url https://api.squarecloud.app/v2/users/me \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/users/me', 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/users/me",
  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/users/me"

	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/users/me")

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": {
    "user": {
      "id": "123456789012345678",
      "name": "John Doe",
      "email": "john@example.com",
      "plan": {
        "name": "standard-4",
        "memory": {
          "limit": 4096,
          "available": 3840,
          "used": 256
        },
        "duration": 1732072955446
      },
      "created_at": "2022-01-10T12:00:00Z"
    },
    "applications": [
      {
        "name": "Square Example APP",
        "id": "446b0b4118634a1c99e73bac9a54e475",
        "desc": "This is a example of description",
        "ram": 512,
        "lang": "javascript",
        "domain": "square-example-app.squareweb.app",
        "custom": "mydomain.com",
        "cluster": "suki-cluster",
        "created_at": "2023-02-20T14:30:00Z"
      }
    ],
    "databases": [
      {
        "id": "db1234567890",
        "name": "example-database",
        "type": "mongodb",
        "cluster": "suki-cluster",
        "ram": 1024,
        "created_at": "2023-01-15T10:00:00Z"
      }
    ]
  }
}

string

erforderlich

Der API-Schlüssel für dein Konto. Du findest ihn in deinen Kontoeinstellungen.

Erfordert einen API-Schlüssel mit dem Scope account:read. Kontoinformationen gibt in einem einzigen Aufruf alles über dein eigenes Square-Cloud-Konto zurück: Profil, Plan- und Speichernutzung sowie jede Anwendung und Datenbank, die dir gehört. Ein guter Ausgangsaufruf für Dashboards oder CLI-Tools, die eine Kontoübersicht darstellen müssen, ohne jede Anwendung und Datenbank einzeln abzufragen. Die Antwort ist auf den authentifizierten Token beschränkt; es gibt keine Möglichkeit, über diese Route die Daten eines anderen Kontos anzufordern. Anwendungen enthalten ihre Domain und ihren Cluster, und Datenbanken enthalten ihren Typ und RAM, beides genug, um eine Listenansicht ohne zusätzliche Roundtrips zu erstellen. Um in eine einzelne Anwendung einzutauchen, siehe Anwendungsinformationen abrufen; für die Backups des Kontos siehe Snapshots auflisten.

Antwort

string

Gibt an, ob der Aufruf erfolgreich war: success, wenn ja, error, wenn nicht.

object

Der Inhalt der Antwort.

Anzeigen Objekt umschalten

object

Anzeigen Objekt umschalten

string

Die ID des Benutzers.

string

Der Name des Benutzers.

string

Die E-Mail-Adresse des Benutzers.

string

Die Spracheinstellung des Benutzers.

object

Anzeigen Objekt umschalten

string

Der Name des Plans des Benutzers.

object

Die Arbeitsspeicherdetails des Plans des Benutzers.

Anzeigen Objekt umschalten

number

Das Arbeitsspeicherlimit des Plans des Benutzers in MB.

number

Der verfügbare Arbeitsspeicher des Plans des Benutzers in MB.

number

Der genutzte Arbeitsspeicher des Plans des Benutzers in MB.

number

Wann der Plan abläuft, als Unix-Zeitstempel in Millisekunden.

date

Das Erstellungsdatum des Benutzerkontos.

array

Anzeigen Objekt umschalten

string

Der Name der Anwendung.

string

Die ID der Anwendung.

string

Die Beschreibung der Anwendung.

number

Die RAM-Nutzung der Anwendung.

string

Die Sprache der Anwendung.

string

Die Domain der Anwendung.

string

Die benutzerdefinierte Domain der Anwendung.

string

Der Cluster der Anwendung.

date

Das Erstellungsdatum der Anwendung.

array

Anzeigen Objekt umschalten

string

Die ID der Datenbank.

string

Der Name der Datenbank.

number

Die RAM-Nutzung der Datenbank.

string

Der Typ der Datenbank.

string

Der Cluster der Datenbank.

date

Das Erstellungsdatum der Datenbank.

{
  "status": "success",
  "response": {
    "user": {
      "id": "123456789012345678",
      "name": "John Doe",
      "email": "john@example.com",
      "plan": {
        "name": "standard-4",
        "memory": {
          "limit": 4096,
          "available": 3840,
          "used": 256
        },
        "duration": 1732072955446
      },
      "created_at": "2022-01-10T12:00:00Z"
    },
    "applications": [
      {
        "name": "Square Example APP",
        "id": "446b0b4118634a1c99e73bac9a54e475",
        "desc": "This is a example of description",
        "ram": 512,
        "lang": "javascript",
        "domain": "square-example-app.squareweb.app",
        "custom": "mydomain.com",
        "cluster": "suki-cluster",
        "created_at": "2023-02-20T14:30:00Z"
      }
    ],
    "databases": [
      {
        "id": "db1234567890",
        "name": "example-database",
        "type": "mongodb",
        "cluster": "suki-cluster",
        "ram": 1024,
        "created_at": "2023-01-15T10:00:00Z"
      }
    ]
  }
}

Siehe auch

CLI: squarecloud auth whoami
SDKs: api.account.me() (JavaScript), client.account.me() (Python), c.Account.Me() (Go)

Kontoinformationen abrufen

curl --request GET \
  --url https://api.squarecloud.app/v2/users/me \
  --header 'Authorization: <authorization>'

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.squarecloud.app/v2/users/me', 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/users/me",
  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/users/me"

	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/users/me")

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": {
    "user": {
      "id": "123456789012345678",
      "name": "John Doe",
      "email": "john@example.com",
      "plan": {
        "name": "standard-4",
        "memory": {
          "limit": 4096,
          "available": 3840,
          "used": 256
        },
        "duration": 1732072955446
      },
      "created_at": "2022-01-10T12:00:00Z"
    },
    "applications": [
      {
        "name": "Square Example APP",
        "id": "446b0b4118634a1c99e73bac9a54e475",
        "desc": "This is a example of description",
        "ram": 512,
        "lang": "javascript",
        "domain": "square-example-app.squareweb.app",
        "custom": "mydomain.com",
        "cluster": "suki-cluster",
        "created_at": "2023-02-20T14:30:00Z"
      }
    ],
    "databases": [
      {
        "id": "db1234567890",
        "name": "example-database",
        "type": "mongodb",
        "cluster": "suki-cluster",
        "ram": 1024,
        "created_at": "2023-01-15T10:00:00Z"
      }
    ]
  }
}

Erste Schritte

Konto

Anwendungen

Datenbanken

Workspaces

KI

Kontoinformationen abrufen

Antwort

Siehe auch

​Antwort

​Siehe auch

Antwort

Siehe auch