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 dedicado (V2)/ Políticas de limitación de solicitudes de vincualción/desvinculación/ Consulta de políticas de limitación de solicitudes vinculadas a una API
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

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

Función

Esta API se utiliza para consultar las 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

GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-throttles

Tabla 1 Parámetros de path

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.
Tabla 2 Parámetros de Query

Parámetro

Obligatorio

Tipo

Descripción

offset

No

Long

Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0.

Predeterminado: 0

limit

No

Integer

Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500.

Mínimo: 1

Máximo: 500

Predeterminado: 20

api_id

Sí

String

ID de API.

throttle_id

No

String

Solicitud de ID de política de limitación.

throttle_name

No

String

Solicitud del nombre de la política de limitación.

env_id

No

String

ID de entorno.

Parámetros de solicitud

Tabla 3 Parámetros de encabezado 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ámetros de respuesta

Código de estado: 200

Tabla 4 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

size

Integer

Longitud de la lista de recursos devuelta.

total

Long

Número de recursos que coinciden con las condiciones de consulta.

throttles

Array of ThrottleForApi objects

Solicitud de lista de políticas de limitación.
Tabla 5 ThrottleForApi

Parámetro

Tipo

Descripción

app_call_limits

Integer

Número máximo de veces que una aplicación puede acceder a la API dentro del mismo período. El valor de este parámetro no puede exceder el límite de llamadas de usuario. El valor máximo es de 2,147,483,647. Ingrese un número entero positivo.

name

String

Solicitud del nombre de la política de limitación. Puede contener de 3 a 64 caracteres, empezando por una letra. Solo se permiten letras, dígitos y guiones bajos (_).

time_unit

String

Unidad de tiempo para limitar el número de llamadas API.

Valores de enumeración:

  • SECOND

  • MINUTE

  • HOUR

  • DAY

remark

String

Descripción de la política de limitación de solicitudes, que puede contener un máximo de 255 caracteres.

api_call_limits

Integer

Número máximo de veces que se puede acceder a una API dentro de un período especificado. El valor de este parámetro no puede exceder el límite predeterminado 200 TPS. Puede cambiar el límite predeterminado para cumplir con los requisitos de servicio. El valor máximo es de 2,147,483,647. Ingrese un número entero positivo.

type

Integer

Tipo de la política de limitación de solicitud.

  • 1: basado en API, limitando el número máximo de veces que se puede llamar a una única API vinculada a la política dentro del período especificado.

  • 2: API compartida, limitando el número máximo de veces que se pueden llamar a todas las API vinculadas a la política dentro del período especificado.

Valores de enumeración:

  • 1

  • 2

enable_adaptive_control

String

Indica si se activa la limitación dinámica de solicitudes.

  • TRUE

  • FALSE

Actualmente, este parámetro no es compatible.

user_call_limits

Integer

Número máximo de veces que un usuario puede acceder a la API dentro del mismo período. El valor de este parámetro no puede exceder el valor máximo. Solicitudes de API. El valor máximo es de 2,147,483,647. Ingrese un número entero positivo.

time_interval

Integer

Período de tiempo para limitar el número de llamadas a la API. Este parámetro se aplica con cada límite de llamada a la API. El valor máximo es de 2,147,483,647. Ingrese un número entero positivo.

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. El valor de este parámetro no puede exceder el límite de llamada a la API. El valor máximo es de 2,147,483,647. Ingrese un número entero positivo.

id

String

Solicitud de ID de política de limitación.

bind_num

Integer

Número de API a las que se ha enlazado la política de limitación de solicitudes.

is_inclu_special_throttle

Integer

Indica si se ha creado una configuración de limitación de solicitud excluida.

  • 1: sí

  • 2: no

Valores de enumeración:

  • 1

  • 2

create_time

String

Hora de creación.

env_name

String

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

bind_id

String

ID de registro de vinculación de política.

bind_time

String

Hora en la que la política está vinculada a la API.

Código de estado: 400

Tabla 6 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 401

Tabla 7 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 403

Tabla 8 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 404

Tabla 9 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Código de estado: 500

Tabla 10 Parámetros de body de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Solicitudes de ejemplo

Ninguna

Ejemplo de respuestas

Código de estado: 200

OK

{
  "total" : 1,
  "size" : 1,
  "throttles" : [ {
    "id" : "3437448ad06f4e0c91a224183116e965",
    "name" : "throttle_demo",
    "api_call_limits" : 800,
    "user_call_limits" : 500,
    "app_call_limits" : 300,
    "ip_call_limits" : 600,
    "time_interval" : 1,
    "time_unit" : "SECOND",
    "create_time" : "2020-07-31T08:44:02Z",
    "remark" : "Total: 800 calls/second; user: 500 calls/second; app: 300 calls/second; IP address: 600 calls/second",
    "is_inclu_special_throttle" : 2,
    "env_name" : "RELEASE",
    "type" : 1,
    "bind_id" : "3e06ac135e18477e918060d3c59d6f6a",
    "bind_time" : "2020-08-03T12:25:52Z",
    "bind_num" : 0,
    "enable_adaptive_control" : "FALSE"
  } ]
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:throttle_name. 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.3002",
  "error_msg" : "API 5f918d104dc84480a75166ba99efff21 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

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Códigos de error

Consulte Códigos de error.