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/ API de gateway dedicados (V2)/ Gestión de plug-in/ Consulta de las API vinculadas con un complemento
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de las API vinculadas con un complemento

Función

Esta API se utiliza para consultar las API a las que se ha enlazado un complemento.

  • Consulta de las API vinculadas a un complemento especificado

  • Consulta de paginación

  • Consulta difusa por nombre de API

  • También se incluyen las API desconectadas.

Método de invocación

Para obtener más información, véase invocación de API.

URI

GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attached-apis

Tabla 1 Parámetros de ruta

Parámetro

Obligatorio

Tipo

Descripción

project_id

Sí

String

ID del proyecto. Para obtener más información sobre cómo obtenerlo, véase Obtención de un ID de proyecto.

instance_id

Sí

String

ID de gateway, que se puede obtener de la información de gateway en la consola de APIG.

plugin_id

Sí

String

ID de complemento.
Tabla 2 Parámetros de consulta

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

env_id

No

String

ID de entorno.

api_name

No

String

Nombre de la API.

api_id

No

String

ID de API.

group_id

No

String

ID de grupo.

req_method

No

String

Método de solicitud.

req_uri

No

String

Ruta de solicitud.

tags

No

String

Etiqueta de API. Se pueden especificar varias etiquetas de API. La relación entre varios valores de parámetro es OR. Si no se especifica este parámetro, no se especifica ninguna etiqueta de filtrado. Si este parámetro se establece en #no_tags#, se filtran las API sin etiquetas.

Mínimo: 0

Máximo: 128

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 invocando 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 del cuerpo 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 PluginApiInfo objects

Las API vinculadas al complemento.
Tabla 5 PluginApiInfo

Parámetro

Tipo

Descripción

api_id

String

ID de API.

api_name

String

Nombre de la API.

Escriba de 3 a 255 caracteres, comenzando con una letra o un dígito. Solo se permiten letras, dígitos y estos caracteres especiales: -_./:()

type

Integer

Tipo de la API.

  • 1: API pública.

  • 2: API privada.

req_protocol

String

Protocolo de solicitud de API.

  • HTTP

  • HTTPS

  • BOTH: Se admiten tanto HTTP como HTTPS.

Predeterminado: HTTPS

req_method

String

Método de solicitud.

req_uri

String

Dirección de solicitud, que puede contener parámetros de solicitud entre llaves ({}). Por ejemplo, /getUserInfo/{userId}. Caracteres especiales, como asteriscos (*), barras diagonales (/), signos de porcentaje (%), guiones (-), guiones bajos (_) y puntos (.), están permitidos. Puede contener un máximo de 512 caracteres y debe cumplir con las especificaciones de URI.

Se admiten variables de entorno. Cada uno debe comenzar con una letra y puede constar de 3 a 32 caracteres. Solo se admiten letras, dígitos, guiones (-) y guiones bajos (_).

NOTA:

La dirección debe cumplir con las especificaciones de URI.

auth_type

String

Modo de autenticación de API.

  • NONE

  • APP

  • IAM

  • AUTHORIZER

match_mode

String

Modo de coincidencia de API.

  • SWA: coincidencia de prefijo.

  • NORMAL: coincidencia exacta.

Valor predeterminado: NORMAL

remark

String

Descripción de API.

group_id

String

ID del grupo de API al que pertenece la API.

group_name

String

Nombre del grupo de API al que pertenece la API.

roma_app_id

String

ID de aplicación de integración para instancias de ROMA. Este parámetro se puede dejar en blanco.

env_id

String

ID del entorno para vincular a la API.

env_name

String

Nombre del entorno para vincular a la API.

publish_id

String

ID de registro de publicación.

plugin_attach_id

String

ID de registro de vinculación de complemento.

attached_time

String

Hora de vinculación.

tags

Array of strings

Etiquetas vinculadas a la API. La cuota predeterminada es 10. Póngase en contacto con el soporte técnico para ajustar la cuota.

Mínimo: 1

Máximo: 128

Longitud del arreglo: 0 - 10

Código de estado: 400

Tabla 6 Parámetros del cuerpo 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 del cuerpo 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 del cuerpo 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 del cuerpo 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 del cuerpo de respuesta

Parámetro

Tipo

Descripción

error_code

String

Código de error.

error_msg

String

Mensaje de error.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "total" : 1,
  "size" : 1,
  "apis" : [ {
    "api_id" : "8aa097b00e9843efabc9c593d11b769d",
    "api_name" : "Test_API",
    "type" : 1,
    "req_protocol" : "HTTP",
    "req_method" : "GET",
    "req_uri" : "/test",
    "auth_type" : "IAM",
    "match_mode" : "NORMAL",
    "remark" : "API description.",
    "group_id" : "b9be707660c5406394f8973e087bae20",
    "group_name" : "DEFAULT",
    "roma_app_id" : "",
    "plugin_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
    "publish_id" : "4739b3s5b729aa2237ef0d66dc635276",
    "env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
    "env_name" : "RELEASE",
    "attached_time" : "2022-11-02T12:31:23.353Z"
  } ]
}

Código de estado: 400

Error en la solicitud

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:instance_id. Please refer to the support documentation"
}

Código de estado: 401

Sin autorización

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Código de estado: 403

Prohibido

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Código de estado: 404

No se ha encontrado

{
  "error_code" : "APIG.3068",
  "error_msg" : "Plugin b294018ee0554156a875b3513e02e5b9 does not exist"
}

Código de estado: 500

Error del servidor interno

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Códigos de estado

Código de estado

Descripción

200

Aceptar

400

Error en la solicitud

401

Sin autorización

403

Prohibido

404

No se ha encontrado

500

Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal: Gestión de plug-in