Vai al contenuto
Verificata

Elencare progetti e deployment

Ogni workspace che un account possiede, poi ogni app effettivamente in esecuzione, come due letture di viste CouchDB.

"Progetti" e "deployment" rispondono a due domande diverse. Un progetto è un workspace dell'account, quello che vedresti nel selettore dei progetti, che qualcosa al suo interno sia mai andato online o no. Un deployment è un'app che è davvero in esecuzione da qualche parte, is_deployment: true sul proprio documento. Elencare un account di solito significa entrambi: prima i workspace, poi ciò che ciascuno ha in esecuzione.

Metodi

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.

Procedura

Elenca i progetti dell'account

Nessun campo oltre alla tua chiave: entrambi i metodi interrogano la vista CouchDB con l'uid a cui la tua credenziale già corrisponde.

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. Elenca ciò che è davvero distribuito

Stessa forma, una vista diversa: user_deployments emette un documento solo se is_deployment è vero, quindi questo elenco è un sottoinsieme di tutte le app che l'account ha mai creato, quelle con un URL di accesso attivo.

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

La risposta

Entrambi i metodi passano il risultato di una vista CouchDB così com'è, senza incapsularlo: code è 871 (il codice di successo fisso che get_couch_view restituisce sempre, non il solito 1) e data è la risposta grezza di nano, total_rows, offset e un array rows di { id, key, value }. id è l'_id del progetto (o del deployment), il valore che passi come app_id a ogni altra chiamata di questa sezione.

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

Le righe di get_account_deployments portano gli stessi campi più app_hosting_server, app_datacenter_id, app_hosting e is_deployment: true, perché user_deployments li emette in aggiunta all'insieme condiviso. app_status_code < 4 è l'unico stato che questa vista o user_projects ti mostrerà mai: entrambe le funzioni map scartano tutto ciò che è pari o superiore a 4, quindi un progetto eliminato semplicemente smette di comparire invece di presentarsi con uno stato da controllare.

La riga di un workspace può portare un nome sostitutivo

get_account_projects imposta main_profile_name sulla riga del workspace dell'account quando quel workspace ha un profilo con nome, quindi la riga che mostri come "il tuo" progetto può leggersi in modo diverso dal suo app_name memorizzato. Preferisci main_profile_name quando c'è.

Errori

Entrambi i metodi possono fallire solo come ogni chiamata: una api_key mancante o non autorizzata (-401, vedi Errori). Nessuno dei due si ramifica su app_id o su altri input, dato che non ne accettano; un array rows vuoto è una risposta reale e riuscita per un account che non ha ancora nulla in quell'elenco, non un errore.

Passi successivi