Updated on 2025-11-27 GMT+08:00

Canceling a Scheduled Task

Function

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

Constraints

This API supports the following types of instances:

  • GeminiDB Influx
  • GeminiDB Redis
  • GeminiDB Mongo
  • GeminiDB Cassandra

Authorization Information

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

  • If you are using role/policy-based authorization, see the required permissions in Permissions and Supported Actions.
  • 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

    gaussdbfornosql:instance:cancelScheduleJob

    write

    -

    -

    nosql:instance:cancelScheduleJob

    -

URI

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

Table 1 URI parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID of a user in a region

job_id

Yes

String

Task ID. The value is the same as the job_id field returned in the scheduled task list.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token

Response Parameters

Status code: 204

None

Example Request

Cancel a scheduled task.

DELETE https://{Endpoint}/v3/0549b4a43100d4f32f51c01c2fe4acdb/scheduled-jobs/56d3c1138dcf4f1da73b0170700c78d0

Example Response

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.