更新时间:2025-07-04 GMT+08:00
分享

修改自定义作业

功能介绍

修改自定义作业。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

PUT /v1/documents/{document_id}

表1 路径参数

参数

是否必选

参数类型

描述

document_id

String

参数解释:

作业id。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

name

String

参数解释:

作业名称。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

content

String

参数解释:

作业内容,DSL语句,最大长度64KB。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

description

String

参数解释:

描述。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

risk_level

String

参数解释:

风险等级。

约束限制:

  • LOW:低。

  • MEDIUM:中。

  • HIGH:高。

  • LOW。

  • MEDIUM。

  • HIGH。

取值范围:

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

data

String

参数解释:

编辑作业,系统返回的作业id。

取值范围:

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

参见错误码章节。

error_msg

String

参数解释:

错误描述。

取值范围:

参见错误码章节。

请求示例

修改自定义作业。

PUT https://{Endpoint}/v1/documents/{document_id}

{
  "name" : "test_document",
  "description" : "",
  "enterprise_project_id" : "0",
  "risk_level" : "LOW",
  "content" : "meta:\n  name: test_document\n  schemaVersion: 3\n  description: \"\"\ninputs: {}\nsteps:\n  - name: pause\n    description: pause\n    task: hwc:runbook:suspend@1.0.0\n    inputs: {}\n    outputs: []"
}

响应示例

状态码:200

请求成功。

{
  "data" : "DM20250701180239xxxxxxx"
}

状态码

状态码

描述

200

请求成功。

400

包含错误信息。

更多状态码请参考状态码

错误码

请参见错误码

相关文档