文档首页/ 云运维中心 COC/ API参考/ API/ 应用资源管理/ 关联资源/ 查询分组关联的离线资源 - ListGroupOtherResourceRelations
更新时间：2025-12-05 GMT+08:00
查看PDF
分享

查询分组关联的离线资源 - ListGroupOtherResourceRelations

功能介绍

分组关联资源后，可查询分组相关的资源信息。

URI

GET /v1/group-resource-relations

表1 Query参数

参数

是否必选

参数类型

描述

application_id

否

String

参数解释：

分组关联的应用id。

约束限制：

应用id和分组id，组件id不能共存，且必填其中一个。

取值范围：

不涉及。

默认取值：

不涉及。

component_id

否

String

参数解释：

分组关联的组件id。

约束限制：

应用id和分组id，组件id不能共存，且必填其中一个。

取值范围：

不涉及。

默认取值：

不涉及。

group_id

否

String

参数解释：

分组id。

约束限制：

应用id和分组id，组件id不能共存，且必填其中一个。

取值范围：

不涉及。

默认取值：

不涉及。

vendor

是

String

参数解释：

厂商信息。

约束限制：

不涉及。

取值范围：

  • AWS：亚马逊。

  • AZURE：微软。

  • ALI：阿里云。

  • RMS：华为云。

  • CROSS_ACCOUNT：跨账号资源。

  • OTHER：其他厂商，例如：IDC离线资源。

默认取值：

不涉及。

type

是

String

参数解释：

资源类型。

约束限制：

不涉及。

取值范围：

资源类型，根据实际业务选择资源类型、常用资源类型如下：

  • cloudservers：弹性云服务器。

  • servers：裸金属服务器。

  • clusters：云容器引擎。

  • instances：云数据库。

默认取值：

不涉及。

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状态。

约束限制：

不涉及。

取值范围：

  • ONLINE：运行中。

  • OFFLINE：异常。

  • INSTALLING：安装中。

  • FAILED：安装失败。

  • UNINSTALLED：已卸载。

  • null：未安装。

默认取值：

不涉及。

image_name

否

String

参数解释：

镜像名称，模糊匹配。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

os_type

否

String

参数解释：

系统类型。

约束限制：

不涉及。

取值范围：

  • windows：windows操作系统类型。

  • linux：linux操作系统类型。

默认取值：

不涉及。

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

参数解释：

云服务器的计费类型。

约束限制：

不涉及。

取值范围：

计费模式：

  • 0：按需计费。

  • 1：包年包月。

  • 2：竞价计费。

默认取值：

不涉及。

flavor_name

否

String

参数解释：

规格名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

ip_list

否

Array of strings

参数解释：

ip列表。

约束限制：

不涉及。

取值范围：

列表，最大值100。

默认取值：

不涉及。

is_collected

否

Boolean

参数解释：

是否已收藏。

约束限制：

不涉及。

取值范围：

  • true：查询已收藏分组管理的资源关联。

  • false：查询未收藏分组管理的资源关联。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

data

Array of data objects

参数解释：

阿里云资源列表。

取值范围：

列表大小在0到500之间。
表3 data

参数

参数类型

描述

id

String

参数解释：

CMDB生成uuid。

取值范围：

不涉及。

domain_id

String

参数解释：

租户id。

取值范围：

字符串，长度32个字符。

cmdb_resource_id

String

参数解释：

CloudCMDB分配的资源uuid。

取值范围：

不涉及。

group_id

String

参数解释：

分组id。

取值范围：

字符串，长度24个字符。

group_name

String

参数解释：

分组名称。

取值范围：

字符串，长度3~60个字符。

resource_id

String

参数解释：

资源id。

取值范围：

字符串，长度36个字符。

name

String

参数解释：

资源名称。

取值范围：

字符串，长度3到50个字符串。

type

String

参数解释：

资源类型。

取值范围：

  • PM：物理机。

  • VM：虚拟机。

is_delegated

Boolean

参数解释：

是否已托管。

取值范围：

  • true：已经托管。

  • false：未托管。

region_id

String

参数解释：

区域id。

取值范围：

字符串，长度在0到64个字符之间。

inner_ip

String

参数解释：

资源内网ip。

取值范围：

不涉及。

zone_id

String

参数解释：

可用区id。

取值范围：

不涉及。

is_host

Boolean

参数解释：

是否为主机。

取值范围：

  • true：为主机。

  • false： 非主机。

agent_id

String

参数解释：

uniagent的id值。

取值范围：

不涉及。

agent_state

String

参数解释：

uniagent的状态。

取值范围：

  • ONLINE：运行中。

  • OFFLINE：异常。

  • INSTALLING：安装中。

  • FAILED：安装失败。

  • UNINSTALLED：已卸载。

  • null：未安装。

datasource

String

参数解释：

云厂商账户id。

取值范围：

字符串，长度在0到24个字符之间。

description

String

参数解释：

描述。

取值范围：

字符串，长度在1到256个字符之间。

properties

Map<String,Object>

参数解释：

属性信息。

取值范围：

不涉及。

ingest_properties

Map<String,Object>

参数解释：

数据采集属性，描述视图系统采集该资源时所记录的附加信息。

取值范围：

不涉及。

xrn

String

参数解释：

设备标识。

取值范围：

字符串，长度3到50个字符之间。

create_time

String

参数解释：

创建时间。

取值范围：

不涉及。

update_time

String

参数解释：

更新时间。

取值范围：

不涉及。

请求示例

查询分组关联的资源。

GET https://{endpoint}/v1/group-resource-relations?type=VM&limit=10&offset=0&application_id=660557b2dc48844adc49eaa5&is_collected=false&vendor=OTHER

响应示例

状态码：200

查询分组关联的资源成功。

{
  "data" : [ {
    "id" : "123e4567-e89b-12d3-a456-426614174000",
    "domain_id" : "00000000000000000000000000000000",
    "cmdb_resource_id" : "123e4567-e89b-12d3-a456-426614174001",
    "group_id" : "123e4567e89b12d3",
    "group_name" : "Example Group",
    "resource_id" : "123e4567-e89b-12d3-a456-426614174002",
    "name" : "Example Resource",
    "type" : "VM",
    "is_delegated" : true,
    "region_id" : "us-west-1",
    "inner_ip" : "x.x.x.x",
    "zone_id" : "us-west-1a",
    "is_host" : true,
    "agent_id" : "00000000000000000000000000000000",
    "agent_state" : "ONLINE",
    "datasource" : "123e4567",
    "description" : "This is an example resource.",
    "properties" : {
      "key1" : {
        "value" : "value1"
      },
      "key2" : {
        "value" : "value2"
      }
    },
    "ingest_properties" : {
      "ingest_key1" : {
        "ingest_value" : "ingest_value1"
      }
    },
    "xrn" : "xrn:example:resource",
    "create_time" : "2023-10-01T12:00:00Z",
    "update_time" : "2023-10-01T12:00:00Z"
  } ]
}

状态码

状态码

描述

200

查询分组关联的资源成功。

错误码

请参见错误码。

父主题： 关联资源