Hoppa till innehållet
Verifierad

Lista projekt och distributioner

Varje arbetsyta ett konto äger, sedan varje app som faktiskt körs, som två läsningar av CouchDB-vyer.

"Projekt" och "distributioner" svarar på två olika frågor. Ett projekt är en arbetsyta på kontot, det du ser i projektväxlaren, oavsett om något i det någonsin har gått live. En distribution är en app som faktiskt körs någonstans, is_deployment: true på dess eget dokument. Att lista ett konto betyder oftast båda: först arbetsytorna, sedan det som var och en kör.

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.

Genomgång

Lista kontots projekt

Inga fält utöver din nyckel: båda metoderna nycklar CouchDB-vyn på det uid som din inloggningsuppgift redan motsvarar.

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. Lista vad som faktiskt är distribuerat

Samma form, en annan vy: user_deployments ger bara ut ett dokument när is_deployment är sant, så den här listan är en delmängd av varje app som kontot någonsin har skapat, de som har en åtkomst-URL som är live.

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

Båda metoderna skickar ett CouchDB-vyresultat rakt igenom, utan omslag: code är 871 (den fasta framgångskod som get_couch_view alltid returnerar, inte den vanliga 1), och data är det råa nano-vysvaret, total_rows, offset och en array rows med { id, key, value }. id är projektets (eller distributionens) _id, det värde du skickar som app_id till varje annat anrop i det här avsnittet.

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 från get_account_deployments har samma fält plus app_hosting_server, app_datacenter_id, app_hosting och is_deployment: true, eftersom user_deployments ger ut dem ovanpå den delade uppsättningen. app_status_code < 4 är den enda status som den här vyn eller user_projects någonsin visar: båda map-funktionerna filtrerar bort allt från 4 och uppåt, så ett raderat projekt slutar helt enkelt visas i stället för att dyka upp med en status att kontrollera.

En arbetsyteraden kan ha ett namn som åsidosätter

get_account_projects stämplar main_profile_name på kontots egen arbetsyterad när arbetsytan har en namngiven profil, så raden du visar som "ditt" projekt kan läsas annorlunda än dess lagrade app_name. Föredra main_profile_name när det finns.

Fel

Båda metoderna kan bara misslyckas på det sätt som varje anrop kan: en api_key som saknas eller inte är behörig (-401, se Fel). Ingen av dem förgrenar sig på app_id eller någon annan indata, eftersom ingen av dem tar någon; en tom array rows är ett verkligt, lyckat svar för ett konto som inte har något i den listan än, inte ett fel.

Nästa