文档首页/ 数智融合计算服务/ API参考/ API/ fabric-admin/ TMS管理/ 查询资源实例数量
更新时间：2024-12-20 GMT+08:00
查看PDF
分享

查询资源实例数量

功能介绍

查询资源实例数量。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST https://localhost.com/v1/{project_id}/fabric-workspace/resource-instances/count

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

  • 参数解释：项目ID。获取方法，请参见获取项目ID。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

  • 参数解释：租户Token。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

without_any_tag

否

Boolean

不包含任意一个标签，该字段为true时查询所有不带标签的资源，此时忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。

tags

否

Array of ResourceTagParam objects

包含标签，最多包含50个key，每个key下面的value最多10个，每个key对应的value可以为空数组但结构体不能缺失。

matches

否

Array of TagMatch objects

搜索字段，key为要匹配的字段，如resource_name等。value为匹配的值。

sys_tags

否

Array of SystemTagParam objects

系统标签列表，目前只包含一个tag结构体。key下面只包含一个value。
表4 ResourceTagParam

参数

是否必选

参数类型

描述

key

是

String

  • 参数解释：资源标签的键。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

values

否

Array of strings

  • 参数解释：资源标签的值列表。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表5 TagMatch

参数

是否必选

参数类型

描述

key

是

String

  • 参数解释：键；第一期限定为resource_name，后续扩展。

  • 约束限制：不涉及。

  • 取值范围：resource_name。

  • 默认取值：resource_name。

value

否

String

  • 参数解释：资源标签的值。

  • 约束限制：不涉及。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表6 SystemTagParam

参数

是否必选

参数类型

描述

key

是

String

  • 参数解释：键。

  • 约束限制：固定值。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

values

是

Array of strings

系统标签的值列表。

响应参数

状态码： 200

表7 响应Header参数

参数

参数类型

描述

X-request-id

String

  • 参数解释：请求ID，定位辅助信息。

  • 约束限制：不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。
表8 响应Body参数

参数

参数类型

描述

total_count

Integer

实例总数。

状态码： 400

表9 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 401

表10 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 404

表11 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 408

表12 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

状态码： 500

表13 响应Body参数

参数

参数类型

描述

error_code

String

  • 参数解释：错误码。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

error_msg

String

  • 参数解释：错误描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

solution_msg

String

  • 参数解释：解决方案描述。

  • 约束限制：该值不可修改。

  • 取值范围：不涉及。

  • 默认取值：不涉及。

请求示例

无

响应示例

无

状态码

状态码

描述

200

查询资源实例数量响应体。

400

Bad request error。

401

Unauthorized error。

403

Forbidden error。

404

Not found error。

408

Request timeout error。

500

Internal error。

错误码

请参见错误码。

父主题： TMS管理

相关文档