Querying the List of Purchased APIs
Function
This API is used to query the list of purchased APIs.
URI
The following table lists the HTTP/HTTPS request method and URI of the API.
Request Method | URI |
---|---|
GET | /v1.0/apigw/purchases/apis[?page_size, page_no, api_id, api_name, group_id, group_name] |
- A combination of different query conditions can be added at the end of the URI by using question marks (?) and ampersands (&).
- Query conditions include: api_id, api_name, group_id, group_name, page_size, and page_no.
The following table lists the parameters in the URI.
Parameter | Mandatory | Type | Description |
---|---|---|---|
api_id | No | String | API ID |
api_name | No | String | API name |
group_id | No | String | API group ID |
group_name | No | String | API group name |
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. |
Request
N/A
Response
Parameter | Type | Description |
---|---|---|
total | Integer | Total number of APIs that match the query conditions |
size | Integer | Number of returned APIs |
apis | Dictionary | API list |
Parameter | Type | Description |
---|---|---|
id | String | API ID |
name | String | API name |
purchase_id | String | Subscription ID |
remark | String | Description of the API |
req_uri | String | Access address |
Example response:
{"total": 3,"size": 3,"apis": [{"id": "cb498965-8acf-4c98-bd08-4033ef1fcfb4","name": "Environment_list_query","purchase_id": "730f8a84-c8db-45ba-a6a5-2669ceb08574","remark": "Environment list query","req_uri": "/envs"},{"id": "5bbc47e2-95b0-4a56-904e-a3cdc422f8e9","name": "API_group_list_query","purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825","remark": "API group list query","req_uri": "/groups"},{"id": "6632a062-9dcf-4f18-9646-3cabb925a290","name": "API_list_query","purchase_id": "2ae11f50-3938-4560-8b76-58e89bb3f825","remark": "API list query","req_uri": "/apis"}]}
Status Codes
Status Code | Description |
---|---|
200 | OK |
400 | Bad Request |
401 | Unauthorized |
500 | Server Internal Error |
- Function
- URI
- Request
- Response
- Status Codes