Aller au contenu
Vérifié

Lister les projets et les déploiements

Chaque espace de travail qu'un compte possède, puis chaque application réellement en cours d'exécution, en deux lectures de vue CouchDB.

Les « projets » et les « déploiements » répondent à deux questions différentes. Un projet est un espace de travail du compte, ce que vous verriez dans le sélecteur de projet, que quoi que ce soit à l'intérieur ait été mis en ligne ou non. Un déploiement est une application qui s'exécute réellement quelque part, avec is_deployment: true sur son propre document. Lister un compte signifie en général les deux : d'abord les espaces de travail, puis ce que chacun fait tourner.

Méthodes

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.

Pas à pas

Lister les projets du compte

Aucun champ en dehors de votre clé : les deux méthodes interrogent la vue CouchDB avec l'uid que votre identifiant résout déjà.

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. Lister ce qui est réellement déployé

Même forme, une autre vue : user_deployments n'émet un document que si is_deployment est vrai. Cette liste est donc un sous-ensemble de toutes les applications que le compte a jamais créées : celles qui ont une URL d'accès en ligne.

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 réponse

Les deux méthodes renvoient un résultat de vue CouchDB tel quel, sans enveloppe : code vaut 871 (le code de succès fixe que get_couch_view renvoie toujours, et non le 1 habituel), et data est la réponse brute de la vue nano, total_rows, offset et un tableau rows de { id, key, value }. id est le _id du projet (ou du déploiement), la valeur que vous passez comme app_id à tous les autres appels de cette section.

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

Les lignes de get_account_deployments portent les mêmes champs, plus app_hosting_server, app_datacenter_id, app_hosting et is_deployment: true, car user_deployments les émet en plus de l'ensemble commun. app_status_code < 4 est le seul statut que cette vue ou user_projects vous montrera jamais : les deux fonctions map filtrent tout ce qui vaut 4 ou plus, si bien qu'un projet supprimé cesse simplement d'apparaître au lieu de s'afficher avec un statut à vérifier.

La ligne d'un espace de travail peut porter un nom de remplacement

get_account_projects inscrit main_profile_name sur la ligne de l'espace de travail propre au compte quand cet espace de travail a un profil nommé : la ligne que vous présentez comme « votre » projet peut donc se lire différemment de son app_name enregistré. Préférez main_profile_name quand il est présent.

Erreurs

Les deux méthodes n'échouent que de la manière dont tout appel peut échouer : une api_key manquante ou non autorisée (-401, consultez Erreurs). Aucune des deux ne se ramifie sur app_id ou sur une autre entrée, puisqu'aucune n'en prend : un tableau rows vide est une vraie réponse réussie pour un compte qui n'a encore rien dans cette liste, pas une erreur.

Suite