文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V2）/ 作业开发API/ 设置作业标签
更新时间：2025-05-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

设置作业标签

功能介绍

此接口可以设置作业标签。

URI

  • URI格式

    POST /v2/{project_id}/factory/jobs/{job_name}/tags

  • 参数说明
    表1 URI参数说明

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

    项目编号，获取方法请参见项目ID和账号ID。

    job_name

    是

    String

    作业名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。
    说明：
    • 多个DataArts Studio实例需要指定工作空间。
    • 当工作空间里面没有default工作空间时，工作空间为必填参数，否则会报错。

X-Auth-Token

是

String

IAM Token

最小长度：0

最大长度：4096

Content-Type

否

String

有Body体的情况下必选，无Body体的情况下则无需填写和校验。

示例：Content-Type: application/json;charset=UTF-8
表3 Body参数说明

参数名

是否必选

参数类型

说明

tag_names

否

List<String>

标签列表。若为空表示清空作业标签。

样例值： ["tag1", "tag2"]

响应参数

无

请求示例

为作业myJob设置标签“tag1”。 
POST /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/jobs/myJob/tags
{
    "tag_names": ["tag1"]
}
清空作业myJob的所有标签。 
POST /v2/b384b9e9ab9b4ee8994c8633aabc9505/factory/jobs/myJob/tags
{
     "tag_names": []
}

响应示例

  • 成功响应

    HTTP状态码 204

  • 失败响应

    HTTP状态码 400

    {
    "error_code":"DLF.100",
    "error_msg":"The job does not exists."
}
父主题： 作业开发API