云运维中心 COC
云运维中心 COC
链接复制成功！
创建自定义作业
功能介绍
创建自定义作业。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /v1/documents
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
是 |
String |
参数解释： 作业名称。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
content |
是 |
String |
参数解释： 作业内容，DSL语句，最大长度64KB。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
enterprise_project_id |
是 |
String |
参数解释： 企业项目id。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
risk_level |
是 |
String |
参数解释： 风险等级。
约束限制： 不涉及。 取值范围： 默认取值： 不涉及。 |
|
description |
否 |
String |
参数解释： 作业描述。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
tags |
否 |
Array of tags objects |
参数解释： 标签列表。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
data |
String |
参数解释： 创建作业，系统返回的作业id。 取值范围： 不涉及。 |
状态码：400
请求示例
创建自定义作业。
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 |
包含错误信息。 更多状态码请参考状态码。 |
错误码
请参见错误码。
父主题： 作业管理
