查询资源分组列表 - ListResourceGroups
功能介绍
查询资源分组列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:resourceGroups:list
List
-
g:EnterpriseProjectId
- ces:resourceGroups:get
-
URI
GET /v2/{project_id}/resource-groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
归属企业项目ID |
|
group_name |
否 |
String |
资源分组名称，支持模糊查询 |
|
group_id |
否 |
String |
资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 |
|
offset |
否 |
Integer |
分页查询时查询的起始位置，表示从第几条数据开始，默认为0 |
|
limit |
否 |
Integer |
分页查询时每页的条目数，取值[1,100]，默认值为100 |
|
type |
否 |
String |
资源分组添加资源方式，取值只能为EPS（同步企业项目）,TAG（标签动态匹配）,Manual（手动添加），不传代表查询所有资源分组类型,COMB（智能添加-组合匹配）,NAME（资源名称模糊匹配） |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户Token |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
资源分组总数 |
|
resource_groups |
Array of OneResourceGroupResp objects |
资源分组列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group_name |
String |
资源分组的名称 |
|
group_id |
String |
资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 |
|
create_time |
String |
资源分组的创建时间 |
|
enterprise_project_id |
String |
资源分组归属企业项目ID |
|
type |
String |
资源添加/匹配方式，取值只能为EPS（匹配企业项目）,TAG（匹配标签）,NAME（匹配实例名称）, COMB（组合匹配）,Manual（手动添加） |
|
status |
String |
指标告警状态，取值为health（告警中）、unhealthy（已触发）、no_alarm_rule（未设置告警规则） |
|
event_status |
String |
事件告警状态，取值为health（告警中）、unhealthy（已触发）、no_alarm_rule（未设置告警规则） |
|
resource_statistics |
resource_statistics object |
资源数量统计信息 |
|
related_ep_ids |
Array of strings |
当资源匹配规则为匹配企业项目时，指定的企业项目列表 |
|
association_alarm_templates |
Array of AssociationAlarmTemplate objects |
关联的告警模板列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
unhealthy |
Integer |
告警中的资源数 |
|
total |
Integer |
资源总数 |
|
event_unhealthy |
Integer |
已触发的资源数 |
|
namespaces |
Integer |
资源类型数 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：403
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
请求异常内部业务状态码 |
|
error_msg |
String |
请求异常信息 |
|
request_id |
String |
请求ID |
请求示例
查询资源分组列表
/v2/{project_id}/resource-groups?offset=0&limit=100
响应示例
状态码：200
OK
{
"resource_groups" : [ {
"group_name" : "group1",
"create_time" : "2006-01-02T15:04:05.000Z",
"group_id" : "rg0123456789xxxx",
"enterprise_project_id" : "0",
"type" : "Manual"
}, {
"group_name" : "band",
"type" : "EPS",
"create_time" : "2006-01-02T15:04:05.000Z",
"group_id" : "rg0123456789xxxx",
"enterprise_project_id" : "d61d4705-5658-42f5-8e0c-70eb34d17b02"
}, {
"group_name" : "group2",
"type" : "TAG",
"create_time" : "2006-01-02T15:04:05.000Z",
"group_id" : "rg0123456789xxxx",
"enterprise_project_id" : "0"
} ],
"count" : 3
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
参数校验失败 |
|
401 |
未认证 |
|
403 |
认证鉴权失败 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
