按标签统计训练作业资源数量 - CountTrainingJobsByTags
功能介绍
按标签统计训练作业资源数量接口用于根据标签等条件查询当前项目下符合条件的训练作业总数。
该接口适用于以下场景:当用户需要按标签键值、资源名称等条件统计训练作业数量时,可以通过此接口进行查询。使用该接口的前提条件是用户已登录并具有查看训练作业标签的权限。查询操作完成后,平台将返回符合条件的训练作业总数。若用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v2/{project_id}/modelarts-training-job/resource-instances/count
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:1 - 64字符,字母、数字和中划线。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释:返回的数据条目数。 约束限制:不涉及。 取值范围:1 ~ 1000。 默认取值:1000。 |
| offset | 否 | Integer | 参数解释:偏移量,表示从第几条数据开始查询。 约束限制:不涉及。 取值范围:不小于0。 默认取值:0。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| tags | 否 | Array of tags objects | 参数解释:标签过滤条件,返回同时包含列表中所有标签的训练作业。 约束限制:标签个数不能超过系统允许的最大标签数。 取值范围:不涉及。 默认取值:不涉及。 |
| matches | 否 | Array of matches objects | 参数解释:模糊匹配条件,支持按资源名称等字段进行模糊查询。 约束限制:最多1个匹配条件。 取值范围:不涉及。 默认取值:不涉及。 |
| workspace_id | 否 | String | 参数解释:工作空间ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:0。 |
| without_any_tag | 否 | Boolean | 参数解释:是否查询不带任何标签的训练作业。 约束限制:不涉及。 取值范围:不涉及。 默认取值:false。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_count | Integer | 参数解释:符合条件的训练作业总数。 取值范围:不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_msg | String | 错误信息。 |
| error_code | String | 错误码。 |
| error_solution | String | 错误解决建议。 |
请求示例
如下以统计标签key为workspace且value为0的训练作业数量为例。
POST https://{endpoint}/v2/{project_id}/modelarts-training-job/resource-instances/count
{
"tags" : [ {
"key" : "workspace",
"values" : [ "0" ]
} ]
} 响应示例
状态码:200
按标签统计训练作业资源数量响应体
{
"total_count" : 100
} 状态码:400
通用错误应答消息体格式。
{
"error_msg" : "limit should be a num between 1~1000.",
"error_code" : "ModelArts.2755",
"error_solution" : "Check whether the request parameters are valid."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 按标签统计训练作业资源数量响应体 |
| 400 | 通用错误应答消息体格式。 |
错误码
请参见错误码。