Consulta da lista de APIs não vinculadas a uma política de controle de acesso
Função
Esta API é usada para consultar a lista de APIs publicadas que não foram vinculadas a uma política de controle de acesso especificada.
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/acl-bindings/unbinded-apis[?page_no,page_size,acl_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: acl_id, env_id, api_id, group_id, api_name, page_size e page_no.
A tabela a seguir lista os parâmetros no URI.
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
acl_id |
Sim |
String |
ID da política de controle de acesso |
|
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. |
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 |
Número de APIs retornadas |
|
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 |
Status de abertura da 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 da API |
|
acl_name |
String |
Nome do mesmo tipo de política de controle de acesso vinculado à API |
|
req_uri |
String |
Endereço de acesso |
|
auth_type |
String |
Modo de autenticação de segurança |
Exemplo de resposta:
{
"total": 1,
"size": 1,
"apis": [
{
"name": "bbbbb",
"type": 1,
"remark": "aaa",
"group_id": "70f1b578da9b4dfe889b4c33d1b995c2",
"id": "91c26288acea4448be205265d77dae22",
"group_name": "test001",
"run_env_name": "RELEASE",
"run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"publish_id": "a6e06a00c382436eb524fa2dd343cb6d",
"req_uri": "/test",
"auth_type": "NONE"
}
]
}
Códigos de status
|
Código de status |
Descrição |
|---|---|
|
200 |
OK |
|
400 |
Solicitação inválida |
|
403 |
Proibido |
|
404 |
Não encontrado |
|
500 |
Erro do servidor interno |