Obtaining a Configuration Group

Function

This API is used to obtain a created configuration group.

URI

GET /v3/{project_id}/cas/config-groups

**Table 1** Path parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Tenant's project ID. See Obtaining a Project ID.

**Table 2** Query parameters
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: create_time name update_time
order	No	String	Sorting order. desc (default) asc

Request

**Table 3** Request header parameters
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

**Table 4** Response parameters
Parameter	Type	Description
count	Integer	Total number of configuration groups.
config_groups	Array of objects	Group list. See Table 5.

**Table 5** config_groups
Parameter	Type	Description
id	String	Configuration group ID.
project_id	String	Project ID.
name	String	Configuration group name.
description	String	Configuration group description.
creator	String	Creator.
create_time	Integer	Creation time.
enterprise_project_id	String	Enterprise project ID.
labels	Array of objects	Label. You can use TMS to filter resources by labels. See Table 6.

**Table 6** labels
Parameter	Type	Description
key	String	Label name.
value	String	Label value.

Example Request

None

Example Response

{
	"config_groups": [
		{
			"id": "3f10d752-80e9-4d80-ad74-454fd59e23a7",
			"project_id": "b6097e34f6694a1fa2a49052acc9718d",
			"name": "test-group",
			"description": null,
			"create_time": 1744698133769,
			"creator": "ss-test",
			"labels": [],
			"enterprise_project_id": "0"
		}
	],
	"count": 1
}