Consulta da lista de políticas de limitação de solicitação
Função
Esta API é usada para consultar todas as políticas 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/throttles[?page_size, page_no, id, 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: id, name, page_size e page_no.
Solicitação
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id | Não | String | ID de uma política de limitação de solicitações |
| name | Não | String | Nome da política de limitação de solicitação |
| 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. |
| precise_search | Não | String | Nome do parâmetro (name) para correspondência exata |
Resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| total | Integer | Número de políticas de limitação de solicitações que correspondem às condições de consulta |
| size | Integer | Comprimento da lista de política de limitação de solicitações devolvida |
| throttles | Dicionário | Lista de política de limitação de solicitações |
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | String | ID de uma política de limitação de solicitações |
| name | String | Nome da política de limitação de solicitação |
| api_call_limits | Integer | Número máximo de vezes que uma API pode ser acessada dentro de um período especificado |
| user_call_limits | Integer | Número máximo de vezes que a API pode ser acessada por um usuário no mesmo período |
| app_call_limits | Integer | Número máximo de vezes que a API pode ser acessada por uma aplicação no mesmo período |
| ip_call_limits | Integer | Número máximo de vezes que a API pode ser acessada por um endereço IP no mesmo período |
| time_interval | Integer | Período de tempo para limitar o número de chamadas de API |
| time_unit | String | Unidade de tempo para limitar o número de chamadas de API |
| remark | String | Descrição da política de limitação de solicitações |
| create_time | Timestamp | Hora em que a política de limitação de solicitações é criada |
| is_include_special_throttle | Integer | Indica se uma configuração de limitação de solicitação excluída foi criada. O valor pode ser:
|
| type | Integer | Tipo da política de limitação de solicitações, que pode ser:
|
| bind_num | Integer | Número de APIs às quais a política de limitação de solicitações foi vinculada |
| enable_adaptive_control | String | Habilitação do status da limitação de solicitações dinâmicas
Esta função não está disponível no momento. |
{
"total": 2,
"size": 2,
"throttles": [{
"id": "a3106cfe-801f-4919-b0d7-d785dc5b47f9",
"name": "500_calls_per_second",
"api_call_limits": 500,
"user_call_limits": 200,
"app_call_limits": 100,
"app_call_limits": 100,
"time_interval": 1,
"time_unit": "SECOND",
"create_time": "2017-12-29T02:04:08Z",
"remark": "Total: 500 calls/second; user: 200 calls/second; app: 100 calls/second; IP address: 100 calls/second",
"is_inclu_special_throttle": 2,
"type":1,
"bind_num":1,
"enable_adaptive_control": "FALSE"
},
{
"id": "0325b671-2d50-4614-9868-22102262695d",
"name": "1000_calls_per_second",
"api_call_limits": 1000,
"user_call_limits": 500,
"app_call_limits": 300,
"ip_call_limits": 600,
"time_interval": 1,
"time_unit": "SECOND",
"create_time": "2017-12-29T01:55:59Z",
"remark": "Total: 1000 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
"is_inclu_special_throttle": 2,
"type":1,
"bind_num":1,
"enable_adaptive_control": "FALSE"
}]
} Códigos de status
| Código de status | Descrição |
|---|---|
| 200 | OK |
| 400 | Solicitação inválida |
| 401 | Não autorizado |
| 500 | Erro do servidor interno |
