Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ API Gateway/ Referencia de la API/ Las API de gateway compartido (para usuarios existentes)/ Solicitud de gestión de políticas de limitación/ Consulta de la lista de políticas de limitación de solicitudes

Actualización más reciente 2023-03-29 GMT+08:00

Ver PDF

Consulta de la lista de políticas de limitación de solicitudes

Función

Esta API se utiliza para consultar todas las políticas de limitación de solicitudes.

URI

La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.

**Tabla 1** Método de solicitud de HTTP/HTTPS y URI
Método de solicitud	URI
GET	/v1.0/apigw/throttles[?page_size, page_no, id, name]

Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
Entre las condiciones de consulta se incluyen id, name, page_size y page_no.

Solicitud

**Tabla 2** Descripción de parámetro
Parámetro	Obligatorio	Tipo	Descripción
id	No	String	ID de una política de limitación de solicitudes
name	No	String	Nombre de la política de limitación de solicitudes
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.
precise_search	No	String	Nombre del parámetro name para la coincidencia exacta

Respuesta

**Tabla 3** Descripción de parámetro
Parámetro	Tipo	Descripción
total	Integer	Número de políticas de limitación de solicitudes que coinciden con las condiciones de consulta
size	Integer	Longitud de la lista de políticas de limitación de solicitudes devueltas
throttles	Dictionary	Solicitud de lista de políticas de limitación

**Tabla 4** Descripción del parámetro de limitación
Parámetro	Tipo	Descripción
id	String	ID de una política de limitación de solicitudes
name	String	Nombre de la política de limitación de solicitudes
api_call_limits	Integer	Número máximo de veces que se puede acceder a una API dentro de un período especificado
user_call_limits	Integer	Número máximo de veces que un usuario puede acceder a la API dentro del mismo período
app_call_limits	Integer	Número máximo de veces que una aplicación puede acceder a la API dentro del mismo período
ip_call_limits	Integer	Número máximo de veces que se puede acceder a la API mediante una dirección IP dentro del mismo período
time_interval	Integer	Período de tiempo para limitar el número de invocaciones a la API
time_unit	String	Unidad de tiempo para limitar el número de invocaciones de API
remark	String	Descripción de la política de limitación de solicitudes
create_time	Timestamp	Hora en la que se crea la política de limitación de solicitudes
is_include_special_throttle	Integer	Indica si se ha creado una configuración de limitación de solicitud excluida. El valor puede ser: 1: sí 2: no
type	Integer	Tipo de la política de limitación de solicitudes, que puede ser: 1: exclusivo 2: compartido
bind_num	Integer	Número de API a las que se ha enlazado la política de limitación de solicitudes
enable_adaptive_control	String	Habilitación del estado de la limitación dinámica de solicitudes TRUE FALSE Esta función no se encuentra disponible actualmente.

Ejemplo de respuesta:

{
	"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"
	}]
}