Help Center/ Cloud Operations Center/ API Reference/ API/ Scheduled O&M/ Disabling a Scheduled Task
Updated on 2025-10-24 GMT+08:00
View PDF
Share

Disabling a Scheduled Task

Function

This API is used to disable scheduled O&M tasks by 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

    coc:schedule:disable

    Write

    schedule *

    g:EnterpriseProjectId

    -

    -

URI

POST /v1/schedule/task/{task_id}/disable

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition

ID of a scheduled task.

Constraints

An existing task that is enabled.

Range

A string of 26 characters starting with ST.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

data

String

Definition

Interface response data.

Range

N/A

Status code: 400

Table 3 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Result code.

Range

N/A

error_msg

String

Definition

Error description.

Range

N/A

Example Requests

Disable a scheduled O&M task by task ID.

POST https://{Endpoint}/v1/schedule/task/ST****/disable

Example Responses

Status code: 200

Request result is returned.

{
  "data" : "ST****"
}

Status Codes

Status Code

Description

200

Request result is returned.

400

The server failed to process the request is returned.

Error Codes

See Error Codes.

Parent topic: Scheduled O&M