Přeskočit na obsah
Ověřeno

Vypsat projekty a nasazení

Každý pracovní prostor, který účet vlastní, a pak každá skutečně běžící aplikace, jako dvě čtení pohledu CouchDB.

„Projekty“ a „nasazení“ odpovídají na dvě různé otázky. Projekt je pracovní prostor v účtu, to, co vidíte v přepínači projektů, ať už uvnitř něj něco někdy začalo běžet, nebo ne. Nasazení je jedna aplikace, která skutečně někde běží, is_deployment: true v jejím vlastním dokumentu. Výpis účtu obvykle znamená obojí: nejdřív pracovní prostory, pak to, co v každém běží.

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.

Postup

Vypsat projekty účtu

Žádná pole kromě klíče: obě metody klíčují pohled CouchDB podle uid, na které se vaše pověření už převádí.

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. Vypsat, co je skutečně nasazeno

Stejný tvar, jiný pohled: user_deployments vydá dokument jen tehdy, když je is_deployment pravdivé, takže tento seznam je podmnožinou všech aplikací, které účet kdy vytvořil, těch s živou přístupovou 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'])

Odpověď

Obě metody předávají výsledek pohledu CouchDB beze změny, nezabalený: code je 871 (pevný kód úspěchu, který get_couch_view vždy vrací, ne obvyklé 1) a data je syrová odpověď nano pohledu, total_rows, offset a pole rows s položkami { id, key, value }. id je _id projektu (nebo nasazení), hodnota, kterou předáváte jako app_id každému dalšímu volání v této sekci.

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

Řádky get_account_deployments nesou stejná pole a navíc app_hosting_server, app_datacenter_id, app_hosting a is_deployment: true, protože user_deployments je vydává nad sdílenou sadou. app_status_code < 4 je jediný stav, který vám tento pohled nebo user_projects kdy ukáže: obě mapovací funkce odfiltrují vše od 4 výše, takže smazaný projekt se prostě přestane objevovat, místo aby se ukázal se stavem ke kontrole.

Řádek pracovního prostoru může nést přepsaný název

get_account_projects přidá main_profile_name do řádku vlastního pracovního prostoru účtu, když má tento pracovní prostor pojmenovaný profil, takže řádek, který zobrazujete jako „váš“ projekt, se může číst jinak než jeho uložené app_name. Je-li přítomno main_profile_name, upřednostněte ho.

Chyby

Obě metody mohou selhat jen tak, jak může selhat každé volání: chybějící nebo neoprávněný api_key (-401, viz Chyby). Žádná nevětví podle app_id ani jiného vstupu, protože žádná žádný nebere, prázdné pole rows je skutečná, úspěšná odpověď pro účet, který v daném seznamu zatím nic nemá, ne chyba.

Dále