Creates a workflow. By default, the created workflow is disabled. After you update the directed acyclic graph (DAG) of the workflow, you must manually or call the corresponding operation to enable the workflow. You can call this operation only in the professional edition.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| edas:CreateSchedulerxWorkflowCreate | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID. | cn-hangzhou |
| Namespace | string | Yes | The namespace ID. You can obtain the namespace ID on the Namespace page in the SchedulerX console. | adcfc35d-e2fe-4fe9-bbaa-20e90ffc**** |
| NamespaceSource | string | No | The source of the namespace. This parameter is required only for a special third party. | schedulerx |
| GroupId | string | Yes | The application group ID. You can obtain the ID on the Application Management page in the SchedulerX console. | testSchedulerx.defaultGroup |
| Name | string | Yes | The name of the workflow. | helloworld |
| Description | string | No | The description of the workflow. | Test |
| TimeType | integer | Yes | The method that is used to specify the time. Valid values:
| 1 |
| TimeExpression | string | No | The time expression. You can set the time expression based on the selected method that is used to specify time.
| 0 0/10 * * * ? |
| Timezone | string | No | The time zone. | GMT+8 |
| MaxConcurrency | integer | No | The maximum number of workflow instances that can be run at the same time. Default value: 1. The value 1 indicates that only one workflow instance is allowed. In this case, if the triggered workflow instance is still ongoing, no more workflow instances can be triggered even the time to schedule the next workflow arrives. | 1 |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "39090022-1F3B-4797-8518-6B61095F1AF0",
"Code": "200",
"Success": true,
"Message": "timetype is invalid",
"Data": {
"WorkflowId": 92583
}
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-10-21 | The response structure of the API has changed | View Change Details |
| 2024-05-30 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
| 2024-03-25 | The internal configuration of the API is changed, but the call is not affected | View Change Details |