Przejdź do treści
Zweryfikowano

Wylistuj projekty i wdrożenia

Każdy obszar roboczy należący do konta, potem każda faktycznie działająca aplikacja, jako dwa odczyty widoków CouchDB.

„Projekty" i „wdrożenia" odpowiadają na dwa różne pytania. Projekt to obszar roboczy na koncie, to, co widzisz w przełączniku projektów, niezależnie od tego, czy cokolwiek w nim kiedykolwiek ruszyło. Wdrożenie to jedna aplikacja, która faktycznie gdzieś działa, is_deployment: true na jej własnym dokumencie. Wylistowanie konta zwykle oznacza oba: najpierw obszary robocze, potem to, co każdy z nich ma uruchomione.

Metody

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.

Krok po kroku

Wylistuj projekty konta

Żadnych pól poza Twoim kluczem: obie metody kluczują widok CouchDB po uid, które Twoje poświadczenie już ustala.

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. Wylistuj, co jest faktycznie wdrożone

Ten sam kształt, inny widok: user_deployments emituje dokument tylko wtedy, gdy is_deployment jest prawdziwe, więc ta lista to podzbiór każdej aplikacji, którą konto kiedykolwiek utworzyło, tych z działającym adresem dostępu.

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

Odpowiedź

Obie metody przekazują wynik widoku CouchDB wprost, bez opakowania: code to 871 (stały kod sukcesu, który zawsze zwraca get_couch_view, a nie zwykłe 1), a data to surowa odpowiedź nano widoku: total_rows, offset i tablica rows z { id, key, value }. id to _id projektu (lub wdrożenia), wartość, którą przekazujesz jako app_id w każdym innym wywołaniu tej sekcji.

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

Wiersze get_account_deployments niosą te same pola plus app_hosting_server, app_datacenter_id, app_hosting i is_deployment: true, bo user_deployments emituje je na wierzchu wspólnego zestawu. app_status_code < 4 to jedyny status, jaki kiedykolwiek pokaże ten widok lub user_projects: obie funkcje map odfiltrowują wszystko od 4 w górę, więc usunięty projekt po prostu przestaje się pojawiać, zamiast wyświetlać się ze statusem do sprawdzenia.

Wiersz obszaru roboczego może nieść nadpisaną nazwę

get_account_projects wpisuje main_profile_name w wiersz własnego obszaru roboczego konta, gdy ten obszar ma nazwany profil, więc wiersz, który pokazujesz jako „Twój" projekt, może czytać się inaczej niż zapisane app_name. Gdy jest obecne, preferuj main_profile_name.

Błędy

Obie metody mogą zawieść tylko tak, jak każde wywołanie: brakujący lub nieautoryzowany api_key (-401, zobacz Błędy). Żadna nie rozgałęzia się po app_id ani innych danych wejściowych, bo żadna ich nie przyjmuje: pusta tablica rows to prawdziwa, udana odpowiedź dla konta, które nie ma jeszcze niczego na tej liście, a nie błąd.

Dalej