Consulta da lista de APIs não vinculadas a uma política de limitação de solicitações
Função
Esta API é usada para consultar a lista de APIs autodesenvolvidas que não estão vinculadas a uma política de limitação de solicitações. 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/throttle-bindings/unbinded-apis[?page_size, page_no, throttle_id, group_id, env_id, api_id, api_name] |
- 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: group_id, env_id, throttle_id, api_id, api_name, page_size e page_no.
Solicitação
Parâmetro |
Obrigatório |
Tipo |
Descrição |
---|---|---|---|
throttle_id |
Sim |
String |
ID de uma política de limitação de solicitações |
env_id |
Não |
String |
ID do ambiente |
group_id |
Não |
String |
ID do grupo da API |
api_id |
Não |
String |
ID da API |
api_name |
Não |
String |
Nome da API |
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. |
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 |
apis |
Dicionário |
Lista de APIs |
Parâmetro |
Tipo |
Descrição |
---|---|---|
id |
String |
ID da API |
name |
String |
Nome 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 |
type |
Integer |
Tipo de API |
remark |
String |
Descrição da API |
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 |
throttle_apply_id |
String |
ID de vinculação |
throttle_name |
String |
Nome da política de limitação de solicitações vinculada à API |
apply_time |
Timestamp |
Hora em que a política de limitação de solicitações está 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": [{ "id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9", "name": "API_group_list_query", "type": 1, "remark": "API group list query", "group_id": "73c58022-f20d-495a-a188-85d718647f09", "group_name": "api_group_001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057", "auth_type": "APP", "req_uri": "/test" }, { "id": "6632a062-9dcf-4f18-9646-3cabb925a290", "name": "API_list_query", "type": 1, "remark": "API list query", "group_id": "73c58022-f20d-495a-a188-85d718647f09", "group_name": "api_group_001", "run_env_name": "RELEASE", "run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "publish_id": "374a6d5a-20c7-4ea1-82e1-19fce4556956", "auth_type": "APP", "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 |