查询用户资源总数
功能介绍
查询用户资源总数。
提供用户查询资源的能力,资源数据数量支持页面的条件过滤返回符合条件的数量。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/resources/count
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
provider |
是 |
String |
参数解释: 云服务名称 约束限制: 不涉及。 取值范围: 字符串,可选ecs,cce,rds等服务资源。 默认取值: 不涉及。 |
type |
是 |
String |
参数解释: 资源类型。 约束限制: 不涉及。 取值范围: 资源类型较多,根据实际业务选择资源类型、常用资源类型如下: 默认取值: 不涉及。 |
resource_id_list |
否 |
Array of strings |
参数解释: 资源id列表。 约束限制: 不涉及。 取值范围: 用户选择的资源id组成的集合。 默认取值: 不涉及。 |
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。 默认取值: 不涉及。 |
ep_id |
否 |
String |
参数解释: 企业项目id。 约束限制: 不涉及。 取值范围: 请选择企业管理中存在的项目ID。 默认取值: 不涉及。 |
is_delegated |
否 |
String |
参数解释: 是否已托管。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
is_collected |
否 |
Boolean |
参数解释: 是否已收藏。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
flavor_name |
否 |
String |
参数解释: 云资源规格名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
charging_mode |
否 |
String |
参数解释: 云服务器的计费类型。 约束限制: 不涉及。 取值范围: 计费模式: 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
任务跟踪的请求id号,格式为request_uuid-时间戳-主机名。 |
参数 |
参数类型 |
描述 |
---|---|---|
data |
Long |
参数解释: 云资源数量。 取值范围: 取值在0 到 65535之间。 |
状态码:400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
任务跟踪的请求id号,格式为request_uuid-时间戳-主机名。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
参数解释: 错误码。 取值范围: 字符串,长度8~36个字符之间。 |
error_msg |
String |
参数解释: 错误描述。 取值范围: 字符串,长度2~512个字符之间。 |
请求示例
查询用户资源总数。
GET https://{Endpoint}/v1/resources/count?type=clusters&provider=cce&is_collected=false
响应示例
状态码:200
查询资源总数成功。
{ "data" : 54 }
状态码
状态码 |
描述 |
---|---|
200 |
查询资源总数成功。 |
400 |
查询资源总数失败。 |
错误码
请参见错误码。