Canceling a Scheduled Task

Function

This API is used to cancel a scheduled task based on the task ID.

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
dds:instance:cancelScheduledJob	write	-	-	-	-

URI

DELETE /v3/{project_id}/scheduled-jobs/{job_id}

**Table 1** URI parameters
Name	Mandatory	Type	Description
project_id	Yes	String	Project ID of a tenant in a region. To obtain the project ID, see Obtaining a Project ID.
job_id	Yes	String	Task ID. The value is from the scheduled task list. Obtain the task ID by referring to Querying a Scheduled Task.

Request Parameters

**Table 2** Request header parameters
Name	Mandatory	Type	Description
X-Auth-Token	No	String	User token obtained from IAM. For details, see Authentication.

Response Parameters

Status code: 204

Example Request

Cancelling a scheduled task whose ID is 3861199d-c196-4791-bcd0-b45fde754f50 under the project whose ID is b02ce40e8cb84a8e980fdb11fac657db

DELETE https://{endpoint}/v3/b02ce40e8cb84a8e980fdb11fac657db/scheduled-jobs/3861199d-c196-4791-bcd0-b45fde754f50

Example Response

None

SDK

Click Document Database Service DDS SDK to download the SDK or view the SDK document. To learn how to install and authenticate an SDK, read the Usage section.