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.
Actualización más reciente 2023-03-29 GMT+08:00

Consulta de la lista de políticas de limitación de solicitudes vinculadas a una API

Función

Esta API se utiliza para consultar la lista de políticas de limitación de solicitudes que se han enlazado a una API. Solo se puede vincular una política de limitación de solicitudes a una API en un entorno.

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/throttle-bindings/binded-throttles[?page_no, page_size, api_id, throttle_id, throttle_name,env_id]

  • 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 api_id, throttle_id, throttle_name, env_id, page_size y page_no.

En la siguiente tabla se enumeran los parámetros del URI.

Tabla 2 Descripción de parámetro

Parámetro

Obligatorio

Tipo

Descripción

api_id

String

ID de API

throttle_id

No

String

Solicitar ID de política de limitación

throttle_name

No

String

Solicitar nombre de política de limitación

env_id

No

String

ID de entorno

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.

Solicitud

N/A

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

Solicitar ID de política de limitación

name

String

Solicitar nombre de política de limitación

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

env_name

String

Entorno en el que entra en vigor la política de limitación de solicitudes

type

Integer

Tipo de la política de limitación de solicitudes

bind_id

String

ID de vinculación

bind_time

Timestamp

Hora en la que la política de limitación de solicitudes está vinculada a la API

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. Esta función no se encuentra disponible actualmente.

Ejemplo de respuesta:
{
	"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 estado

Tabla 5 Códigos de estado

Código de estado

Descripción

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Internal Error