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 complementos
Actualización más reciente 2025-12-22 GMT+08:00
Ver PDF
Compartir

Consulta de complementos

Función

Esta API se utiliza para consultar detalles sobre un grupo de complementos que cumplen las condiciones especificadas.

  • Consulta de paginación

  • Consulta por tipo de complemento

  • Consulta por ámbito de complemento

  • Consulta por ID de complemento

  • Consulta aproximada por nombre de complemento

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

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.

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

plugin_type

No

String

Tipo de complemento.

plugin_scope

No

String

Alcance del complemento.

plugin_id

No

String

ID de complemento.

plugin_name

No

String

Nombre del complemento, que se puede utilizar para consulta difusa.

precise_search

No

String

Nombre del parámetro para la coincidencia exacta. Se admite el nombre del complemento.

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.

plugins

Array of PluginInfo objects

Complementos.

Tabla 5 PluginInfo

Parámetro

Tipo

Descripción

plugin_id

String

ID de complemento.

plugin_name

String

Nombre del complemento. Se comienza con una letra y solo se incluye letras, dígitos, guiones (-) y guiones bajos (_). (de 3 a 255 caracteres)

plugin_type

String

Tipo de complemento

  • cors: intercambio de recursos entre orígenes.

  • set_resp_headers: gestión de encabezados de respuesta HTTP.

  • kafka_log: empuje de log de Kafka.

  • breaker: interruptor.

  • rate_limit: Solicitud de limitación.

  • Third_auth: Autenticación de terceros.

  • proxy_cache: Caché de respuestas.

  • proxy_mirror: duplicación de solicitudes

plugin_scope

String

Alcance del complemento. global: Visible para todos los gateways.

plugin_content

String

Contenido del complemento en formato JSON. Para obtener más información, consulte la definición del modelo.

  • CorsPluginContent

  • SetRespHeadersContent

  • KafkaLogContent

  • BreakerContent

  • RateLimitContent

  • ThirdAuthContent

  • ProxyCacheContent

  • ProxyMirrorContent

Máximo: 65535

remark

String

Descripción del complemento, con un máximo de 255 caracteres.

Máximo: 255

create_time

String

Tiempo de creación.

update_time

String

Tiempo de actualización.

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: 500

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.

Ejemplo de las solicitudes

Ninguno

Ejemplo de respuestas

Código de estado: 200

Aceptar

{
  "total" : 1,
  "size" : 1,
  "plugins" : [ {
    "plugin_id" : "5b729aa252764739b3s237ef0d66dc63",
    "plugin_name" : "CORS",
    "plugin_type" : "cors",
    "plugin_scope" : "global",
    "plugin_content" : "{\"allow_origin\": \"*\",\"allow_methods\": \"GET,POST,PUT\",\"allow_headers\": \"Content-Type,Accept,Accept-Ranges,Cache-Control\",\"expose_headers\": \"X-Request-Id,X-Apig-Latency\",\"max_age\": 172800,\"allow_credentials\": true}",
    "remark" : "Cross-origin resource sharing",
    "create_time" : "2022-11-02T12:31:23.353Z",
    "update_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:plugin_name. 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: 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

500

Error del servidor interno

Códigos de error

Consulte Códigos de error.

Tema principal:Gestión de plug-in