链接复制成功!
查询租户所有资源
功能介绍
查询租户所有资源:
查询租户所有资源等相关信息,便于租户详细了解资源总体情况。
请求参数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。 取值范围: 不涉及。 默认值: 不涉及。 |
region_id |
否 |
String |
区域ID。 |
az_id |
否 |
String |
可用区ID。 |
ip_type |
否 |
String |
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个字符。 标签命名时,需满足如下要求:
|
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 |
用户定义资源是否可运维实例。
|
is_collected |
否 |
Boolean |
是否已收藏。 |
flavor_name |
否 |
String |
云资源规格名称。 |
charging_mode |
否 |
String |
云服务器的计费类型。 取值范围:
|
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 |
用户定义资源是否可运维实例。
|
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。最小长度:8,最大长度:36。 |
error_msg |
String |
错误描述,最小长度:2,最大长度:512。 |
请求示例
无
响应示例
无
错误码
请参见错误码。