Consulta da lista de APIs vinculadas a uma aplicação
Função
Esta API é usada para consultar a lista de APIs vinculadas a uma aplicação especificada.
Somente as APIs que uma aplicação foi autorizada a acessar em um ambiente podem ser consultadas.
URI
A tabela a seguir lista o método de solicitação HTTP/HTTPS e o URI da API.
Método de solicitação |
URI |
---|---|
GET |
/v1.0/apigw/app-auths/binded-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,env_id] |
- Uma combinação de diferentes condições de consulta pode ser adicionada no final do URI usando pontos de interrogação (?) e E comercial (&).
- As condições de consulta incluem: app_id, api_id, api_name, group_id, group_name, env_id, page_size e page_no.
A tabela a seguir lista os parâmetros no URI.
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
app_id |
Sim |
String |
ID de aplicação |
api_id |
Não |
String |
ID da API |
api_name |
Não |
String |
Nome da API |
group_id |
Não |
String |
ID do grupo da API |
group_name |
Não |
String |
Nome do grupo da API |
env_id |
Não |
String |
ID do ambiente em que a aplicação foi autorizada |
page_size |
Não |
Integer |
Número de registros exibidos em cada página. O valor padrão é 20. |
page_no |
Não |
Integer |
Número da página. O valor padrão é 1. |
Solicitação
N/D
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
total |
Integer |
Número de APIs que correspondem às condições de consulta |
size |
Integer |
Comprimento da lista de API retornada |
auths |
Dicionário |
Lista de APIs |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID de autorização |
api_id |
String |
ID da API |
api_name |
String |
Nome da API |
group_name |
String |
Grupo de APIs ao qual a API pertence |
api_remark |
String |
Descrição da API |
api_type |
Integer |
Tipo de API |
envname |
String |
Nome do ambiente no qual a aplicação foi autorizada a chamar a API |
env_id |
String |
ID do ambiente |
auth_role |
String |
Autorizador |
auth_time |
String |
Tempo de autorização |
appid |
String |
ID de aplicação |
app_name |
String |
Nome de aplicação |
app_creator |
String |
Criador de aplicações, que pode ser:
|
app_remark |
String |
Descrição de aplicação |
app_type |
String |
Tipo de aplicação |
publish_id |
String |
ID de publicação da API |
Exemplo de resposta:
{ "total": 1, "size": 1, "auths": [{ "id": "cfa688d8-094b-445a-b270-6aeb0b70a84a", "api_id": "6632a062-9dcf-4f18-9646-3cabb925a290", "api_name": "API_list_query", "group_name": "api_group_001", "api_type": 1, "api_remark": "API list query", "envname": "RELEASE", "auth_role": "PROVIDER", "auth_time": "2017-12-28T12:46:43Z", "appid": "14b399ac-967f-4115-bb62-c0346b4537e9", "app_name": "app_001", "app_creator": "USER", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "app_remark": "App description", "app_type": "apig", "publish_id": "f500ba7e369b4b1ebae99aa9d114a17a" }] }
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 |