查询租户所有资源
功能介绍
查询租户所有资源：
查询租户所有资源等相关信息，便于租户详细了解资源总体情况。
请求参数provider（云服务名称），type（云资源类型），limit（查询条数）必填，单次最大查询条数：500。
返回信息包括：资源ID，资源名称，云服务名称，资源类型，项目ID，租户ID，区域ID，企业项目ID，资源标签，资源详细属性，资源ingest属性，uniagentID，uniagent状态，是否托管，是否可运维。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/resources
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
云资源名称。 |
|
ep_id |
否 |
String |
企业项目ID，租户设置。 |
|
project_id |
否 |
String |
项目ID。 获取方式请参考获取项目ID。 |
|
region_id |
否 |
String |
区域ID。 |
|
az_id |
否 |
String |
可用区ID。 |
|
ip_type |
否 |
String |
IP类型 fixed：内网IP floating：弹性公网IP |
|
ip |
否 |
String |
IPv4地址过滤结果，匹配规则为模糊匹配。此处IP为云资源IP。 |
|
ip_list |
否 |
Array of strings |
云资源IP列表，最大长度:100。 |
|
resource_id_list |
否 |
Array of strings |
云资源ID列表，最大长度:100。 |
|
provider |
是 |
String |
云服务名称。 |
|
status |
否 |
String |
云资源状态，枚举值见云资源状态。 |
|
agent_state |
否 |
String |
uniagent状态。 运行中。 异常。 安装中。 安装失败。 已卸载。 未安装。 |
|
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。 |
|
component_id |
否 |
String |
云资源下组件ID。 |
|
application_id |
否 |
String |
云资源下应用ID。 |
|
cce_cluster_id |
否 |
String |
cce集群ID，资源属于的cce的ID。 |
|
vpc_id |
否 |
String |
待创建云资源所属虚拟私有云（简称VPC），需要指定已创建VPC的ID，UUID格式。 |
|
is_delegated |
否 |
Boolean |
是否已托管。 |
|
operable |
否 |
String |
用户定义资源是否可运维实例。 enable：启用； 不存在当前字段：不启用。 |
|
is_collected |
否 |
Boolean |
是否已收藏。 |
|
flavor_name |
否 |
String |
云资源规格名称。 |
|
charging_mode |
否 |
String |
云服务器的计费类型： 0：按需计费 1：包年包月 2：竞价计费 |
|
type |
是 |
String |
资源类型名称，非空。 |
|
limit |
是 |
Integer |
最小返回数量:1，最大返回数量:500，非空。 |
|
marker |
否 |
String |
分页参数，通过上一个请求中返回的marker信息（云资源ID）作为输入，获取当前页。 |
请求参数
无
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
Array of data objects |
资源列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
CMDB分配的资源ID。 |
|
resource_id |
String |
云服务分配的资源ID。 |
|
name |
String |
资源名称。 |
|
ep_id |
String |
企业项目ID。 |
|
project_id |
String |
Openstack中的项目ID。 |
|
domain_id |
String |
租户ID。 |
|
provider |
String |
云服务名称。 |
|
type |
String |
资源类型。 |
|
region_id |
String |
region ID。 |
|
tags |
Array of Tag objects |
资源标签。 |
|
properties |
Map<String,Object> |
资源详细属性。 |
|
ingest_properties |
Map<String,Object> |
资源ingest属性。 |
|
agent_id |
String |
uniagent分配的ID。 |
|
agent_state |
String |
uniagent状态。 |
|
is_delegated |
Boolean |
是否已托管。 |
|
operable |
String |
用户定义资源是否可运维实例，enable：启用；不存在当前字段：不启用。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
分页查询用户ecs的资源信息
https://coc.myhuaweicloud.com/v1/resources?limit=10&type=cloudservers&provider=ecs响应示例
状态码：200
ECS资源信息。
{
"data" : [ {
"id" : "67dbfc5b38f2266b00bfbcce",
"resource_id" : "dc3334d0-12a7-4149-9445-4d9f50631b6d",
"name" : "COC-jumper项目使用误删",
"description" : "null",
"ep_id" : "0",
"project_id" : "6bd69b78b15b46c79814ba748415e643",
"domain_id" : "87ee79a270314bdb8b4749f3004e3685",
"provider" : "ecs",
"type" : "cloudservers",
"region_id" : "ap-southeast-1",
"tags" : [ {
"key" : "t1",
"value" : "t2"
} ],
"properties" : [ {
"accessIpv4" : "",
"hostName" : "coc-jumper",
"addresses" : [ {
"OsExtIpsType" : "fixed",
"OsExtIpsPortId" : "9f43a922-c983-4133-a491-54ba825cb724",
"addr" : "192.168.0.222",
"version" : 4,
"OsExtIpsMacAddr" : "fa:16:3e:9a:f2:d0",
"primary" : true
}, {
"OsExtIpsType" : "floating",
"OsExtIpsPortId" : "9f43a922-c983-4133-a491-54ba825cb724",
"addr" : "150.40.253.144",
"version" : 4,
"OsExtIpsMacAddr" : "fa:16:3e:9a:f2:d0",
"primary" : true
} ],
"accessIpv6" : "",
"metadata" : [ {
"chargingMode" : "0",
"meteringImageType" : "market",
"imageName" : "Windows Server 2022 数据中心版 64位 中文_40GB",
"meteringImageId" : "b51669dc-6277-4598-b892-aec7050e11d1",
"meteringResourcesPerCode" : "c6.xlarge.2.win",
"vpcId" : "dd9d50ce-a1d0-4b1e-acfa-10038ea8b0f2",
"osBit" : "64",
"osType" : "Windows"
} ],
"OsExtStsVmState" : "active",
"configDrive" : "",
"OsExtStsPowerState" : 1,
"hostId" : "e7d72632bbf648fe80ef364661f263c2599b9449c12cd077b02dd547"
} ],
"ingest_properties" : null,
"agent_id" : null,
"agent_state" : null,
"is_delegated" : null,
"operable" : null,
"create_time" : "2025-03-20T11:30:33.000+00:00",
"update_time" : "2025-03-31T16:51:33.000+00:00"
} ]
}状态码：400
包含错误信息
{
"error_code" : "COC.00101004",
"error_msg" : "limit exceeds the maximum."
}状态码
|
状态码 |
描述 |
|---|---|
|
200 |
ECS资源信息。 |
|
400 |
包含错误信息 |
错误码
请参见错误码。
