Preskočiť na obsah
Overené

Zoznam projektov a nasadení

Každý workspace, ktorý účet vlastní, a potom každá skutočne bežiaca aplikácia, ako dve čítania pohľadov CouchDB.

„Projekty“ a „nasadenia“ odpovedajú na dve rôzne otázky. Projekt je workspace v účte, to, čo by ste videli v prepínači projektov, bez ohľadu na to, či sa niečo v ňom niekedy sprevádzkovalo. Nasadenie je jedna aplikácia, ktorá skutočne niekde beží, is_deployment: true na jej vlastnom dokumente. Zoznam účtu zvyčajne znamená oboje: najprv workspace a potom to, čo má každý z nich spustené.

Methods

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.

Walkthrough

List the account's projects

Žiadne polia okrem vášho kľúča: obe metódy priraďujú pohľad CouchDB k uid, na ktoré sa vaše poverenie už rozlišuje.

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. List what is actually deployed

Rovnaký tvar, iný pohľad: user_deployments vydá dokument len vtedy, keď je is_deployment pravdivé, takže tento zoznam je podmnožinou každej aplikácie, ktorú účet kedy vytvoril, tých so živou prí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'])

The response

Obe metódy odovzdávajú výsledok pohľadu CouchDB priamo, nezabalený: code je 871 (pevný kód úspechu, ktorý get_couch_view vždy vracia, nie obvyklé 1) a data je surová odpoveď pohľadu nano, total_rows, offset a pole rows s prvkami { id, key, value }. id je _id projektu (alebo nasadenia), hodnota, ktorú posielate ako app_id pri každom ďalšom volaní v tejto sekcii.

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

Riadky get_account_deployments nesú tie isté polia plus app_hosting_server, app_datacenter_id, app_hosting a is_deployment: true, pretože user_deployments ich vydáva navyše k spoločnej sade. app_status_code < 4 je jediný stav, ktorý vám tento pohľad alebo user_projects kedy ukáže: obe mapovacie funkcie odfiltrujú všetko od 4 vyššie, takže vymazaný projekt jednoducho prestane byť viditeľný a neobjaví sa so stavom na kontrolu.

Riadok workspace môže niesť prepísaný názov

get_account_projects pridá main_profile_name k riadku vlastného workspace účtu, keď má tento workspace pomenovaný profil, takže riadok, ktorý zobrazíte ako „váš“ projekt, sa môže čítať inak ako jeho uložený app_name. Ak je prítomné main_profile_name, uprednostnite ho.

Errors

Obe metódy môžu zlyhať len tak, ako každé volanie: chýbajúci alebo neoprávnený api_key (-401, pozri Errors). Ani jedna sa nevetví podľa app_id ani iného vstupu, keďže žiadny neberie, prázdne pole rows je skutočná úspešná odpoveď pre účet, ktorý v tomto zozname zatiaľ nič nemá, nie chyba.

Next