获取配置分组
功能介绍
此API用于获取已经创建的配置分组。
URI
GET /v3/{project_id}/cas/config-groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
租户项目ID。获取方法，请参考获取项目ID。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
配置分组名称。 |
|
limit |
否 |
integer |
指定个数，取值[0, 100]。 |
|
offset |
否 |
integer |
指定偏移量。 |
|
order_by |
否 |
String |
排序字段，默认按创建时间排序。 排序字段支持枚举值：
|
|
order |
否 |
String |
排序方式。
|
请求消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
Content-Type |
是 |
String |
消息体的类型（格式），默认取值为“application/json;charset=utf8”。 |
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考认证鉴权。 |
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
配置分组总数。 |
|
config_groups |
Array of objects |
分组列表，请参考表5。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
配置分组ID。 |
|
project_id |
String |
项目ID。 |
|
name |
String |
配置分组名称。 |
|
description |
String |
配置分组描述。 |
|
creator |
String |
创建人。 |
|
create_time |
Integer |
创建时间。 |
|
enterprise_project_id |
String |
企业项目ID。 如果不配置此参数，则默认企业项目为“default”，ID为0。 |
|
labels |
Array of objects |
标签。可使用标签管理服务通过标签过滤资源，请参考表6。 |
请求示例
无
响应示例
{
"config_groups": [
{
"id": "3f10d752-80e9-4d80-ad74-454fd59e23a7",
"project_id": "b6097e34f6694a1fa2a49052acc9718d",
"name": "test-group",
"description": null,
"create_time": 1744698133769,
"creator": "ss-test",
"config_count": 0,
"labels": [],
"enterprise_project_id": "0",
"enterprise_project_name": "default"
}
],
"total": 1,
"count": 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
操作成功。 |
|
400 |
错误的请求。 |
|
404 |
请求对象不存在。 |
|
500 |
内部错误。 |
错误码
请参考ServiceStage错误码。
