Help Center/ Cloud Operations Center/ API Reference/ API/ Job Management/ Deleting a Custom Job
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Deleting a Custom Job

Function

This API is used to delete a custom job.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    coc:document:deleteDocument

    Write

    document *

    -

    -

    -

URI

DELETE /v1/documents/{document_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

document_id

Yes

String

Definition:

Job UUID.

Constraints:

N/A.

Value range:

N/A.

Default value:

N/A.

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

data

String

Definition:

Job ID returned by the system when a job is deleted.

Value range:

N/A.

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

For details, see Error Codes.

error_msg

String

Definition:

Error description.

Value range:

For details, see Error Codes.

Example Requests

Delete a custom job.

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

Example Responses

Status code: 200

Request succeeded.

{
  "data" : "DM20250607181512xxxxx"
}

Status Codes

Status Code

Description

200

Request succeeded.

400

The contained error information is returned.

For more status codes, see Status Codes.

Error Codes

See Error Codes.

Parent topic: Job Management