Siirry sisältöön
Tarkistettu

Listaa projektit ja julkaisut

Jokainen tilin omistama työtila, sitten jokainen oikeasti käynnissä oleva sovellus, kahtena CouchDB-näkymälukuna.

"Projektit" ja "julkaisut" vastaavat kahteen eri kysymykseen. Projekti on tilin työtila, se, minkä näkisit projektinvaihtimessa, riippumatta siitä, onko mikään sen sisällä koskaan mennyt live-tilaan. Julkaisu on yksi sovellus, joka oikeasti on käynnissä jossain, is_deployment: true omassa dokumentissaan. Tilin listaaminen tarkoittaa yleensä molempia: ensin työtilat, sitten se, mitä kussakin on käynnissä.

Metodit

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.

Läpikäynti

Listaa tilin projektit

Ei muita kenttiä kuin avaimesi: molemmat metodit avaimistavat CouchDB-näkymän uid:llä, johon valtuutesi jo ratkeaa.

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. Listaa se, mikä on oikeasti julkaistu

Sama muoto, eri näkymä: user_deployments emittoi dokumentin vain, kun is_deployment on tosi, joten tämä lista on osajoukko kaikista sovelluksista, jotka tili on koskaan luonut: ne, joilla on live-käyttöosoite.

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

Vastaus

Molemmat metodit välittävät CouchDB-näkymän tuloksen sellaisenaan, purkamatta: code on 871 (kiinteä onnistumiskoodi, jonka get_couch_view aina palauttaa, ei tavallinen 1), ja data on raaka nano-näkymän vastaus: total_rows, offset ja rows-taulukko, jonka alkiot ovat { id, key, value }. id on projektin (tai julkaisun) _id, arvo, jonka annat app_id:ksi jokaisessa muussa tämän osion kutsussa.

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

get_account_deployments-rivit kantavat samat kentät sekä app_hosting_server, app_datacenter_id, app_hosting ja is_deployment: true, koska user_deployments emittoi ne jaetun joukon päälle. app_status_code < 4 on ainoa tila, jonka tämä näkymä tai user_projects koskaan näyttää: molemmat map-funktiot suodattavat pois kaiken tasolta 4 ylöspäin, joten poistettu projekti yksinkertaisesti lakkaa näkymästä sen sijaan, että se näkyisi tilalla, jota tarkistaa.

Työtilan rivillä voi olla nimen ohitus

get_account_projects leimaa main_profile_name:n tilin oman työtilan riville, kun kyseisellä työtilalla on nimetty profiili, joten rivi, jonka näytät "omana" projektinasi, voi näkyä eri nimellä kuin tallennettu app_name. Suosi main_profile_name:a, kun se on olemassa.

Virheet

Molemmat metodit epäonnistuvat vain tavalla, jolla jokainen kutsu voi: puuttuva tai valtuuttamaton api_key (-401, katso Virheet). Kumpikaan ei haarau app_id:n tai muun syötteen mukaan, koska kumpikaan ei ota sellaista: tyhjä rows-taulukko on todellinen, onnistunut vastaus tilille, jolla ei vielä ole mitään kyseisessä listassa, ei virhe.

Seuraavaksi