Creación de una configuración de limitación de solicitudes excluidas
Función
Una política de limitación de solicitudes controla el número máximo de veces que se puede acceder a una API dentro de un período especificado y el número máximo de veces que un inquilino o una aplicación pueden acceder a la API dentro del mismo período.
Si es necesario, puede crear una configuración de limitación de solicitudes excluidas para especificar el umbral de llamadas a la API para una aplicación específica. Por ejemplo, si establece el umbral de llamada API para todas las apps en 500 llamadas/minuto, puede especificar el umbral de llamada API de la app 1 como 800 llamadas/minuto.
Puede agregar aplicaciones o inquilinos excluidos a una política de limitación de solicitudes.
URI
POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
throttle_id |
Sí |
String |
Solicitud de ID de política de limitación. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
call_limits |
Sí |
Integer |
Número máximo de veces que un objeto excluido puede acceder a una API dentro del período de limitación. |
object_id |
Sí |
String |
ID de aplicación excluido o ID de cuenta excluido. |
object_type |
Sí |
String |
Tipo de objeto excluido. Valores de enumeración:
|
Parámetros de respuesta
Código de estado: 201
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de configuración excluido. |
call_limits |
Integer |
Número máximo de veces que un objeto excluido puede acceder a una API dentro del período de limitación. |
apply_time |
String |
Período de limitación. |
app_name |
String |
Nombre de la aplicación. |
app_id |
String |
ID de la aplicación. |
object_id |
String |
ID de un objeto especificado en la configuración excluida. |
object_type |
String |
Tipo de objeto excluido, que puede ser APP o USER. |
object_name |
String |
Nombre de una aplicación o un inquilino a la que se aplica la configuración excluida. |
throttle_id |
String |
Solicitud de ID de política de limitación. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 404
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitudes de ejemplo
{ "call_limits" : 150, "object_id" : "356de8eb7a8742168586e5daf5339965", "object_type" : "APP" }
Ejemplo de respuestas
Código de estado: 201
Created
{ "call_limits" : 150, "app_name" : "app_demo", "object_name" : "app_demo", "object_id" : "356de8eb7a8742168586e5daf5339965", "throttle_id" : "3437448ad06f4e0c91a224183116e965", "apply_time" : "2020-08-04T02:40:56.717710961Z", "id" : "a3e9ff8db55544ed9db91d8b048770c0", "app_id" : "356de8eb7a8742168586e5daf5339965", "object_type" : "APP" }
Código de estado: 400
Bad Request
{ "error_code" : "APIG.2003", "error_msg" : "The parameter value is too large,parameterName:call_limits. Please refer to the support documentation" }
Código de estado: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Código de estado: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
Código de estado: 404
Not Found
{ "error_code" : "APIG.3004", "error_msg" : "App 356de8eb7a8742168586e5daf5339965 does not exist" }
Código de estado: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Códigos de estado
Código de estado |
Descripción |
---|---|
201 |
Created |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.