更新时间:2026-02-28 GMT+08:00
分享

获取配置分组 - ObtainConfigurationGroup

功能介绍

此API用于获取已经创建的配置分组。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    servicestage:config:listGroup

    list

    -

    -

    -

    -

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

租户项目ID。获取方法,请参考获取项目ID

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

表2 查询参数

参数

是否必选

参数类型

描述

name

String

参数解释:

配置分组名称。

取值范围:

不涉及

默认取值:

不涉及

limit

Integer

参数解释:

指定个数。

约束限制:

不涉及

取值范围:

1~100

默认取值:

10

offset

Integer

参数解释:

指定偏移量。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

0

order_by

String

参数解释:

排序字段。

约束限制:

不涉及

取值范围:

排序字段支持枚举值:

  • create_time:配置分组创建时间。
  • name:配置分组名称。
  • update_time:配置分组修改时间。

默认取值:

create_time

order

String

参数解释:

排序方式。

约束限制:

不涉及

取值范围:

  • desc:降序排序。
  • asc:升序排序。

默认取值:

desc

请求消息

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

参数解释:

消息体的类型(格式)。

约束限制:

不涉及

取值范围:

application/json;charset=utf8

默认取值:

不涉及

X-Auth-Token

String

参数解释:

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值。Token获取方式,请参考认证鉴权

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应消息

表4 响应参数

参数

参数类型

描述

count

Integer

参数解释:

配置分组总数。

取值范围:

不涉及

config_groups

Array of objects

参数解释:

分组列表,请参考表5

表5 config_groups

参数

参数类型

描述

id

String

参数解释:

配置分组ID。

取值范围:

不涉及

project_id

String

参数解释:

项目ID。

取值范围:

不涉及

name

String

参数解释:

配置分组名称。

取值范围:

不涉及

description

String

参数解释:

配置分组描述。

取值范围:

不涉及

creator

String

参数解释:

创建人。

取值范围:

不涉及

create_time

Integer

参数解释:

创建时间。

取值范围:

不涉及

enterprise_project_id

String

参数解释:

企业项目ID。

取值范围:

不涉及

labels

Array of objects

参数解释:

标签。可使用标签管理服务通过标签过滤资源,请参考表6

表6 labels

参数

参数类型

描述

key

String

参数解释:

标签名称。

取值范围:

不涉及

value

String

参数解释:

标签值。

取值范围:

不涉及

请求示例

响应示例

{
	"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
}

状态码

状态码

描述

200

操作成功。

400

错误的请求。

404

请求对象不存在。

500

内部错误。

错误码

请参考ServiceStage错误码

相关文档