Consulta da lista de políticas de controle de acesso vinculadas a uma API
Função
Esta API é usada para consultar a lista de políticas de controle de acesso que foram vinculadas a uma API 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/binded-acls[?page_no,page_size,api_id,env_id,env_name,acl_id,acl_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: api_id, env_id, env_name, acl_id, acl_name, page_size e page_no.
A tabela a seguir lista os parâmetros no URI.
|
Parâmetro |
Obrigatório |
Tipo |
Descrição |
|---|---|---|---|
|
api_id |
Sim |
String |
ID da API |
|
env_id |
Não |
String |
ID do ambiente |
|
env_name |
Não |
String |
Nome do ambiente |
|
acl_id |
Não |
String |
ID da política de controle de acesso |
|
acl_name |
Não |
String |
Nome da política de controle de acesso |
|
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 políticas de controle de acesso vinculadas à API |
|
size |
Integer |
Número de políticas de controle de acesso retornadas |
|
acls |
Dicionário |
Lista de políticas de controle de acesso |
|
Parâmetro |
Tipo |
Descrição |
|---|---|---|
|
acl_id |
String |
ID da política de controle de acesso |
|
acl_name |
String |
Nome da política de controle de acesso |
|
acl_type |
String |
Tipo de controle de acesso, que pode ser:
|
|
acl_value |
String |
Objetos de controle de acesso |
|
entity_type |
String |
Tipo de objeto, que pode ser:
|
|
env_id |
String |
ID do ambiente no qual a política de controle de acesso entra em vigor |
|
env_name |
String |
Nome do ambiente no qual a política de controle de acesso entra em vigor |
|
bind_id |
String |
ID de vinculação |
|
bind_time |
Timestamp |
Hora em que a política de controle de acesso está vinculada à API |
Exemplo de resposta:
{
"total": 1,
"size": 1,
"acls": [
{
"acl_id": "206bb985d8a04ec09f13c3e51ef77095",
"acl_name": "acl_001",
"entity_type": "IP",
"acl_type": "PERMIT",
"acl_value": "192.168.1.14,192.168.2.0/24,192.168.1.8-192.168.1.110",
"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name": "RELEASE",
"bind_id": "4ffc0da71ddd4c22add8ff801e19846c",
"bind_time": "2018-07-27T11:27:10Z"
}
]
}
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 |