文档首页/ 数据治理中心 DataArts Studio/ API参考/ 数据开发API（V2）/ 作业开发API/ 修改作业名称
更新时间：2024-11-06 GMT+08:00
查看PDF
分享

修改作业名称

功能介绍

对作业名称进行重命名操作。

URI

  • URI格式

    PUT /v2/{project_id}/factory/jobs/{job_name}/rename

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

    参数名

    是否必选

    参数类型

    说明

    project_id

    是

    String

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

    job_name

    是

    String

    原作业名称。

请求参数

表2 请求Header参数

参数名

是否必选

参数类型

说明

workspace

否

String

工作空间id。

  • 如果不设置该参数，默认查询default工作空间下的数据。
  • 如果需要查询其他工作空间的数据，需要带上该消息头。

X-Auth-Token

否

String

使用Token认证时该字段必选，用户Token的长度要求如下：

最小长度：0

最大长度：4096

Content-Type

否

String

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

示例：Content-Type: application/json;charset=UTF-8

Authorization

否

String

使用AK/SK进行认证时该字段必选。

Host

否

String

使用AK/SK进行认证时该字段必选。
表3 Body参数说明

参数名

是否必选

参数类型

说明

name

是

String

新的作业名称。

响应参数

表4 参数说明

参数名

是否必选

参数类型

说明

is_success

是

Boolean

true或者false

status_code

是

Integer

状态响应码

请求示例

PUT /v2/62099355b894428e8916573ae635f1f9/factory/jobs/job_2284221/rename

{
	"name": "job_4269F"
}

响应示例

  • 成功响应

    HTTP状态码 200

    {
    "is_success": true,
    "status_code": 200
}
  • 失败响应

    HTTP状态码 400

    {
    "error_code": "DLF.30100",
    "error_msg": "Job[job_2284221] does not exist"
}
父主题： 作业开发API