Ugrás a tartalomhoz
Ellenőrizve

Projektek és telepítések listázása

Minden munkaterület, amelyet a fiók birtokol, majd minden ténylegesen futó alkalmazás, két CouchDB-nézet olvasásaként.

A „projektek" és a „telepítések" két különböző kérdésre felelnek. A projekt egy munkaterület a fiókban, az, amit a projektváltóban lát, akár ment élőbe valaha bármi benne, akár nem. A telepítés egy olyan alkalmazás, amely ténylegesen fut valahol, a saját dokumentumán is_deployment: true jelzéssel. Egy fiók listázása általában mindkettőt jelenti: előbb a munkaterületeket, majd azt, hogy mindegyikben mi fut.

Metódusok

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.

Végigvezető

A fiók projektjeinek listázása

A kulcson kívül nincs más mező: mindkét metódus a CouchDB-nézetet arra az uid-re kulcsolja, amelyre a hitelesítő adata már feloldódik.

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. A ténylegesen telepített elemek listázása

Ugyanaz az alak, más nézet: a user_deployments csak akkor bocsát ki dokumentumot, ha az is_deployment igaz, így ez a lista a fiók által valaha létrehozott összes alkalmazás részhalmaza, azoké, amelyeknek van élő hozzáférési URL-jük.

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'])

A válasz

Mindkét metódus egy CouchDB-nézeteredményt ad át közvetlenül, becsomagolás nélkül: a code értéke 871 (a rögzített sikerkód, amelyet a get_couch_view mindig visszaad, nem a szokásos 1), a data pedig a nyers nano nézetválasz, total_rows, offset és egy rows tömb { id, key, value } elemekkel. Az id a projekt (vagy telepítés) _id értéke, az az érték, amelyet app_id néven ad át a szakasz minden más hívásának.

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

A get_account_deployments sorai ugyanezeket a mezőket hordozzák, plusz az app_hosting_server, app_datacenter_id, app_hosting és is_deployment: true mezőket, mivel a user_deployments ezeket a közös készleten felül bocsátja ki. Az app_status_code < 4 az egyetlen állapot, amelyet ez a nézet vagy a user_projects valaha mutat: mindkét map függvény kiszűr mindent 4 vagy afölött, így a törölt projekt egyszerűen megszűnik megjelenni, nem pedig ellenőrizendő állapottal jelenik meg.

A munkaterület sora hordozhat névfelülírást

A get_account_projects a main_profile_name értéket ráírja a fiók saját munkaterületének sorára, ha ennek a munkaterületnek van elnevezett profilja, így az a sor, amelyet „az Ön" projektjeként mutat, másként olvasható, mint a tárolt app_name. Ha jelen van, részesítse előnyben a main_profile_name értéket.

Hibák

Mindkét metódus csak úgy hibázhat, ahogyan bármely hívás: hiányzó vagy jogosulatlan api_key (-401, lásd az Errors oldalt). Egyik sem ágazik el az app_id vagy más bemenet alapján, mivel egyik sem vesz át ilyet; az üres rows tömb valódi, sikeres válasz egy olyan fiókra, amelynek még nincs semmi abban a listában, nem hiba.

Következő