Querying an App List
Function
This API is used to query a list of apps that match specified conditions.
URI
The following table lists the HTTP/HTTPS request method and URI of the API.
| Request Method | URI |
|---|---|
| GET | /v1.0/apigw/apps[?page_size, page_no, id, name, app_key, creator] |
- A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
- Query conditions include: id, name, app_key, creator, page_size, and page_no.
The following table lists the parameters in the URI.
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| id | No | String | App ID |
| name | No | String | App name |
| status | No | Integer | App status |
| app_key | No | String | AppKey |
| creator | No | String | App creator, which can be:
|
| page_size | No | Integer | Number of records displayed on each page. The default value is 20. |
| page_no | No | Integer | Page number. The default value is 1. |
| precise_search | No | String | Parameter name (name) for exact matching |
Request
N/A
Response
| Parameter | Type | Description |
|---|---|---|
| total | Integer | Number of apps that match the query conditions |
| size | Integer | Length of the returned app list |
| apps | Dictionary | App list |
| Parameter | Type | Description |
|---|---|---|
| id | String | App ID |
| name | String | App name |
| status | Integer | App status |
| app_key | String | AppKey |
| app_secret | String | AppSecret |
| register_time | Timestamp | Time when the app is registered |
| remark | String | Description of the app |
| update_time | Timestamp | Time when the app was last updated |
| creator | String | App creator, which can be:
|
| app_type | String | App type. The default value is apig. |
| bind_num | Integer | Number of APIs to which the app has been bound |
{
"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
}]
} Status Codes
| Status Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 500 | Server Internal Error |
Last Article: Querying App Details
Next Article: Creating an AppCode
Did this article solve your problem?
Thank you for your score！Your feedback would help us improve the website.