Consulta de una lista de aplicaciones
Función
Esta API se utiliza para consultar una lista de aplicaciones que coinciden con las condiciones especificadas.
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/apps[?page_size, page_no, id, name, app_key, creator] |
- 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: id, name, app_key, creator, page_size y page_no.
En la siguiente tabla se enumeran los parámetros del URI.
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
No |
String |
ID de la aplicación |
name |
No |
String |
Nombre de la aplicación |
status |
No |
Integer |
Estado de la aplicación |
app_key |
No |
String |
AppKey |
creator |
No |
String |
Creador de aplicaciones, que puede ser:
|
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. |
precise_search |
No |
String |
Nombre del parámetro name para la coincidencia exacta |
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 |
apps |
Dictionary |
Lista de aplicaciones |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID de la aplicación |
name |
String |
Nombre de la aplicación |
status |
Integer |
Estado de la aplicación |
app_key |
String |
AppKey |
app_secret |
String |
AppSecret |
register_time |
Timestamp |
Tiempo de creación |
remark |
String |
Descripción de la aplicación |
update_time |
Timestamp |
Hora en la que se actualizó la aplicación por última vez |
creator |
String |
Creador de aplicaciones, que puede ser:
|
app_type |
String |
Tipo de aplicación. El valor predeterminado es apig. |
bind_num |
Integer |
Número de las API a las que se ha enlazado la aplicación |
{ "total": 2, "size": 2, "apps": [{ "id": "98efd77d-10b5-4eca-8170-ed30a4a286a4", "name": "app_002", "status": 1, "app_key": "f627fbaa-2c8b-4f58-a690-f478f54d3fe2", "app_secret": "******", "remark": "Second app", "register_time": "2017-12-28T12:32:50Z", "update_time": "2017-12-28T12:32:50Z", "creator": "MARKET", "app_type": "apig", "bind_num": 2 }, { "id": "14b399ac-967f-4115-bb62-c0346b4537e9", "name": "app_001", "status": 1, "app_key": "d49b1cbf-cc81-4a5f-b2a0-61b568e376eb", "app_secret": "******", "remark": "First app", "register_time": "2017-12-28T12:26:54Z", "update_time": "2017-12-28T12:29:35.571Z", "creator": "USER", "app_type": "apig", "bind_num": 2 }] }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
500 |
Server Internal Error |