Saltar al contenido
Verificada

Listar proyectos y despliegues

Todos los workspaces que posee una cuenta y luego todas las apps realmente en marcha, como dos lecturas de vistas de CouchDB.

"Proyectos" y "despliegues" responden a dos preguntas distintas. Un proyecto es un workspace de la cuenta, lo que verías en el selector de proyectos, haya salido o no algo de su interior a producción. Un despliegue es una app que realmente está en marcha en algún sitio, is_deployment: true en su propio documento. Listar una cuenta suele significar las dos cosas: primero los workspaces y luego lo que tiene en marcha cada uno.

Métodos

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.

Paso a paso

Lista los proyectos de la cuenta

Sin más campos que tu clave: ambos métodos consultan la vista de CouchDB con el uid al que ya se resuelve tu credencial.

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 lo que está realmente desplegado

La misma estructura, otra vista: user_deployments solo emite un documento cuando is_deployment es verdadero, así que esta lista es un subconjunto de todas las apps que la cuenta ha creado alguna vez, las que tienen una URL de acceso activa.

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 respuesta

Ambos métodos pasan el resultado de una vista de CouchDB tal cual, sin envolver: code es 871 (el código de éxito fijo que get_couch_view devuelve siempre, no el habitual 1) y data es la respuesta nano en bruto de la vista, total_rows, offset y un array rows de { id, key, value }. id es el _id del proyecto (o del despliegue), el valor que pasas como app_id a todas las demás llamadas de esta sección.

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

Las filas de get_account_deployments llevan los mismos campos más app_hosting_server, app_datacenter_id, app_hosting e is_deployment: true, porque user_deployments los emite además del conjunto compartido. app_status_code < 4 es el único estado que te mostrará esta vista o user_projects: ambas funciones map filtran todo lo que esté en 4 o más, así que un proyecto eliminado simplemente deja de aparecer en lugar de salir con un estado que comprobar.

La fila de un workspace puede llevar un nombre que lo sustituye

get_account_projects estampa main_profile_name en la fila del workspace propio de la cuenta cuando ese workspace tiene un perfil con nombre, así que la fila que muestres como "tu" proyecto puede leerse distinto de su app_name guardado. Da preferencia a main_profile_name cuando exista.

Errores

Ambos métodos solo fallan como puede fallar cualquier llamada: una api_key ausente o sin autorización (-401, consulta Errores). Ninguno ramifica según app_id ni otra entrada, porque ninguno recibe una; un array rows vacío es una respuesta real y correcta para una cuenta que aún no tiene nada en esa lista, no un error.

Siguiente