Consulta de AppCodes de uma aplicação
Função
Esta API é usada para consultar os AppCodes de uma aplicação.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
project_id | Sim | String | ID do projeto. Para obter detalhes sobre como obter um ID de projeto, consulte "Apêndice" > "Obtenção de um ID de projeto" neste documento. |
instance_id | Sim | String | ID do gateway, que pode ser obtido a partir das informações de gateway no console do APIG. |
app_id | Sim | String | ID de aplicação. |
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
offset | Não | Long | Deslocamento a partir do qual a consulta é iniciada. Se o valor estiver menor que 0, ele é automaticamente convertido para 0. Padrão: 0 |
limit | Não | Integer | Número de itens exibidos em cada página. Um valor menor ou igual a 0 será automaticamente convertido em 20, e um valor maior que 500 será automaticamente convertido em 500. Mínimo: 1 Máximo: 500 Padrão: 20 |
Parâmetros de solicitação
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
X-Auth-Token | Sim | String | Token do usuário. Ele pode ser obtido chamando a API do IAM usada para obter um token de usuário. O valor de X-Subject-Token no cabeçalho da resposta é um token. |
Parâmetros de resposta
Código de status: 200
Parâmetro | Tipo | Descrição |
|---|---|---|
size | Integer | Comprimento da lista de recursos retornados. |
total | Long | Número de recursos que atendem às condições de consulta. |
app_codes | Array of AppCodeBaseInfo objects | Lista de AppCode. |
Parâmetro | Tipo | Descrição |
|---|---|---|
app_code | String | Valor do AppCode. O valor pode conter de 64 a 180 caracteres, começando com uma letra, sinal de adição (+), ou barra (/). Somente letras e os seguintes caracteres especiais são permitidos: +_!@#$%/= |
id | String | ID. |
app_id | String | ID de aplicação. |
create_time | String | Tempo de criação. |
Código de status: 400
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 401
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 403
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 404
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Código de status: 500
Parâmetro | Tipo | Descrição |
|---|---|---|
error_code | String | Código de erro. |
error_msg | String | Mensagem de erro. |
Exemplo de solicitações
Nenhum
Exemplo de respostas
Código de status: 200
OK
{
"total" : 2,
"size" : 2,
"app_codes" : [ {
"app_code" : "GjOD3g80AABuuFeEJpVQADBlAjBh3UzC7W+gr4VJBB5BtJ4fdVOQoSvoji3gFxUDb5pWBz9wUcw9+8/bFZ1B/4pq29wCMQC0pQWX6zTndljDEl99As1pw+WntAU9xcq+ffagoH6zDpKUvdxV6Ezj8LcCcPZN6BU=",
"app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
"id" : "32dc8ca22d1b4b9cb94022186880576b",
"create_time" : "2020-07-24T02:37:24Z"
}, {
"app_code" : "fdc8d90a30174460a91ddacfa54d6f04c92e523a85cc4a1894f87cb13b6f572a",
"app_id" : "9ed8b7fe84224de681e7d7a5587e76dc",
"id" : "b3d34f746d0847fb95138670e10207ed",
"create_time" : "2020-07-24T02:31:45Z"
} ]
} Código de status: 400
Solicitação inválida
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:app_id. Please refer to the support documentation"
} Código de status: 401
Não autorizado
{
"error_code" : "APIG.1002",
"error_msg" : "Incorrect token or token resolution failed"
} Código de status: 403
Proibido
{
"error_code" : "APIG.1005",
"error_msg" : "No permissions to request this method"
} Código de status: 404
Não encontrado
{
"error_code" : "APIG.3004",
"error_msg" : "App 9ed8b7fe84224de681e7d7a5587e76dc does not exist"
} Código de status: 500
Erro do servidor interno
{
"error_code" : "APIG.9999",
"error_msg" : "System error"
} Códigos de status
Código de status | Descrição |
|---|---|
200 | OK |
400 | Solicitação inválida |
401 | Não autorizado |
403 | Proibido |
404 | Não encontrado |
500 | Erro do servidor interno |
Códigos de erro
Consulte Códigos de erro.

