文档首页/ 云运维中心 COC/ API参考/ API/ 作业管理/ 删除自定义作业 - DeleteDocument
更新时间:2025-10-14 GMT+08:00
分享

删除自定义作业 - DeleteDocument

功能介绍

删除用户自定义作业。

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    coc:document:deleteDocument

    Write

    document *

    -

    -

    -

URI

DELETE /v1/documents/{document_id}

表1 路径参数

参数

是否必选

参数类型

描述

document_id

String

参数解释:

作业uuid。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

data

String

参数解释:

删除作业,系统返回的作业id。

取值范围:

不涉及。

状态码:400

表3 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

参见错误码章节。

error_msg

String

参数解释:

错误描述。

取值范围:

参见错误码章节。

请求示例

删除自定义作业。

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

响应示例

状态码:200

请求成功。

{
  "data" : "DM20250607181512xxxxx"
}

状态码

状态码

描述

200

请求成功。

400

包含错误信息。

更多状态码请参考状态码

错误码

请参见错误码

相关文档