Estruturas de Dados Genéricas - Qoder CN Series: Central de Documentação do Alibaba Cloud

Envelopes de resposta compartilhados e objetos base utilizados em diversos resources da API do Cloud Agents.

Objeto Metadata

O objeto metadata consiste em um conjunto simples de pares chave-valor do tipo string, definido pelo chamador.

Regra	Descrição
Formato	Objeto JSON; todos os valores devem ser strings
Quantidade máxima de chaves	16
Comprimento máximo da chave	64 caracteres Unicode
Comprimento máximo do valor	512 caracteres Unicode
Padrão	`{}` quando omitido

Exemplo:

{
  "team": "docs",
  "project": "cloud-agents"
}

Lista paginada

Os endpoints de lista retornam um envelope unificado de paginação baseada em cursor.

Campo	Tipo	Descrição
`data`	array	Array de objetos de resource na página atual
`has_more`	boolean	Indica se há mais dados disponíveis
`first_id`	string	null	ID de cursor do primeiro registro na página atual; assume valor `null` quando `data` está vazio
`last_id`	string	null	ID de cursor do último registro na página atual; assume valor `null` quando `data` está vazio

Envelope de erro

As respostas de erro seguem a estrutura abaixo:

{
  "type": "error",
  "request_id": "cb80235f-76a2-4ff3-9e28-5aa2da12dc14",
  "error": {
    "type": "invalid_request_error",
    "message": "Field 'name' is required."
  }
}

Campo	Tipo	Descrição
`type`	string	Sempre `"error"`
`error.type`	string	Categoria do erro, como `invalid_request_error`, `authentication_error`, `permission_error`, `not_found_error`, `conflict_error` ou `api_error`
`error.message`	string	Mensagem de erro legível por humanos

Timestamps

Os campos de tempo são strings no formato UTC ISO 8601 / RFC 3339, por exemplo "2026-05-18T15:26:39.61669Z". Alguns campos podem apresentar valor null; consulte o schema específico do resource para obter detalhes.

Prefixos de ID

Resource	Prefixo
Agent	`agent_`
Environment	`env_`
Session	`sess_`
Evento de sessão	`evt_`
Thread de sessão	`sthr_`
Turn	`turn_`
Arquivo	`file_`
Vault	`vault_`
Credencial do Vault	`vcred_`
Skill	`skill_`
Armazenamento de memória	`memstore_`
Entrada de memória	`mem_`
Versão de memória	`memver_`
Modelo de encaminhamento	`tmpl_`
Identidade de encaminhamento	`idn_`
Configuração de identidade de encaminhamento	`cfg_`
Canal de encaminhamento	`channel_`
Sessão QR de encaminhamento	`qr_`
Agenda de encaminhamento	`sched_`
Execução de agenda de encaminhamento	`srun_`
Item de trabalho	`work_`
Resource de encaminhamento	Reutiliza o prefixo de ID do próprio resource registrado