Consulta de complementos vinculados a una API
Función
Esta API se utiliza para consultar los complementos vinculados a una API.
-
Consultar complementos enlazados a una API especificada
-
Consulta de paginación
-
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}/apis/{api_id}/attached-plugins
| 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. |
| api_id | Sí | String | ID de API. |
| 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. |
| plugin_name | No | String | Nombre del complemento. |
| plugin_id | No | String | ID de complemento. |
| env_name | No | String | Nombre del entorno. |
| plugin_type | No | String | Tipo de complemento. |
Parámetros 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
| 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 AttachedPluginInfo objects | Complementos vinculados a la API. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| plugin_attach_id | String | ID de registro de enlace de complemento. |
| 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
|
| plugin_scope | String | Alcance del complemento. global: Visible para todos los gateways. |
| env_id | String | ID del entorno para vincular a la API. |
| env_name | String | Nombre del entorno para vincular a la API. |
| attached_time | String | Hora de vinculación. |
| plugin_content | String | Contenido del complemento en formato JSON. 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
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 401
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 403
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 404
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Mensaje de error. |
Código de estado: 500
| 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_attach_id" : "8aa097b00e9843efacb9c593d11b769e",
"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",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name" : "RELEASE",
"attached_time" : "2022-11-02T12:31:23.353Z",
"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: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.3002",
"error_msg" : "API 5f918d104dc84480a75166ba99efff21 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.
