Domain name for API request: mps.tencentcloudapi.com.
This API is used to get the list of workflow details by workflow ID.
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: DescribeWorkflows. |
Version | Yes | String | Common Params. The value used for this API: 2019-06-12. |
Region | No | String | Common Params. This parameter is not required for this API. |
WorkflowIds.N | No | Array of Integer | Workflow ID filter. Array length limit: 100. |
Status | No | String | Workflow status. Valid values: If this parameter is left empty, the workflow status will not be distinguished. |
Offset | No | Integer | Paging offset. Default value: 0. |
Limit | No | Integer | Number of returned entries. Default value: 10. Maximum value: 100. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of eligible entries. |
WorkflowInfoSet | Array of WorkflowInfo | Workflow information array. |
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. |
This example shows you how to query the workflow with ID 78459.
https://mps.tencentcloudapi.com/?Action=DescribeWorkflows
&WorkflowIds.0=78459
&<Common request parameters>
{
"Response": {
"RequestId": "6ca31e3a-6b8e-4b4e-9256-fdc700064ef3",
"TotalCount": 1,
"WorkflowInfoSet": [
{
"WorkflowId": 78459,
"WorkflowName": "transcode-10",
"Status": "Enabled",
"Trigger": {
"Type": "CosFileUpload",
"CosFileUploadTrigger": {
"Bucket": "TopRankVideo-125xxx88",
"Region": "ap-chongqing",
"Dir": "/movie/201907/"
}
},
"OutputStorage": {
"Type": "COS",
"CosOutputStorage": {
"Bucket": "TopRankVideo-125xxx88",
"Region": "ap-chongqing"
}
},
"MediaProcessTask": {
"TranscodeTaskSet": [
{
"Definition": 10,
"WatermarkSet": []
}
]
},
"OutputDir": "/movie/201907/",
"AiContentReviewTask": null,
"AiRecognitionTask": null,
"AiAnalysisTask": null,
"TaskNotifyConfig": null,
"TaskPriority": 0,
"CreateTime": "2019-07-18T10:00:00Z",
"UpdateTime": "2019-07-18T11:00:03Z"
}
]
}
}
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.InvalidMpsUser | Operation failed: unauthorized MPS user. |
InternalError | Internal error. |
InvalidParameterValue | Incorrect parameter value. |
Was this page helpful?