Consulta de la lista de APIs no vinculadas a una aplicación
Función
Esta API se utiliza para consultar la lista de las API autodesarrolladas que no se han vinculado a una aplicación en un entorno específico.
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/unbinded-apis[?page_size, page_no, app_id, env_id, api_id, api_name, group_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: app_id, api_id, api_name, group_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 |
|---|---|---|---|
| app_id | Sí | String | ID de la aplicación |
| env_id | Sí | String | ID de entorno |
| group_id | No | String | ID de grupo de API |
| api_id | No | String | ID de API |
| api_name | No | String | Nombre de la API |
| 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 API que coinciden con las condiciones de consulta |
| size | Integer | Longitud de la lista de API devuelta |
| apis | Dictionary | Lista de API |
| Parámetro | Tipo | Descripción |
|---|---|---|
| id | String | ID de API |
| name | String | Nombre de la API |
| group_id | String | ID del grupo de API al que pertenece la API |
| group_name | String | Nombre del grupo de API al que pertenece la API |
| remark | String | Descripción de la API |
| run_env_name | String | Nombre del entorno en el que se ha publicado la API |
| run_env_id | String | ID del entorno en el que se ha publicado la API |
| publish_id | String | ID del registro de publicación |
| auth_type | String | Modo de autenticación de seguridad |
| req_uri | String | Dirección de acceso |
Ejemplo de respuesta:
{
"total": 1,
"size": 1,
"apis": [{
"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9",
"name": "API_group_list_query",
"remark": "API group list query",
"group_id": "73c58022-f20d-495a-a188-85d718647f09",
"group_name": "api_group_001",
"run_env_name": "RELEASE",
"run_env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID",
"publish_id": "65e6fe53-1ac3-4481-ba36-9f0bc6f22057",
"auth_type": "APP",
"req_uri": "/test"
}]
} 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 |