# 查询训练作业资源列表（按标签筛选） - ListTrainingJobsByTags #### 功能介绍 查询训练作业资源列表接口用于按标签、资源名称等条件筛选项目下符合条件的训练作业资源，并返回每个作业的标签信息。 该接口适用于以下场景：当用户需要通过标签或资源名称筛选训练作业，以进行资源分类管理或批量操作时，可以通过此接口获取符合条件的作业资源列表。使用该接口的前提条件是用户具有查看标签的权限。查询操作完成后，平台将返回符合条件的作业资源列表及总数。若标签格式不合法、标签key重复或用户无权限操作，接口将返回相应的错误信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListTrainingJobsByTags)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts::listResourcesByTag | List | - | g:TagKeys | modelarts:tag:list | - | #### URI POST /v2/{project_id}/modelarts-training-job/resource-instances/filter 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释** ：用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制**：不涉及。 **取值范围**：1 - 64字符，字母、数字和中划线。 **默认取值**：不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | limit | 否 | Integer | **参数解释**：每页返回的资源数量。 **约束限制**：不涉及。 **取值范围**：1 - 1000。 **默认取值**：1000。 | | offset | 否 | Integer | **参数解释**：分页查询的偏移量。 **约束限制**：不涉及。 **取值范围**：大于等于0。 **默认取值**：0。 | #### 请求参数 表3请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | workspace_id | 否 | String | **参数解释**：工作空间ID。未创建工作空间时默认值为"0"，存在创建并使用的工作空间，以实际取值为准。 **约束限制**：不涉及。 **取值范围**：不涉及。 **默认取值**：0。 | | tags | 否 | Array of [MutiValueTag] objects | **参数解释**：标签筛选条件，按标签key-value对筛选作业。同一key下多个value为OR关系，不同key之间为AND关系。 **约束限制**：同一key的values不能重复，不同key不能重复。 **取值范围**：不涉及。 | | without_any_tag | 否 | Boolean | **参数解释**：是否查询没有任何标签的作业。 **约束限制**：设为true时忽略tags筛选条件。 **取值范围**： - true：仅查询无标签的作业 - false：按tags条件筛选 **默认取值**：false。 | | matches | 否 | Array of [Match] objects | **参数解释**：资源名称搜索条件。 **约束限制**：最多支持1个匹配项，且key必须为resource_name。 **取值范围**：不涉及。 | 表4MutiValueTag | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释**：标签key。 **取值范围**：1-128字符，支持字母、数字、中文及特殊字符（_.:=+-@），不能以_sys_开头。 | | values | 否 | Array of strings | **参数解释**：该key下的value列表，多个value之间为OR关系。 **约束限制**：同一key下values不能重复，最多10个。 **取值范围**：0-255字符，支持字母、数字、中文及特殊字符（_.:/=+-@）。 | 表5Match | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | key | 否 | String | **参数解释**：搜索字段名。 **取值范围**：resource_name。 | | value | 否 | String | **参数解释**：搜索关键词，按资源名称模糊匹配。 **取值范围**：1-255字符。 | #### 响应参数 **状态码：200** 表6响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resources | Array of [ResourceInstance] objects | **参数解释**：符合条件的训练作业资源列表。 **取值范围**：不涉及。 | | total_count | Integer | **参数解释**：符合条件的训练作业总数。 **取值范围**：不涉及。 | 表7ResourceInstance | 参数 | 参数类型 | 描述 | |:---|:---|:---| | resource_detail | Object | **参数解释**：资源详情，当前为空对象。 **取值范围**：不涉及。 | | workspace_id | String | **参数解释**：工作空间ID。 **取值范围**：不涉及。 | | resource_id | String | **参数解释**：训练作业ID。 **取值范围**：不涉及。 | | resource_name | String | **参数解释**：训练作业名称。 **取值范围**：不涉及。 | | tags | Array of [TmsTagResp] objects | **参数解释**：该训练作业上的标签列表。无标签的作业返回空数组。 **取值范围**：不涉及。 | 表8TmsTagResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | key | String | **参数解释**：TMS标签的key。 **取值范围**：不涉及。 | | value | String | **参数解释**：TMS标签的value。 **取值范围**：不涉及。 | #### 请求示例 - 如下以查询项目下标签key为"test"且value为"1122"的训练作业资源列表为例。 ``` POST https://{endpoint}/v2/{project_id}/modelarts-training-job/resource-instances/filter?limit=10&offset=0 { "tags" : [ { "key" : "test", "values" : [ "1122" ] } ] } ``` - ``` { "without_any_tag" : true } ``` #### 响应示例 **状态码：200** ``` { "resources" : [ { "resource_detail" : { }, "workspace_id" : "0", "resource_id" : "3faf5c03-aaa1-4cbe-879d-24b05d997347", "resource_name" : "trainjob--py14-108", "tags" : [ { "key" : "test", "value" : "1122" }, { "key" : "k2", "value" : "v2" } ] } ], "total_count" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。