Consulta de aplicaciones
Función
Esta API se utiliza para consultar aplicaciones.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/apps
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener detalles sobre cómo obtener un ID de proyecto, consulte "Apéndice" > "Obtención de un ID de proyecto" en este documento. |
instance_id |
Sí |
String |
Gateway ID, que se puede obtener de la información de gateway en la consola APIG. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
offset |
No |
Long |
Desfase desde el que se inicia la consulta. Si el valor es menor que 0, se convierte automáticamente a 0. Predeterminado: 0 |
limit |
No |
Integer |
Número de elementos mostrados en cada página. Un valor menor o igual a 0 se convertirá automáticamente a 20, y un valor mayor que 500 se convertirá automáticamente a 500. Mínimo: 1 Máximo: 500 Predeterminado: 20 |
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 la aplicación.
|
precise_search |
No |
String |
Nombre del parámetro (nombre) para la coincidencia exacta. |
Parámetros de solicitud
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
X-Auth-Token |
Sí |
String |
Token de usuario. Se puede obtener llamando a la API de IAM utilizada para obtener un token de usuario. El valor de X-Subject-Token en el encabezado de respuesta es un token. |
Parámetros de respuesta
Código de estado: 200
Parámetro |
Tipo |
Descripción |
---|---|---|
size |
Integer |
Longitud de la lista de recursos devuelta. |
total |
Long |
Número de recursos que coinciden con las condiciones de consulta. |
apps |
Array of AppInfoWithBindNum objects |
Lista de aplicaciones. |
Parámetro |
Tipo |
Descripción |
---|---|---|
id |
String |
ID. |
name |
String |
Nombre. |
remark |
String |
Descripción. |
creator |
String |
Creador de la aplicación.
El valor MARKET no se admite actualmente. Valores de enumeración:
|
update_time |
String |
Hora de actualización. |
app_key |
String |
AppKey. |
app_secret |
String |
AppSecret. |
register_time |
String |
Hora de registro. |
status |
Integer |
Estado.
Valores de enumeración:
|
app_type |
String |
Tipo de aplicación.
El valor predeterminado es apig. Otros tipos no son compatibles actualmente. Valores de enumeración:
|
roma_app_type |
String |
Tipo de aplicación de ROMA.
Actualmente, este parámetro no es compatible. |
bind_num |
Integer |
Número de API enlazadas. |
Código de estado: 400
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 401
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 403
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Código de estado: 500
Parámetro |
Tipo |
Descripción |
---|---|---|
error_code |
String |
Código de error. |
error_msg |
String |
Mensaje de error. |
Solicitudes de ejemplo
Ninguna
Ejemplo de respuestas
Código de estado: 200
OK
{ "total" : 2, "size" : 2, "apps" : [ { "bind_num" : 0, "creator" : "USER", "update_time" : "2020-08-03T13:09:13Z", "app_key" : "ee8f878c252747028f07eb116c2cd91b", "name" : "app_demo", "remark" : "Demo app", "id" : "356de8eb7a8742168586e5daf5339965", "app_secret" : "416b6b2a1d394111b9bc1df0e6842ab8", "register_time" : "2020-08-03T13:09:13Z", "status" : 1, "app_type" : "apig" }, { "bind_num" : 3, "creator" : "USER", "update_time" : "2020-05-27T10:38:03.133586Z", "app_key" : "840b8b5b1efc4ec686639759c2c584da", "name" : "app_001", "id" : "9ed8b7fe84224de681e7d7a5587e76dc", "app_secret" : "0a4e7035e81e424ab4c2c571980d5c6e", "register_time" : "2020-03-28T11:09:06Z", "status" : 1 } ] }
Código de estado: 400
Bad Request
{ "error_code" : "APIG.2011", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" }
Código de estado: 401
Unauthorized
{ "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" }
Código de estado: 403
Forbidden
{ "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" }
Código de estado: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Internal Server Error |
Códigos de error
Consulte Códigos de error.