Help Center/ GeminiDB/ API Reference/ API v3/ Task Management/ Canceling a Scheduled Task
Updated on 2026-09-22 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 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

Definition

Project ID of a tenant in a region. To obtain this value, see Obtaining a Project ID.

Constraints

N/A

Range

The value contains 32 characters. Only letters and digits are allowed.

Default Value

N/A

job_id

Yes

String

Definition

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

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token

You can obtain the token by calling the IAM API by following Obtaining a User Token Through Password Authentication.

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 204

None

Example Requests

Canceling a scheduled task

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

Example Responses

None

Status Codes

For details, see Status Codes.

Error Codes

For details, see Error Codes.