Consulta da lista de APIs não vinculadas a uma chave de assinatura
Função
Esta API é usada para consultar a lista de APIs que não foram vinculadas a uma chave de assinatura especificada. Somente as APIs publicadas serão exibidas.
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/sign-bindings/unbinded-apis[?page_size, page_no, sign_id, env_id, api_id, api_name, group_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: sign_id, env_id, api_id, api_name, group_id, page_size e page_no.
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
sign_id |
Sim |
String |
ID da chave de assinatura |
env_id |
Não |
String |
ID do ambiente |
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 |
Resposta
Parâmetro |
Tipo |
Descrição |
---|---|---|
total |
Integer |
Número total de APIs que correspondem às condições de consulta |
size |
Integer |
Comprimento da lista de API retornada |
apis |
Dicionário |
Lista de APIs |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da API |
name |
String |
Nome da API |
type |
Integer |
Tipo de API |
remark |
String |
Descrição da API |
group_id |
String |
ID do grupo de APIs ao qual a API pertence |
group_name |
String |
Nome do grupo de APIs ao qual a API pertence |
run_env_name |
String |
Nome do ambiente no qual a API foi publicada |
run_env_id |
String |
ID do ambiente no qual a API foi publicada |
publish_id |
String |
ID do registro de publicação da API |
signature_name |
String |
Nome da chave de assinatura vinculada à API |
auth_type |
String |
Modo de autenticação de segurança |
req_uri |
String |
Endereço de acesso |
Exemplo de resposta:
{ "total": 2, "size": 2, "apis": [{ "name": "bbb", "type": 1, "group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2", "id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b", "group_name": "asd", "run_env_name": "das", "run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215", "publish_id": "6dff16c4-813f-486a-bba4-fdad45a55a70", "auth_type": "NONE", "req_uri": "/test" }, { "name": "aaa", "type": 1, "group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2", "id": "d85c502a-f916-47e8-bba0-50537a2d1af2", "group_name": "asd", "run_env_name": "das", "run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215", "publish_id": "dec83400-a0c6-4ea6-abfd-5bf237292f4d", "auth_type": "NONE", "req_uri": "/test" }] }
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 |