Hopp til innholdet
Bekreftet

List prosjekter og distribusjoner

Hvert arbeidsområde en konto eier, og deretter hver app som faktisk kjører, som to lesinger av CouchDB-visninger.

«Prosjekter» og «distribusjoner» svarer på to ulike spørsmål. Et prosjekt er et arbeidsområde på kontoen, det du ser i prosjektvelgeren, uansett om noe inni det noen gang har gått live. En distribusjon er én app som faktisk kjører et sted, is_deployment: true på dokumentet sitt. Å liste en konto betyr vanligvis begge deler: arbeidsområdene først, og deretter hva hvert av dem har kjø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.

Gjennomgang

List kontoens prosjekter

Ingen felt utover nøkkelen din: begge metodene slår opp CouchDB-visningen med uid-en legitimasjonen din allerede peker 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 som faktisk er distribuert

Samme form, en annen visning: user_deployments sender bare ut et dokument når is_deployment er sant, så denne listen er en delmengde av alle apper kontoen noen gang har opprettet, de med en live tilgangs-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 metodene sender et CouchDB-visningsresultat rett videre, uten innpakning: code er 871 (den faste suksesskoden get_couch_view alltid returnerer, ikke den vanlige 1), og data er det rå nano-visningssvaret, total_rows, offset og en rows-liste med { id, key, value }. id er prosjektets (eller distribusjonens) _id, verdien du sender som app_id til alle andre kall i denne delen.

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

Rader fra get_account_deployments har de samme feltene pluss app_hosting_server, app_datacenter_id, app_hosting og is_deployment: true, siden user_deployments sender ut disse oppå det delte settet. app_status_code < 4 er den eneste statusen denne visningen eller user_projects noen gang viser deg: begge map-funksjonene filtrerer bort alt på 4 eller over, så et slettet prosjekt slutter ganske enkelt å dukke opp i stedet for å vises med en status du kan sjekke.

Et arbeidsområdes rad kan ha et navn som overstyrer

get_account_projects setter main_profile_name på kontoens eget arbeidsområde-rad når det arbeidsområdet har en navngitt profil, så raden du viser som «ditt» prosjekt kan lese annerledes enn det lagrede app_name. Foretrekk main_profile_name når det finnes.

Feil

Begge metodene feiler bare på den måten hvert kall kan feile: en manglende eller uautorisert api_key (-401, se Feil). Ingen av dem forgrener seg på app_id eller andre input, siden ingen av dem tar noen. En tom rows-liste er et ekte, vellykket svar for en konto som ikke har noe i den listen ennå, ikke en feil.

Neste