Saltar para o conteúdo
Verificado

Listar projetos e implementações

Todos os espaços de trabalho que uma conta possui e depois todas as apps em execução, como duas leituras de vista CouchDB.

"Projetos" e "implementações" respondem a duas perguntas diferentes. Um projeto é um espaço de trabalho da conta, aquilo que veria no seletor de projetos, quer algo lá dentro tenha ou não ido alguma vez para o ar. Uma implementação é uma app que está realmente em execução algures, is_deployment: true no seu próprio documento. Listar uma conta costuma significar ambos: primeiro os espaços de trabalho e depois o que cada um tem em execução.

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.

Passo a passo

Liste os projetos da conta

Sem campos além da sua chave: ambos os métodos indexam a vista CouchDB pelo uid que a sua credencial já resolve.

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. Liste o que está realmente implementado

Mesma forma, uma vista diferente: user_deployments só emite um documento quando is_deployment é verdadeiro, por isso esta lista é um subconjunto de todas as apps que a conta alguma vez criou, as que têm um URL de acesso ativo.

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 resposta

Ambos os métodos passam um resultado de vista CouchDB diretamente, sem o embrulhar: code é 871 (o código de sucesso fixo que get_couch_view devolve sempre, não o habitual 1) e data é a resposta bruta da vista nano, total_rows, offset e um array rows de { id, key, value }. O id é o _id do projeto (ou da implementação), o valor que passa como app_id a todas as outras chamadas desta secção.

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

As linhas de get_account_deployments trazem os mesmos campos mais app_hosting_server, app_datacenter_id, app_hosting e is_deployment: true, já que user_deployments os emite além do conjunto partilhado. app_status_code < 4 é o único estado que esta vista ou user_projects alguma vez lhe mostrará: ambas as funções de mapeamento filtram tudo o que seja 4 ou superior, por isso um projeto eliminado simplesmente deixa de aparecer em vez de surgir com um estado para verificar.

A linha de um espaço de trabalho pode trazer uma substituição de nome

get_account_projects regista main_profile_name na linha do próprio espaço de trabalho da conta quando esse espaço de trabalho tem um perfil com nome, por isso a linha que mostra como o "seu" projeto pode ler-se de forma diferente do seu app_name guardado. Prefira main_profile_name quando existir.

Erros

Ambos os métodos só falham da forma como qualquer chamada pode falhar: uma api_key em falta ou sem autorização (-401, consulte Erros). Nenhum deles se ramifica por app_id ou outra entrada, já que nenhum recebe uma, um array rows vazio é uma resposta real e bem-sucedida para uma conta que ainda não tem nada nessa lista, não um erro.

A seguir