Domain name for API request: databuddy.intl.tencentcloudapi.com.
This API is used to query workflow details.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: GetWorkflow. |
| Version | Yes | String | Common Params. The value used for this API: 2026-07-15. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| WorkspaceId | Yes | String | Workspace ID, which can be obtained through ListWorkspaces. Required |
| WorkflowId | Yes | String | Workflow ID, which can be obtained through ListWorkflows. Required |
| Parameter Name | Type | Description |
|---|---|---|
| Data | GetWorkflowRsp | Workflow details response content |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: databuddy.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetWorkflow
<Common request parameters>
{
"WorkspaceId": "17697410068842890",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1"
}{
"Response": {
"Data": {
"AdvanceConfig": {
"MaxConcurrentNum": 1,
"QueuingMode": "OFF"
},
"BaseInfo": {
"CreateTime": "1786100692847",
"CreateUserUin": "700002164618",
"OwnerDisplayName": "we***a**-d**@t*n********",
"OwnerUserName": "wed**a*0*d**************",
"OwnerUserUin": "700002164618",
"RunUserUin": "700002164618",
"UpdateTime": "1786115139666",
"WorkflowId": "8e0e3485-2736-4530-92ed-932e019898f1",
"WorkflowName": "new_workflow_20260807_190451"
},
"BundleId": "",
"BundleInfo": "",
"GitConfigId": "",
"LabelList": [],
"ParamList": [
{
"ParamId": "d667305e-a68c-4661-93ea-cad9c9f1ce9c",
"ParamKey": "pppp1",
"ParamValue": "vvvv1"
}
],
"TaskList": [
{
"CreateTime": "1786100692847",
"CreateUserUin": "700002164618",
"DependOnList": [],
"DependOnRunCondition": "ALL_SUCCESS",
"LeftCoordinate": 50,
"ParamList": [],
"ResourceGroupId": "res-ea1a38f8",
"TaskId": "40d34e5c-12d9-4ac3-88ed-2f879713d4e4",
"TaskName": "py_08072",
"TaskRetryStrategy": {
"MaxRetryTimes": 3,
"RetryBetweenWaitTime": 5,
"RetryBetweenWaitTimeUnit": "SECOND",
"TaskRunFailureRetrySwitch": true,
"TaskRunTimeoutRetrySwitch": false
},
"TaskType": {
"RuntimePropertyList": [
{
"PropertyKey": "ConfigType",
"PropertyValue": "DEFAULT"
}
],
"TaskTypeName": "PYTHON",
"TaskTypePropertyList": [
{
"PropertyKey": "Source",
"PropertyValue": "5"
}
]
},
"TopCoordinate": 50,
"UpdateTime": "1786115139765"
}
],
"Trigger": [],
"WorkspaceId": "17697410068842890"
},
"RequestId": "a225ce2c-c8dd-47bc-83c1-df352a949443"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| FailedOperation.WorkflowNoPermission | No operation permissions. |
| InvalidParameter | Parameter error. |
| InvalidParameterValue | Parameter value error. |
| InvalidParameterValue.ParamBlankError | Parameter <parameter> cannot be empty. |
| InvalidParameterValue.WorkflowTriggerAdvancedConfigError | Please check the advanced configuration of the workflow trigger and fix the illegal JSON content. |
| MissingParameter | Parameters are missing. |
| ResourceNotFound.WorkflowNotFound | Workflow not found according to the input workflow ID |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback