查询分组关联的资源 - ListGroupRmsResourceRelations
功能介绍
分组关联资源后,可查询分组相关的资源信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
coc:application:listResources
List
application *
-
-
-
-
coc:ApplicationGroupCode
URI
GET /v1/group-resource-relations
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
application_id |
否 |
String |
参数解释: 分组关联的应用id。 约束限制: 应用id和分组id,组件id不能共存,且必填其中一个。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
component_id |
否 |
String |
参数解释: 分组关联的组件id。 约束限制: 应用id和分组id,组件id不能共存,且必填其中一个。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
group_id |
否 |
String |
参数解释: 分组id。 约束限制: 应用id和分组id,组件id不能共存,且必填其中一个。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
provider |
是 |
String |
参数解释: 云服务名称。 约束限制: 不涉及。 取值范围: 字符串,可选ecs,cce,rds等服务资源。 默认取值: 不涉及。 |
|
vendor |
是 |
String |
参数解释: 厂商信息。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
type |
是 |
String |
参数解释: 资源类型。 约束限制: 不涉及。 取值范围: 资源类型,根据实际业务选择资源类型、常用资源类型如下: 默认取值: 不涉及。 |
|
limit |
是 |
Integer |
参数解释: 分页查询每页显示的条目数量。 约束限制: 不涉及。 取值范围: 自定义,在1-500范围。 默认取值: 不涉及。 |
|
offset |
否 |
String |
参数解释: 分页查询偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 0-2147483647。 默认取值: 0。 |
|
marker |
否 |
String |
参数解释: 分页参数,上一页请求最后一个id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
resource_id_list |
否 |
Array of strings |
参数解释: 资源id列表。 约束限制: 不涉及。 取值范围: 资源id列表,最大值100。 默认取值: 不涉及。 |
|
name |
否 |
String |
参数解释: 云资源名称。 约束限制: 不涉及。 取值范围: 自定义,可参考:裸金属服务器BMS。 默认取值: 不涉及。 |
|
region_id |
否 |
String |
参数解释: 区域id列表。 约束限制: 不涉及。 取值范围: 区域id列表,最大值100。 默认取值: 不涉及。 |
|
az_id |
否 |
String |
参数解释: 可用区id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
ip_type |
否 |
String |
参数解释: ip类型。 约束限制: 不涉及。 取值范围: fixed:内网IP。 floating:弹性公网IP。 默认取值: 不涉及。 |
|
ip |
否 |
String |
参数解释: 云资源IP。 约束限制: 不涉及。 取值范围: IPv4地址过滤结果,匹配规则为模糊匹配。 默认取值: 不涉及。 |
|
status |
否 |
String |
参数解释: 云资源状态。 约束限制: 不涉及。 取值范围: 请选择弹性云服务器 ECS中存在的云服务器状态。 默认取值: 不涉及。 |
|
agent_state |
否 |
String |
参数解释: agent状态。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
image_name |
否 |
String |
参数解释: 镜像名称,模糊匹配。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
os_type |
否 |
String |
参数解释: 系统类型。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
tag |
否 |
String |
参数解释: 云资源的标签。 约束限制: 标签的格式为“key.value”。其中,key的长度不超过36个字符,value的长度不超过43个字符。 取值范围: 标签命名时,需满足如下要求:标签的key值只能包含大写字母(A~Z)、小写字母(a~z)、数字(0-9)、下划线()、中划线(-)以及中文字符。 标签的value值只能包含大写字母(A~Z)、小写字母(a~z)、数字(0-9)、下划线()、中划线(-)、小数点(.)以及中文字符。 默认取值: 不涉及。 |
|
charging_mode |
否 |
String |
参数解释: 云服务器的计费类型。 约束限制: 不涉及。 取值范围: 计费模式: 默认取值: 不涉及。 |
|
flavor_name |
否 |
String |
参数解释: 规格名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
ip_list |
否 |
Array of strings |
参数解释: ip列表。 约束限制: 不涉及。 取值范围: 列表,最大值100。 默认取值: 不涉及。 |
|
is_collected |
否 |
Boolean |
参数解释: 是否已收藏。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
查询分组关联的资源成功。
无
请求示例
查询分组关联的资源。
GET https://{endpoint}/v1/group-resource-relations?provider=cce&type=clusters&limit=10&offset=0&application_id=660557b2dc48844adc49eaa5&is_collected=false&vendor=RMS
响应示例
状态码:200
查询分组关联的资源成功。
{
"data" : [ {
"id" : "687740684dbc6000ac47f0af",
"cmdb_resource_id" : "687733804dbc6000ac3eaf51",
"group_id" : "66055804dc48844adc49eaae",
"group_name" : "RMSaUTODDD",
"resource_id" : "38fbefc2-5c76-11f0-8a3e-0255ac100b06",
"name" : "cdr-test",
"provider" : "cce",
"type" : "clusters",
"region_id" : "string",
"ep_id" : "0",
"ep_name" : null,
"project_id" : "23a154c6e0be4cd282538462825fca67",
"domain_id" : "adabd970539e4ebb8141ca2cf3b571f1",
"tags" : null,
"agent_id" : null,
"agent_state" : null,
"inner_ip" : null,
"properties" : {
"clusterEOSVersion" : "false",
"clusterType" : "VirtualMachine",
"clusterSubnetId" : "22b498de-32fa-46e8-abf4-2be88693f114",
"clusterEIP" : "",
"clusterChargeMode" : "0",
"clusterVpcId" : "b6e5c685-d16a-4534-a023-bd67049f5cdd",
"clusterFlavor" : "cce.s2.small",
"clusterSecGroup" : "99000d1a-2f08-419a-a1d7-c02eb6c3b945",
"clusterOldestVersion" : "false",
"clusterVersion" : "v1.30.10-r10",
"clusterStatus" : "Available"
},
"ingest_properties" : null,
"operable" : null,
"create_time" : "2025-07-09T03:38:48.000+00:00"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询分组关联的资源成功。 |
错误码
请参见错误码。