All Products
Search
Document Center

SchedulerX:DisableWorkflow

Last Updated:Mar 21, 2023

Sends the ID of a workflow.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
WorkflowIdlongYes

The ID of the workflow.

111
NamespacestringYes

The ID of the namespace. You can obtain the ID of the namespace on the Namespace page in Distributed Task Scheduling Platform.

adcfc35d-e2fe-4fe9-bbaa-20e90ffc****
NamespaceSourcestringNo

This parameter is required only for a special third party.

schedulerx
GroupIdstringNo

The ID of the application. You can obtain the application ID on the Application Management page in Distributed Task Scheduling Platform.

testSchedulerx.defaultGroup
RegionIdstringYes

The ID of the region.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The error message that is returned only if the error occurs.

Your request is denied as lack of ssl protect.
RequestIdstring

The ID of the request.

4F68ABED-AC31-4412-9297-D9A8F0401108
Successboolean

Indicates whether the workflow is disabled. Valid values:

  • true: The workflow is disabled.
  • false: Failed to disable the workflow.
true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "Your request is denied as lack of ssl protect.",
  "RequestId": "4F68ABED-AC31-4412-9297-D9A8F0401108",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-12-26The internal configurations of the API operation change but you can still call the operation.
Change itemChange content
The internal configurations of the API operation change but you can still call the operation.