Consulta de la lista de aplicaciones vinculadas a una API
Función
Esta API se utiliza para consultar la lista de aplicaciones que se han enlazado a una API especificada.
URI
La siguiente tabla muestra el método de solicitud HTTP/HTTPS y el URI de la API.
| Método de solicitud | URI |
|---|---|
| GET | /v1.0/apigw/app-auths/binded-apps[?page_size, page_no, api_id, app_name, app_id, env_id] |
- Se puede agregar una combinación de diferentes condiciones de consulta al final del URI utilizando signos de interrogación (?) y ampersands (&).
- Las condiciones de consulta incluyen: api_id, app_name, app_id, env_id, page_size y page_no.
En la siguiente tabla se enumeran los parámetros del URI.
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| 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 |
| page_size | No | Integer | Número de registros mostrados en cada página. El valor predeterminado es 20. |
| page_no | No | Integer | Número de página. El valor predeterminado es 1. |
Solicitud
N/A
Respuesta
| Parámetro | Tipo | Descripción |
|---|---|---|
| total | Integer | Número de aplicaciones que coinciden con las condiciones de consulta |
| size | Integer | Longitud de la lista de aplicaciones devueltas |
| auths | Dictionary | Lista de aplicaciones |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de autorización |
| api_id | String | ID de API |
| api_name | String | Nombre de la API |
| group_name | String | Grupo de API al que pertenece la API |
| api_remark | String | Descripción de la API |
| api_type | Integer | Tipo de API |
| envname | String | Entorno en el que se ha autorizado el acceso a la API a una aplicación |
| auth_role | String | Autorizador |
| auth_time | String | Tiempo de autorización |
| appid | String | ID de la aplicación |
| app_name | String | Nombre de la aplicación |
| app_creator | String | Creador de aplicaciones, que puede ser:
|
| publish_id | String | ID del registro de publicación |
| env_id | String | ID de entorno |
| app_remark | String | Descripción de la aplicación |
| app_type | String | Tipo de aplicación |
Ejemplo de respuesta:
{
"total": 1,
"size": 1,
"auths": [{
"id": "cfa688d8-094b-445a-b270-6aeb0b70a84a",
"api_id": "6632a062-9dcf-4f18-9646-3cabb925a290",
"api_name": "API_list_query",
"group_name": "api_group_001",
"api_type": 1,
"api_remark": "API list query",
"envname": "RELEASE",
"auth_role": "PROVIDER",
"auth_time": "2017-12-28T12:46:43Z",
"appid": "14b399ac-967f-4115-bb62-c0346b4537e9",
"app_name": "app_001",
"app_creator": "USER",
"publish_id": "fe9d8ea9f9424594abc3bbe8d861c0f0",
"env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"app_remark": "",
"app_type": "apig"
}]
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Server Internal Error |