通过标签查询资源数量 - CountV2ServicesByTags
功能介绍
该接口适用于需要统计和获取符合特定标签或资源名称条件的资源数量的场景,例如在资源管理和监控中,用户可以通过指定标签或资源名称进行精确或模糊查询来统计资源数量。通过调用此接口,用户可以基于多个标签或资源名称进行查询,若不传标签则返回所有资源的总数。用户必须具有足够的权限,且目标资源需存在。查询成功后,返回符合条件的资源总数;若失败,返回具体的错误信息。常见异常包括权限验证错误、资源不存在错误和参数验证错误。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
授权项
访问级别
资源类型(*为必须)
条件键
别名
依赖的授权项
modelarts::listResourcesByTag
List
-
g:TagKeys
modelarts:tag:list
-
URI
POST /v2/{project_id}/modelarts-service-v2/resource-instances/count
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制: 不涉及。 取值范围: 账号的项目ID。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| workspace_id | 否 | String | 参数解释: 工作空间ID,workspaceId将会被设置为null。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 参数解释: 消息体的类型(格式)。 约束限制: 不涉及。 取值范围: 默认取值: 不涉及。 |
| X-Auth-Token | 是 | String | 参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| matches | 否 | Array of TmsMatch objects | 参数解释: 匹配项,目前只支持资源名称的模糊匹配。 约束限制: 不涉及。 |
| tags | 否 | Array of CombineTmsTags objects | 参数解释: 标签匹配项,只支持多个标签与操作,不携带表示查询所有资源。 约束限制: 不涉及。 |
| without_any_tag | 否 | Boolean | 参数解释: 是否只查询没有打标签的资源。 约束限制: 不涉及。 取值范围: true:只查询没有打标签的资源。 false:查询所有资源。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释: 资源实例总数量。 取值范围: 不涉及 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: ModelArts错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 具体错误信息。 取值范围: 不涉及。 |
请求示例
通过标签resource_name反查资源列表,匹配资源名称中有resource1的资源,注:模糊匹配。
https://{endpoint}/v2/{project_id}/modelarts-service-v2/resource-instances/count
{
"matches" : [ {
"key" : "resource_name",
"value" : "service"
} ],
"tags" : [ {
"key" : "model_version",
"values" : [ "0.1", "0.2" ]
} ]
} 响应示例
状态码:200
参数解释:
标签查询资源总量返回体。
{
"total_count" : 10
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 参数解释: 标签查询资源总量返回体。 |
| 400 | 参数非法。 |
| 401 | 鉴权失败。 |
| 403 | 权限不足。 |
| 404 | 资源未找到。 |
错误码
请参见错误码。