Consulta de aplicaciones vinculadas a una API
Función
Esta API se utiliza para consultar las aplicaciones que se han enlazado a una API especificada.
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}/app-auths/binded-apps
| 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. |
| 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_id | No | String | ID de API. |
| app_name | No | String | Nombre de la aplicación. |
| app_id | No | String | ID de la aplicación. |
| env_id | No | String | ID de entorno. |
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. |
| auths | Array of ApiAuthInfo objects | Lista de API. |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de registro de autorización. |
| api_id | String | ID de API. |
| api_name | String | Nombre de la API. |
| group_name | String | Nombre del grupo de API al que pertenece la API. |
| api_type | Integer | Tipo de la API. |
| api_remark | String | Descripción de API. |
| env_id | String | ID del entorno en el que se ha autorizado a una aplicación para invocar a la API. |
| auth_role | String | Autorizador. |
| auth_time | String | Tiempo de autorización. |
| app_name | String | Nombre de la aplicación. |
| app_remark | String | Descripción de la aplicación. |
| app_type | String | Tipo de aplicación. El valor predeterminado es apig. Otros tipos no son compatibles actualmente. |
| app_creator | String | Creador de la aplicación.
|
| publish_id | String | ID de registro de publicación de API. |
| group_id | String | ID del grupo de API al que pertenece la API. |
| auth_tunnel | String | Tipo de canal de autorización.
El valor predeterminado es NORMAL. Este parámetro no se admite actualmente. |
| auth_whitelist | Array of strings | Lista blanca para el canal verde. |
| auth_blacklist | Array of strings | Lista negra para el canal verde. |
| visit_param | String | Parámetros de acceso. |
| roma_app_type | String | Tipo de aplicación de ROMA.
Actualmente, este parámetro no es compatible. |
| 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 |
| env_name | String | Nombre del entorno en el que se ha autorizado a la aplicación para invocar a la API. |
| app_id | String | ID de la aplicació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,
"auths" : [ {
"api_id" : "5f918d104dc84480a75166ba99efff21",
"app_name" : "app_demo",
"env_id" : "DEFAULT_ENVIRONMENT_RELEASE_ID",
"env_name" : "RELEASE",
"group_id" : "c77f5e81d9cb4424bf704ef2b0ac7600",
"group_name" : "api_group_001",
"api_type" : 1,
"api_name" : "Api_http",
"app_id" : "356de8eb7a8742168586e5daf5339965",
"auth_time" : "2020-08-04T04:02:22Z",
"app_creator" : "USER",
"id" : "dd29b33ae4394e3b924b582c6b40880b",
"api_remark" : "Web backend API",
"auth_role" : "PROVIDER",
"app_type" : "apig",
"auth_tunnel" : "NORMAL"
} ]
} Código de estado: 400
Error en la solicitud
{
"error_code" : "APIG.2012",
"error_msg" : "Invalid parameter value,parameterName:app_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: 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.
