Zum Inhalt springen
Geprüft

Projekte und Deployments auflisten

Jeder Workspace, den ein Konto besitzt, dann jede tatsächlich laufende App, als zwei CouchDB-View-Lesezugriffe.

"Projekte" und "Deployments" beantworten zwei verschiedene Fragen. Ein Projekt ist ein Workspace des Kontos, das, was du im Projektwechsler siehst, egal ob darin je etwas live gegangen ist. Ein Deployment ist eine App, die tatsächlich irgendwo läuft, is_deployment: true in ihrem eigenen Dokument. Ein Konto aufzulisten heißt meist beides: zuerst die Workspaces, dann das, was in jedem davon läuft.

Methoden

POST/cpi/get_account_projects
user

Get Account Projects

Returns the projects owned by the account (or all projects for superuser and support accounts) from the user_projects master view.

POST/cpi/get_account_deployments
user

Get Account Deployments

Returns the deployments associated with the account from the user_deployments master view.

Schritt für Schritt

Die Projekte des Kontos auflisten

Keine Felder außer deinem Schlüssel: Beide Methoden fragen den CouchDB-View über die uid ab, zu der deine Zugangsberechtigung bereits führt.

curl -s https://xuda.ai/cpi/get_account_projects \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_projects', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) {
  for (const row of data.rows) console.log(row.id, row.value.app_name, row.value.app_status_code);
}
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_projects',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value']['app_name'], row['value']['app_status_code'])

2. Auflisten, was tatsächlich bereitgestellt ist

Gleiche Form, anderer View: user_deployments gibt ein Dokument nur aus, wenn is_deployment wahr ist, diese Liste ist also eine Teilmenge aller Apps, die das Konto je erstellt hat, nämlich die mit einer aktiven Zugriffs-URL.

curl -s https://xuda.ai/cpi/get_account_deployments \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY"}'
const res = await fetch('https://xuda.ai/cpi/get_account_deployments', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({ api_key: 'YOUR_API_KEY' }),
});
const { code, data } = await res.json();
if (code > 0) {
  for (const row of data.rows) console.log(row.id, row.value.app_hosting, row.value.app_status_code);
}
import requests

res = requests.post(
    'https://xuda.ai/cpi/get_account_deployments',
    json={'api_key': 'YOUR_API_KEY'},
)
body = res.json()
if body['code'] > 0:
    for row in body['data']['rows']:
        print(row['id'], row['value']['app_hosting'], row['value']['app_status_code'])

Die Antwort

Beide Methoden reichen ein CouchDB-View-Ergebnis unverpackt durch: code ist 871 (der feste Erfolgscode, den get_couch_view immer zurückgibt, nicht das übliche 1), und data ist die rohe nano-View-Antwort, total_rows, offset und ein rows-Array aus { id, key, value }. id ist die _id des Projekts (oder Deployments), der Wert, den du bei jedem anderen Aufruf in diesem Abschnitt als app_id übergibst.

json
{
  "code": 871,
  "data": {
    "total_rows": 3,
    "offset": 0,
    "rows": [
      {
        "id": "app_5d9e21",
        "key": "acc_8f2a1c",
        "value": {
          "_id": "app_5d9e21",
          "app_name": "Marketing site",
          "app_type": "master",
          "app_status_code": 3,
          "app_access_type": "private",
          "docDate": 1735689600000,
          "app_icon_prop": { "app_icon_background_color": "#4f46e5", "app_icon_size": "md" }
        }
      }
    ]
  }
}

Die Zeilen von get_account_deployments enthalten dieselben Felder plus app_hosting_server, app_datacenter_id, app_hosting und is_deployment: true, da user_deployments diese zusätzlich zum gemeinsamen Satz ausgibt. app_status_code < 4 ist der einzige Status, den dieser View oder user_projects dir je zeigt: Beide Map-Funktionen filtern alles ab 4 heraus, ein gelöschtes Projekt verschwindet also einfach, statt mit einem Status zu erscheinen, den du prüfen müsstest.

Die Zeile eines Workspace kann einen Namensoverride tragen

get_account_projects setzt main_profile_name auf die Zeile des eigenen Workspace des Kontos, wenn dieser Workspace ein benanntes Profil hat. Die Zeile, die du als "dein" Projekt zeigst, kann also anders lauten als ihr gespeicherter app_name. Bevorzuge main_profile_name, wenn vorhanden.

Fehler

Beide Methoden scheitern nur so, wie jeder Aufruf scheitern kann: ein fehlender oder nicht berechtigter api_key (-401, siehe Fehler). Keine der beiden verzweigt nach app_id oder einer anderen Eingabe, da keine eine nimmt. Ein leeres rows-Array ist eine echte, erfolgreiche Antwort für ein Konto, das noch nichts in dieser Liste hat, kein Fehler.

Weiter