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 APIs vinculadas con una política de limitación de solicitudes
Actualización más reciente 2023-03-29 GMT+08:00
Ver PDF
Compartir

Consulta de APIs vinculadas con una política de limitación de solicitudes

Función

Esta API se utiliza para consultar las API a las que se ha enlazado una política de limitación de solicitudes especificada.

URI

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

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

throttle_id

Sí

String

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

env_id

No

String

ID de entorno.

group_id

No

String

ID de grupo de API.

api_id

No

String

ID de API.

api_name

No

String

Nombre de API.

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.

apis

Array of ApiForThrottle objects

Lista de API.
Tabla 5 ApiForThrottle

Parámetro

Tipo

Descripción

auth_type

String

Modo de autenticación de API.

group_name

String

Nombre del grupo de API al que pertenece la API.

publish_id

String

ID de registro de publicación de API.

throttle_apply_id

String

ID de un registro de enlace de política de limitación de solicitud.

apply_time

String

Hora de vinculación.

remark

String

Descripción de API.

run_env_id

String

ID del entorno en el que se ha publicado la API.

type

Integer

Tipo de API.

throttle_name

String

Nombre de la política de limitación de solicitudes vinculada a la API.

req_uri

String

Dirección de acceso de la API.

run_env_name

String

Nombre del entorno en el que se ha publicado la API.

group_id

String

ID del grupo de API al que pertenece la API.

name

String

Nombre de API.

id

String

ID de 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,
  "apis" : [ {
    "run_env_name" : "RELEASE",
    "group_name" : "api_group_001",
    "publish_id" : "40e7162dc6b94bbbbb1a60d2a24b1b0c",
    "group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
    "throttle_apply_id" : "3e06ac135e18477e918060d3c59d6f6a",
    "name" : "Api_http",
    "apply_time" : "2020-08-03T12:25:52Z",
    "remark" : "Web backend API",
    "run_env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "id" : "5f918d104dc84480a75166ba99efff21",
    "type" : 1,
    "throttle_name" : "throttle_demo",
    "auth_type" : "APP",
    "req_uri" : "/test/http"
  } ]
}

Código de estado: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:throttle_id. 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.3005",
  "error_msg" : "Request throttling policy 3437448ad06f4e0c91a224183116e965 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.