Consulta da lista de configurações de limitação de solicitações excluídas
Função
Esta API é usada para consultar todas as configurações excluídas de uma política de limitação de solicitações.
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-specials/{strategy_id}[?page_size, page_no, instance_type, app_name, user] |
- 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: strategy_id, app_name, user, page_size e page_no.
A tabela a seguir lista os parâmetros no URI.
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| strategy_id | Sim | String | ID da política de limitação de solicitações |
| 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. |
| instance_type | Não | String | Tipo de objeto, que pode ser APP ou USER |
| app_name | Não | String | Nome de uma aplicação excluída |
| user | Não | String | ID da conta |
Solicitação
N/D
Resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| throttle_specials | Dicionário | Lista de configuração de limitação de solicitação excluída |
| total | Integer | Número de configurações de limitação de solicitações excluídas que correspondem às condições de consulta |
| size | Integer | Comprimento da lista de configuração de limitação de solicitações excluídas retornada |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID de configuração de limitação de solicitação excluída |
| strategy_id | String | ID da política de limitação de solicitação à qual a configuração de limitação de solicitação excluída pertence |
| instance_id | Integer | ID de um objeto especificado na configuração de limitação de solicitação excluída |
| instance_name | String | Nome de uma aplicação ou um locatário ao qual se aplica a configuração de limitação de solicitação excluída |
| instance_type | Integer | Tipo do objeto excluído |
| call_limits | Integer | Número máximo de vezes que o objeto excluído pode acessar uma API dentro do período de limitação |
| apply_time | Timestamp | Hora em que a configuração de limitação de solicitação excluída é criada |
| app_id | String | ID da aplicação ao qual se aplica a configuração de limitação de solicitação excluída |
| app_name | String | Nome da aplicação ao qual a configuração de limitação de solicitação excluída se aplica |
Exemplo de resposta:
{
"total": 1,
"size": 1,
"throttle_specials": [{
"id": "778879b8-df10-495b-a087-874859fdea6d",
"strategy_id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9",
"instance_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
"instance_name": "app_002",
"instance_type": "APP",
"call_limits": 180,
"apply_time": "2017-12-29T03:11:18Z",
"app_id": "98efd77d-10b5-4eca-8170-ed30a4a286a4",
"app_name": "app_002"
}]
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
| 401 | Não autorizado |
| 403 | Proibido |
| 404 | Não encontrado |
| 500 | Erro do servidor interno |