Querying Configuration Details
Function
This API is used to query the configurations and configuration values of a tenant.
URI
Request Method |
URI |
---|---|
GET |
/v1.0/apigw/config/project[?page_size, page_no, config_id, config_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: config_name, config_id, page_size, and page_no.
The following table lists the parameters in the URI.
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
config_name |
No |
String |
Configuration name |
config_id |
No |
String |
Configuration ID |
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 configurations that match the query conditions |
size |
Integer |
Length of the returned configuration list |
configs |
Dictionary |
Configuration list |
Parameter |
Type |
Description |
---|---|---|
config_id |
String |
Configuration ID |
config_name |
String |
Configuration name |
config_value |
String |
Configuration value |
remark |
String |
Description of the configuration |
config_time |
Timestamp |
Time when the configuration is created |
Example response:
{ "total": 3, "size": 3, "configs": [ { "config_id": "1", "config_name": "API_NUM_LIMIT", "config_value": "300", "config_time": "2017-12-29T08: 00: 39.543642Z", "remark": "Maximum number of APIs a tenant can create" }, { "config_id": "2", "config_name": "APP_NUM_LIMIT", "config_value": "30", "config_time": "2017-12-29T03: 39: 03.165657Z", "remark": "Maximum number of apps a tenant can create" }, { "config_id": "3", "config_name": "APIGROUP_NUM_LIMIT", "config_value": "30", "config_time": "2017-12-29T03: 39: 03.165657Z", "remark": "Maximum number of API groups a tenant can create" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
500 |
Server Internal Error |
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot