Consulta de API a las que está vinculada una regla de orquestación
Función
Esta API se utiliza para consultar las API a las que se ha vinculado un complemento especificado.
-
API vinculadas a un complemento especificado
-
Consulta de paginación
-
Consulta difusa por nombre de API
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}/orchestrations/{orchestration_id}/attached-apis
| 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. |
| orchestration_id | Sí | String | ID de regla de orquestación. |
| 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_name | No | String | Nombre de la API. |
| api_id | No | String | ID de aplicación |
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. |
| apis | Array of OrchestrationApiInfo objects | API a las que se ha enlazado una regla de orquestación. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| api_id | String | ID de API. |
| api_name | String | Nombre de la API. Se comienza con una letra o un dígito de 3 a 255 caracteres. Solo se permiten letras, dígitos y estos caracteres especiales: -_./:() NOTA: Los caracteres chinos deben estar en formato UTF-8 o Unicode. |
| req_method | String | Método de solicitud. |
| req_uri | String | Dirección de solicitud. Puede contener parámetros de solicitud encerrados con 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 del 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. Opciones:
|
| match_mode | String | Modo de coincidencia de API. Opciones:
Predeterminado: NORMAL |
| group_id | String | ID del grupo de API al que pertenece una API. |
| group_name | String | Nombre del grupo de API al que pertenece la API. |
| attached_time | String | Hora de vinculación. |
Código de estado: 400
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Descripción de error. |
Código de estado: 401
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Descripción de error. |
Código de estado: 403
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Descripción de error. |
Código de estado: 404
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Descripción de error. |
Código de estado: 500
| Parámetro | Tipo | Descripción |
|---|---|---|
| error_code | String | Código de error. |
| error_msg | String | Descripción 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" : "api_demo",
"req_method" : "GET",
"req_uri" : "/test",
"auth_type" : "IAM",
"match_mode" : "NORMAL",
"group_id" : "b9be707660c5406394f8973e087bae20",
"group_name" : "group_demo",
"attached_time" : "2023-07-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.3030",
"error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec"
} 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.
