Updated on 2026-04-10 GMT+08:00

Obtaining a Configuration Group

Function

This API is used to obtain a created configuration group.

Authorization Information

Each account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned.

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • If you are using identity policy-based authorization, the permission listed below is required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    servicestage:config:listGroup

    list

    -

    -

    -

    -

URI

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

Table 1 Path parameter

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant's project ID. See Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 2 Query parameters

Parameter

Mandatory

Type

Description

name

No

String

Definition

Configuration group name.

Range

N/A

Default Value

N/A

limit

No

Integer

Definition

Number of records.

Constraints

N/A

Range

1~100

Default Value

10

offset

No

Integer

Definition

Offset.

Constraints

N/A

Range

N/A

Default Value

0

order_by

No

String

Definition

Sorting field.

Constraints

N/A

Range

Enumerated values:

  • create_time
  • name
  • update_time

Default Value

create_time

order

No

String

Definition

Sorting order.

Constraints

N/A

Range

  • desc: descending order
  • asc: ascending order

Default Value

desc

Request

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Definition

Message body type (or format).

Constraints

N/A

Range

application/json;charset=utf8

Default Value

N/A

X-Auth-Token

Yes

String

Definition

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.

Constraints

N/A

Range

N/A

Default Value

N/A

Response

Table 4 Response parameters

Parameter

Type

Description

count

Integer

Definition

Total number of configuration groups.

Range

N/A

config_groups

Array of objects

Definition

Group list. See Table 5.

Table 5 config_groups

Parameter

Type

Description

id

String

Definition

Configuration group ID.

Range

N/A

project_id

String

Definition

Project ID.

Range

N/A

name

String

Definition

Configuration group name.

Range

N/A

description

String

Definition

Configuration group description.

Range

N/A

creator

String

Definition

Creator.

Range

N/A

create_time

Integer

Definition

Creation time.

Range

N/A

enterprise_project_id

String

Definition

Enterprise project ID.

Range

N/A

labels

Array of objects

Definition

Label. You can use TMS to filter resources by labels. See Table 6.

Table 6 labels

Parameter

Type

Description

key

String

Definition

Label name.

Range

N/A

value

String

Definition

Label value.

Range

N/A

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
}

Status Code

Status Code

Description

200

OK

400

Bad Request

404

Not Found

500

Internal Server Error

Error Code

See ServiceStage Error Codes.