Gå til indhold
Bekræftet

List projekter og udrulninger

Hvert workspace, en konto ejer, derefter hver app, der faktisk kører, som to læsninger af CouchDB-views.

"Projekter" og "udrulninger" besvarer to forskellige spørgsmål. Et projekt er et workspace på kontoen, det, du ville se i projektskifteren, uanset om noget i det nogensinde er gået live. En udrulning er én app, der faktisk kører et sted, is_deployment: true på sit eget dokument. At liste en konto betyder som regel begge dele: først workspaces og derefter det, hvert af dem har kørende.

Metoder

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.

Gennemgang

List kontoens projekter

Ingen felter ud over din nøgle: begge metoder slår CouchDB-viewet op med det uid, din legitimation allerede peger på.

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 det, der faktisk er udrullet

Samme form, et andet view: user_deployments udsender kun et dokument, når is_deployment er sand, så denne liste er en delmængde af alle apps, kontoen nogensinde har oprettet, dem med en live adgangs-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'])

Svaret

Begge metoder sender et CouchDB-view-resultat direkte videre, uden indpakning: code er 871 (den faste succeskode, get_couch_view altid returnerer, ikke den sædvanlige 1), og data er det rå nano-view-svar, total_rows, offset og et rows-array af { id, key, value }. id er projektets (eller udrulningens) _id, den værdi, du sender som app_id til hvert andet kald i dette afsnit.

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

Rækker fra get_account_deployments har de samme felter plus app_hosting_server, app_datacenter_id, app_hosting og is_deployment: true, da user_deployments udsender dem oven på det fælles sæt. app_status_code < 4 er den eneste status, dette view eller user_projects nogensinde viser dig: begge map-funktioner filtrerer alt fra ved 4 eller derover, så et slettet projekt holder simpelthen op med at dukke op, i stedet for at vises med en status, du kan tjekke.

Et workspaces række kan have et navn, der tilsidesætter

get_account_projects stempler main_profile_name på kontoens eget workspace-række, når det workspace har en navngivet profil, så den række, du viser som "dit" projekt, kan lyde anderledes end dens gemte app_name. Foretræk main_profile_name, når det findes.

Fejl

Begge metoder kan kun fejle på den måde, ethvert kald kan: en manglende eller uautoriseret api_key (-401, se Fejl). Ingen af dem forgrener på app_id eller noget andet input, da ingen af dem tager et, et tomt rows-array er et reelt, vellykket svar for en konto, der endnu ikke har noget på den liste, ikke en fejl.

Næste