Querying the Configuration List
Function
This API is used to query the configuration list in the configuration center.
To avoid a long delay due to excessive data transmission, you are advised to carry the offset and limit query parameters when querying the configuration list.
URI
GET /v1/{project_id}/kie/kv
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Fixed value: default. |
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Authorization |
No |
String |
This parameter is mandatory if security authentication is enabled for an exclusive microservice engine. Otherwise, this parameter is not required. The token of an exclusive microservice engine with security authentication enabled is in the following format: Authorization:Bearer {Token} For details about how to obtain the token, see Obtaining the User Token of an Exclusive Microservice Engine. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
label |
No |
String |
Exports data filtered by label. The format is {Label key}:{Label value}. |
match |
No |
String |
Matching option of the filtered items. Value exact indicates exact matching, including the same number of labels. If the value is null, inclusive matching is used. |
revision |
No |
Integer |
Configuration version number This parameter is used to determine the difference between the local cache configuration and the configuration in the configuration center.
|
key |
No |
String |
Configuration key. |
value |
No |
String |
Configuration value. |
status |
No |
String |
Configuration status. |
offset |
No |
String |
Offset of the first record returned after the result is sorted by update_revision in descending order. |
limit |
No |
String |
Maximum number of returned records. Value range: [1,100]. |
Response
Status code: 200
Parameter |
Type |
Description |
---|---|---|
total |
Integer |
Total number of records before pagination using limit and offset. |
data |
List<SingleKieInfo> |
List of queried kie. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Configuration ID. |
key |
String |
Configuration key. |
value |
String |
Configuration value. |
value_type |
String |
Type of the configuration value. |
status |
String |
Configuration status. |
create_time |
String |
Time when the configuration is created. |
update_time |
String |
Time when the configuration is updated. |
labels |
Map<String,String> |
Configuration labels. |
create_revision |
Integer |
Created version number of the configuration. |
update_revision |
Integer |
Updated version number of the configuration. |
Status code: 304
None
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_message |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_message |
String |
Error message. |
Example Request
Query the configuration list.
GET https://{endpoint}/v1/{project_id}/kie/kv
Example Response
Status code: 200
{ "total": 1, "data":[{ "id": "8a9e6a5d-8d65-48fb-a40c-5150c8479da8", "key": "string", "labels": { "key1": "value1", "key2": "value2" }, "value": "string", "value_type": "text", "status": "enabled", "create_time": 1623139038, "update_time": 1623139038, "create_revision": 13, "update_revision": 13 }] }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
304 |
Not Modified |
400 |
Bad Request |
500 |
Internal Server Error |
Error Code
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