Consulta de la lista de APIs no vinculadas a una clave de firma
Función
Esta API se utiliza para consultar la lista de API que no están enlazadas a una clave de firma especificada. Solo se mostrarán las API publicadas.
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/sign-bindings/unbinded-apis[?page_size, page_no, sign_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: sign_id, env_id, api_id, api_name, group_id, page_size y page_no.
Solicitud
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| sign_id | Sí | String | ID de clave de firma |
| env_id | No | String | ID de entorno |
| api_id | No | String | ID de API |
| api_name | No | String | Nombre de la API |
| group_id | No | String | ID de grupo de API |
Respuesta
| Parámetro | Tipo | Descripción |
|---|---|---|
| total | Integer | Número total 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 |
| type | Integer | Tipo de API |
| remark | String | Descripción 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 |
| 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 de registro de publicación de API |
| signature_name | String | Nombre de la clave de firma vinculada a la API |
| auth_type | String | Modo de autenticación de seguridad |
| req_uri | String | Dirección de acceso |
Ejemplo de respuesta:
{
"total": 2,
"size": 2,
"apis": [{
"name": "bbb",
"type": 1,
"group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2",
"id": "3c6769c6-ec61-4b45-b478-c60310dbaa1b",
"group_name": "asd",
"run_env_name": "das",
"run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215",
"publish_id": "6dff16c4-813f-486a-bba4-fdad45a55a70",
"auth_type": "NONE",
"req_uri": "/test"
},
{
"name": "aaa",
"type": 1,
"group_id": "7ccc0b94-eb5a-48e6-8554-6d0105a540e2",
"id": "d85c502a-f916-47e8-bba0-50537a2d1af2",
"group_name": "asd",
"run_env_name": "das",
"run_env_id": "1fdcb2e4-f90a-4159-817d-98c9b8e8b215",
"publish_id": "dec83400-a0c6-4ea6-abfd-5bf237292f4d",
"auth_type": "NONE",
"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 |