Obtaining a Configuration Group
Function
This API is used to obtain a created configuration group.
URI
GET /v3/{project_id}/cas/config-groups
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Tenant's project ID. See Obtaining a Project ID. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
No |
String |
Configuration group name. |
limit |
No |
integer |
Number of records to be queried. Value range: 0–100. |
offset |
No |
integer |
Offset. |
order_by |
No |
String |
Sorting field. By default, query results are sorted by creation time. Enumerated values:
|
order |
No |
String |
Sorting order.
|
Request
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
Content-Type |
Yes |
String |
Message body type (format). Default value: application/json;charset=utf8. |
X-Auth-Token |
Yes |
String |
API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token. For details about how to obtain the token, see Authentication. |
Response
Parameter |
Type |
Description |
---|---|---|
count |
Integer |
Total number of configuration groups. |
config_groups |
Array of objects |
Group list. See Table 5. |
Example Request
None
Example Response
{ "config_groups": [{ "id": "0f5722ea-ee97-42bf-8583-404caa0a46e5", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "name": "test1", "description": "", "create_time": 1717482692680, "creator": "ss-test" }, { "id": "49cb9636-9f89-44c3-af68-95282887b377", "project_id": "2cfeefc3e4c54a5aa7548b8350e638d7", "name": "test2", "description": "", "create_time": 1717481328004, "creator": "ss-test" }], "count": 2 }
Status Code
Status Code |
Description |
---|---|
200 |
OK |
400 |
Bad Request |
404 |
Not Found |
500 |
Internal Server Error |
Error Code
The error code format is SVCSTG.00100.[Error_ID], for example, SVCSTG.00100400. For details, see ServiceStage Error Codes.
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