文档首页/云运维中心 COC/API参考/API/作业管理/创建自定义作业 - CreateDocument
更新时间：2025-11-03 GMT+08:00
查看PDF
分享

创建自定义作业 - CreateDocument

功能介绍

创建用户自定义作业。

调试

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

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    coc:document:createDocument

    Write

    document *

    -

    -

    -

URI

POST /v1/documents

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

name

是

String

参数解释：

作业名称。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

content

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

enterprise_project_id

是

String

参数解释：

企业项目id。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

risk_level

是

String

参数解释：

风险等级。

约束限制：

不涉及。

取值范围：

  • LOW：低。

  • MEDIUM：中。

  • HIGH：高。

默认取值：

不涉及。

description

否

String

参数解释：

作业描述。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

tags

否

Array of tags objects

参数解释：

标签列表。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 tags

参数

是否必选

参数类型

描述

key

否

String

参数解释：

标签的key。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

value

否

String

参数解释：

标签的value。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

data

String

参数解释：

创建作业，系统返回的作业id。

取值范围：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

参见错误码章节。

error_msg

String

参数解释：

错误描述。

取值范围：

参见错误码章节。

请求示例

创建自定义作业。

POST https://{Endpoint}/v1/documents

{
  "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" : "DM20250701180239xxxxx"
}

状态码

状态码

描述

200

请求成功。

400

包含错误信息。

更多状态码请参考状态码。

错误码

请参见错误码。

父主题：作业管理

相关文档