查询资源分组下指定服务类别特定维度的资源列表 - ListResourceGroupsServicesResources
功能介绍
查询资源分组下指定服务类别特定维度的资源列表
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
ces:resourceGroups:getServiceResources
Read
-
g:EnterpriseProjectId
- ces:resourceGroups:get
-
URI
GET /v2/{project_id}/resource-groups/{group_id}/services/{service}/resources
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID |
|
group_id |
是 |
String |
资源分组ID，以rg开头，后跟22位由字母或数字组成的字符串 |
|
service |
是 |
String |
服务类别，如SYS.ECS |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
dim_name |
否 |
String |
资源维度信息，多个维度按字母序使用逗号分隔 |
|
limit |
否 |
String |
分页查询时每页的条目数，取值[1,100]，默认值为100 |
|
offset |
否 |
Integer |
分页查询时查询的起始位置，表示从第几条数据开始，默认为0 |
|
status |
否 |
String |
按状态信息进行过滤，取值只能为health（已设置告警规则且无告警触发的资源）、unhealthy（已设置告警规则且有告警触发的资源）、no_alarm_rule（未设置告警规则的资源） |
|
dim_value |
否 |
String |
资源维度值，不支持模糊匹配，但是多维度资源可以只指定一个维度值 |
|
tag |
否 |
String |
资源的标签信息，格式："[key]":"[value]"，样例参考："ssss":"1111" |
|
extend_relation_id |
否 |
String |
企业项目ID |
|
product_name |
否 |
String |
资源分组的云产品，一般由"服务命名空间,服务首层维度名称"组成，如"SYS.ECS,instance_id" |
|
resource_name |
否 |
String |
资源名称 |
|
event_status |
否 |
String |
按事件告警状态信息进行过滤，取值只能为health（已设置事件告警规则且无事件告警触发的资源）、unhealthy（已设置事件告警规则且有事件告警触发的资源）、no_alarm_rule（未设置事件告警规则的资源） |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
租户Token |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
count |
Integer |
资源总数 |
|
resources |
Array of GetResourceGroupResources objects |
资源分组资源列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
指标告警状态，取值为health（告警中）、unhealthy（已触发）、no_alarm_rule（未设置告警规则） |
|
dimensions |
Array of ResourceDimension objects |
资源的维度信息 |
|
tags |
String |
资源的tag信息,格式为key/value的json字符串,样例为"{"sss":"aaa"}" |
|
enterprise_project_id |
String |
企业项目ID |
|
event_status |
String |
事件告警状态，取值为health（告警中）、unhealthy（已触发）、no_alarm_rule（未设置告警规则） |
|
resource_name |
String |
资源名称 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
name |
String |
参数解释 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的指标维度名称可查看：“服务指标维度”。 约束限制 不涉及 取值范围 由字母开头，后面可以包含字母、数字、_或-，长度为[1,32]个字符 默认取值 不涉及 |
|
value |
String |
参数解释 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 约束限制 不涉及 取值范围 长度为[1,256]个字符 默认取值 不涉及 |
状态码：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 |
状态码：404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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/{group_id}/services/{service}/resources'
响应示例
状态码：200
OK
{
"count" : 1000,
"resources" : [ {
"status" : "health",
"dimensions" : [ {
"name" : "instance_id",
"value" : "4270ff17-aba3-4138-89fa-820594c39755"
} ]
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
参数校验失败 |
|
401 |
未认证 |
|
403 |
认证鉴权失败 |
|
404 |
资源不存在 |
|
500 |
系统内部错误 |
错误码
请参见错误码。
