Consulta de la lista de API vinculadas a una aplicación
Función
Esta API se utiliza para consultar la lista de API que se han enlazado a una aplicación específica.
Solo se pueden consultar las API a las que se ha autorizado el acceso a una aplicación en un entorno.
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-apis[?page_size, page_no, app_id, api_id, api_name,group_id,group_name,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: app_id, api_id, api_name, group_id, group_name, 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 |
api_id |
No |
String |
ID de API |
api_name |
No |
String |
Nombre de la API |
group_id |
No |
String |
ID de grupo de API |
group_name |
No |
String |
Nombre del grupo de API |
env_id |
No |
String |
ID del entorno en el que se ha autorizado la aplicación |
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 |
auths |
Dictionary |
Lista de API |
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 |
Nombre del entorno en el que la aplicación ha sido autorizada para invocar a la API |
env_id |
String |
ID del entorno |
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:
|
app_remark |
String |
Descripción de la aplicación |
app_type |
String |
Tipo de aplicación |
publish_id |
String |
ID de publicación de API |
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", "env_id": "DEFAULT_ENVIRONMENT_RELEASE_ID", "app_remark": "App description", "app_type": "apig", "publish_id": "f500ba7e369b4b1ebae99aa9d114a17a" }] }
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 |