Consulta da lista de políticas de limitação de solicitações vinculadas a uma API
Função
Esta API é usada para consultar a lista de políticas de limitação de solicitações vinculadas a uma API. Apenas uma política de limitação de solicitações pode ser vinculada a uma API em um ambiente.
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/binded-throttles[?page_no, page_size, api_id, throttle_id, throttle_name,env_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: api_id, throttle_id, throttle_name, env_id, 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 |
|
throttle_id |
Não |
String |
ID da política de limitação de solicitações |
|
throttle_name |
Não |
String |
Solicitar nome da política de limitação |
|
env_id |
Não |
String |
ID do ambiente |
|
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 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 da política de limitação de solicitações |
|
name |
String |
Solicitar nome da política de limitaçã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: 1: sim 2: não |
|
env_name |
String |
Ambiente no qual a política de limitação de solicitações entra em vigor |
|
type |
Integer |
Tipo da política de limitação de solicitação |
|
bind_id |
String |
ID de vinculação |
|
bind_time |
Timestamp |
Hora em que a política de limitação de solicitações está vinculada à API |
|
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 de limitação de solicitação dinâmica. Esta função não está disponível no momento. |
{
"total": 1,
"size": 1,
"throttles": [{
"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": 100,
"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",
"is_inclu_special_throttle": 2,
"env_name": "RELEASE",
"type":1,
"bind_id":"359f5c1868f647b6ad0f0d285154a791",
"bind_time":"2019-07-08T01:27:38Z",
"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 |
|
403 |
Proibido |
|
404 |
Não encontrado |
|
500 |
Erro do servidor interno |