查询项目下训练作业标签列表 - ListTrainingJobTags
功能介绍
查询项目下训练作业标签列表接口用于获取指定项目下所有训练作业已使用的标签集合,按标签key聚合,每个key下包含所有不同的value。
该接口适用于以下场景:当用户需要了解项目下训练作业已使用的所有标签键值对,以便进行标签筛选、资源分类或管理时,可以通过此接口获取标签列表。使用该接口的前提条件是用户具有查看标签的权限。查询操作完成后,平台将返回项目下所有训练作业标签的聚合结果,按key分组,每个key下列出该key出现过的所有不同value。若用户无权限操作,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v2/{project_id}/modelarts-training-job/tags
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:不涉及。 取值范围:1 - 64字符,字母、数字和中划线。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释:每页返回的标签key数量。 约束限制:不涉及。 取值范围:1 - 1000。 默认取值:1000。 |
| offset | 否 | Integer | 参数解释:分页查询的偏移量。 约束限制:不涉及。 取值范围:大于等于0。 默认取值:0。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| tags | Array of ProjectTag objects | 参数解释:标签列表,按key聚合,每个key下包含该项目下该key出现过的所有不同value。 取值范围:不涉及。 |
请求示例
如下以查询项目下所有训练作业标签为例。
GET https://{endpoint}/v2/{project_id}/modelarts-training-job/tags 响应示例
状态码:200
查询成功。
{
"tags" : [ {
"key" : "111",
"values" : [ "v2", "v3" ]
}, {
"key" : "k2",
"values" : [ "v2" ]
}, {
"key" : "test",
"values" : [ "1122" ]
} ]
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询成功。 |
错误码
请参见错误码。