查询用户所有资源 - ListResources
功能介绍
查询租户所有资源:
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
coc:instance:listResources
List
-
-
-
-
URI
GET /v1/resources
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
provider |
是 |
String |
参数解释: 云服务名称 约束限制:
取值范围: 只能由中文字符、英文字母、数字及“_”、“-”、“.”组成,且长度为[1-128]个英文字符或[1-64]个中文字符。 默认取值: 不涉及。 |
|
type |
是 |
String |
参数解释: 资源类型。 约束限制: 不涉及。 取值范围: 资源类型较多,根据实际业务选择资源类型、常用资源类型如下: 默认取值: 不涉及。 |
|
limit |
是 |
Integer |
参数解释: 分页查询每页显示的条目数量。 约束限制: 不涉及。 取值范围: 自定义,在1-500范围。 默认取值: 不涉及。 |
|
marker |
否 |
String |
参数解释: 用于分页查询。 约束限制: 不涉及。 取值范围: 分页参数,通过上一个请求中返回的marker信息作为输入,获取当前页。 默认取值: 不涉及。 |
|
resource_id_list |
否 |
Array of strings |
参数解释: 资源id列表。 约束限制: 不涉及。 取值范围: 资源id列表,最大值100。 默认取值: 不涉及。 |
|
ip_list |
否 |
Array of strings |
参数解释: ip列表。 约束限制: 不涉及。 取值范围: 列表,最大值100。 默认取值: 不涉及。 |
|
name |
否 |
String |
参数解释: 云资源名称。 约束限制: 不涉及。 取值范围: 字符串,可参考:裸金属服务器BMS。 默认取值: 不涉及。 |
|
region_id |
否 |
String |
参数解释: 区域id。 约束限制: 不涉及。 取值范围: 关联的区域region的id。 默认取值: 不涉及。 |
|
az_id |
否 |
String |
参数解释: 可用区id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
ip_type |
否 |
String |
参数解释: 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)、下划线()、中划线(-)、小数点(.)以及中文字符。 默认取值: 不涉及。 |
|
tag_key |
否 |
String |
参数解释: 云资源的标签key。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
group_id |
否 |
String |
参数解释: 云资源下的分组ID。 约束限制: 传分组id,就查询分组下的资源数量。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
component_id |
否 |
String |
参数解释: 云资源下组件ID。 约束限制: 传组件id,就查询组件下的资源数量。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
application_id |
否 |
String |
参数解释: 云资源下应用ID。 约束限制: 传应用id,就查询应用下的资源数量。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
cce_cluster_id |
否 |
String |
参数解释: cce集群ID。 约束限制: 不涉及。 取值范围: 资源属于的cce的ID。 默认取值: 不涉及。 |
|
vpc_id |
否 |
String |
参数解释: 待创建云资源所属虚拟私有云(简称VPC),需要指定已创建VPC的ID,UUID格式。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
ep_id |
否 |
String |
参数解释: 企业项目id。 约束限制: 不涉及。 取值范围: 请选择企业管理中存在的项目ID。 默认取值: 不涉及。 |
|
is_delegated |
否 |
Boolean |
参数解释: 是否已托管。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
project_id |
否 |
String |
参数解释: 项目id。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
is_collected |
否 |
Boolean |
参数解释: 是否已收藏。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
flavor_name |
否 |
String |
参数解释: 云资源规格名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
charging_mode |
否 |
String |
参数解释: 云服务器的计费类型。 约束限制: 不涉及。 取值范围: 计费模式: 默认取值: 不涉及。 |
|
offset |
否 |
String |
参数解释: 分页查询偏移量,表示从此偏移量开始查询。 约束限制: 不涉及。 取值范围: 0-2147483647。 默认取值: 0。 |
|
show_associated_groups |
否 |
String |
参数解释: 显示关联应用。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
operable |
否 |
String |
参数解释: 用户定义资源是否可运维实例。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
|
create_since |
否 |
String |
参数解释: 创建时间中的开始日期,参考ISO8601标准格式。 约束限制: 开始日期和结束日期,至少有一个日期存在。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
create_until |
否 |
String |
参数解释: 创建时间中的结束日期,参考ISO8601标准格式。 约束限制: 开始日期和结束日期,至少有一个日期存在。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
参数解释: 用于任务跟踪的请求ID号。 取值范围: request_uuid-时间戳-主机名。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of data objects |
参数解释: 资源列表。 取值范围: 大小在0到500之间。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
参数解释: CMDB分配的资源ID。 取值范围: 不涉及。 |
|
resource_id |
String |
参数解释: 云服务分配的资源ID。 取值范围: 字符串,长度在36个字符。 |
|
domain_id |
String |
参数解释: 租户id。 取值范围: 不涉及。 |
|
name |
String |
参数解释: 资源名称。 取值范围: 字符串,长度3到50个字符之间。 |
|
provider |
String |
参数解释: 云服务名称。 取值范围: 字符串,长度1到64个字符之间。 |
|
type |
String |
参数解释: 资源类型。 取值范围: 资源类型较多,根据实际业务选择资源类型、常用资源类型如下: |
|
project_id |
String |
参数解释: Openstack中的项目ID。 取值范围: 字符串,长度32个字符。 |
|
project_name |
String |
参数解释: region的子项目名称。 取值范围: 字符串,不超过255个字符。 |
|
region_id |
String |
参数解释: 区域id。 取值范围: 字符串,长度0到64个字符。 |
|
ep_id |
String |
参数解释: 企业项目ID。 取值范围: 请选择企业管理中存在的项目ID。 |
|
ep_name |
String |
参数解释: 企业项目名称。 取值范围: 由中文、英文字母、数字、下划线、中划线组成,且不能使用任何大小写形式的“default”,不超过255个字符。 |
|
tags |
Object |
参数解释: 资源标签。 取值范围: 不涉及。 |
|
agent_id |
String |
参数解释: uniagent的id值。 取值范围: 不涉及。 |
|
agent_state |
String |
参数解释: uniagent的状态。 取值范围: |
|
properties |
Object |
参数解释: 资源详细属性。 取值范围: 不涉及。 |
|
ingest_properties |
Map<String,String> |
参数解释: 采集属性。 取值范围: 不涉及。 |
|
is_delegated |
Boolean |
参数解释: 是否已托管。 取值范围: |
|
inner_ip |
String |
参数解释: 资源内网ip。 取值范围: 不涉及。 |
|
operable |
Boolean |
参数解释: 用户定义资源是否可运维实例。 取值范围: |
|
is_associate_group |
Boolean |
参数解释: 是否已被指定分组关联。 取值范围: |
|
associated_group_list |
Array of strings |
参数解释: 资源所关联的分组信息组成的列表。 取值范围: 不涉及。 |
|
create_time |
String |
参数解释: 创建时间,参考ISO8601标准格式。 取值范围: 不涉及。 |
|
update_time |
String |
参数解释: 修改时间,参考ISO8601标准格式。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释: 标签的key。 取值范围: 标签的键允许包含任意语种字母、数字、空格和_ . : = + - @特殊字符,但首尾不能含有空格,不能以_sys_开头,限制长度最长128个字符。 |
|
value |
String |
参数解释: 标签的value。 取值范围: 标签的值允许包含任意语种字母、数字、空格和_ . : / = + - @特殊字符,但首尾不能含有空格,限制长度最长255个字符。 |
状态码:400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
X-request-id |
String |
参数解释: 用于任务跟踪的请求ID号。 取值范围: request_uuid-时间戳-主机名。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释: 错误码。 取值范围: 字符串,长度8~36个字符之间。 |
|
error_msg |
String |
参数解释: 错误描述。 取值范围: 字符串,长度2~512个字符之间。 |
请求示例
查询租户所有资源。
GET https://{Endpoint}/v1/resources?limit=10&offset=0&type=cloudservers&provider=ecs&is_collected=true
响应示例
状态码:200
查询用户所有资源成功。
{
"data" : [ {
"id" : "6891f55f1c083f512c6b222c",
"resource_id" : "37b64b7c-cdc9-4c2b-8f34-b8fa450bfbd2",
"name" : "auto-script-runbook-0005-0003",
"ep_id" : "0",
"ep_name" : "default",
"project_id" : "10a6c23c2a1044779794798beb067c94",
"project_name" : "testregion",
"domain_id" : "dc2d76541f754d68a4c8d150262d92c2",
"provider" : "ecs",
"type" : "cloudservers",
"region_id" : "testregion",
"tags" : [ {
"key" : "_sys_type_hcss_x",
"value" : ""
} ],
"properties" : {
"accessIpv4" : "",
"hostName" : "auto-script-runbook-0005-0003",
"addresses" : [ {
"OsExtIpsType" : "fixed",
"OsExtIpsPortId" : "05f5d9db-bb16-404a-a2a5-a5969942f330",
"addr" : "192.168.3.104",
"version" : 4,
"OsExtIpsMacAddr" : "fa:16:3e:a3:fe:63",
"primary" : true
} ],
"accessIpv6" : "",
"metadata" : {
"chargingMode" : "0",
"meteringImageType" : "gold",
"imageName" : "CentOS 7.5 64bit",
"meteringImageId" : "e0adce3a-a4d2-4207-9018-69ce64b4426a",
"meteringResourcesPerCode" : "x1.1u.1g.linux",
"vpcId" : "7a7087df-cca1-4fab-9aae-c2105a1a49fb",
"osBit" : "64",
"osType" : "Linux"
},
"OsExtStsVmState" : "active",
"configDrive" : "",
"OsExtStsPowerState" : 1,
"hostId" : "52db359758486a662c841d888b49d0d0a184208e497e2a0eb0f065f7",
"securityGroup" : [ {
"name" : "default",
"id" : "9e262f72-2f9a-4534-8a56-412710913895"
} ],
"ExtVolumesAttached" : [ {
"bootIndex" : "0",
"id" : "3bd6d353-979e-43d8-8936-ce2e246d79fd",
"device" : "/dev/vda"
} ],
"userId" : "a0ea25cd3a7549208e93971d80424481",
"flavor" : {
"disk" : "0",
"name" : "x1.1u.1g",
"id" : "x1.1u.1g",
"vcpus" : "1",
"ram" : "1024"
},
"osextsrvattr" : {
"hostName" : "auto-script-runbook-0005-0003",
"kernelId" : "",
"ramdiskId" : "",
"reservationId" : "r-hnvhg2wd",
"instanceName" : "instance-013ea14f",
"host" : "52db359758486a662c841d888b49d0d0a184208e497e2a0eb0f065f7",
"rootDeviceName" : "/dev/vda",
"hypervisorHostName" : "52db359758486a662c841d888b49d0d0a184208e497e2a0eb0f065f7",
"launchIndex" : 0
},
"OsDcfDiskConfig" : "MANUAL",
"hostStatus" : "UP",
"OsSrvUsgLaunchedAt" : "2025-08-05T07:14:07.000000",
"OsExtAz" : "test11",
"progress" : 0,
"locked" : false,
"status" : "ACTIVE",
"schedulerHints" : { }
},
"ingest_properties" : null,
"agent_id" : "9cf256e04bbe49f89593cfb66a3b5956",
"agent_state" : "ONLINE",
"inner_ip" : "192.168.3.104",
"is_delegated" : null,
"operable" : null,
"is_associate_group" : null,
"associated_group_list" : null,
"create_time" : "2025-08-05T07:13:55.000+00:00",
"update_time" : "2025-08-05T08:04:05.000+00:00"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询用户所有资源成功。 |
|
400 |
查询用户所有资源失败。 |
错误码
请参见错误码。