Consulta de la lista de configuraciones de limitación de solicitudes excluidas
Función
Esta API se utiliza para consultar todas las configuraciones excluidas de una política de limitación de solicitudes.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
Método de solicitud |
URI |
---|---|
GET |
/v1.0/apigw/throttle-specials/{strategy_id}[?page_size, page_no, instance_type, app_name, user] |
- Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
- Las condiciones de consulta incluyen strategy_id, app_name, user, page_size y page_no.
En la siguiente tabla se enumeran los parámetros del URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
strategy_id |
Sí |
String |
Solicitar ID de política de limitación |
page_size |
No |
Integer |
Número de registros mostrados en cada página. El valor predeterminado es 20. |
page_no |
No |
Integer |
Número de página. El valor predeterminado es 1. |
instance_type |
No |
String |
Tipo de objeto, que puede ser APP o USER |
app_name |
No |
String |
Nombre de una aplicación excluida |
user |
No |
String |
ID de cuenta |
Solicitud
N/A
Respuesta
Parámetro |
Tipo |
Descripción |
---|---|---|
throttle_specials |
Dictionary |
Lista de configuración de limitación de solicitudes excluidas |
total |
Integer |
Número de configuraciones de limitación de solicitudes excluidas que coinciden con las condiciones de consulta |
size |
Integer |
Longitud de la lista de configuración de limitación de solicitud excluida devuelta |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de configuración de limitación de solicitud excluida |
strategy_id |
String |
ID de la política de limitación de solicitudes a la que pertenece la configuración de limitación de solicitudes excluidas |
instance_id |
Integer |
ID de un objeto especificado en la configuración de limitación de solicitudes excluidas |
instance_name |
String |
Nombre de una aplicación o un inquilino al que se aplica la configuración de limitación de solicitudes excluidas |
instance_type |
Integer |
Tipo del objeto excluido |
call_limits |
Integer |
Número máximo de veces que el objeto excluido puede acceder a una API dentro del período de limitación |
apply_time |
Timestamp |
Hora en la que se crea la configuración de limitación de solicitud excluida |
app_id |
String |
ID de la aplicación a la que se aplica la configuración de limitación de solicitud excluida |
app_name |
String |
Nombre de la aplicación a la que se aplica la configuración de limitación de solicitud excluida |
Ejemplo de respuesta:
{ "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 estado
Código de estado |
Descripción |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Server Internal Error |