1. 接口描述
接口请求域名： mps.tencentcloudapi.com 。
根据工作流 ID，获取工作流详情列表。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeWorkflows。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| WorkflowIds.N | 否 | Array of Integer | 工作流 ID 过滤条件，数组长度限制：100。 示例值：["78459\n"] |
| Status | 否 | String | 工作流状态，取值范围： 不填此参数，则不区分工作流状态。 示例值：“” |
| Offset | 否 | Integer | 分页偏移量，默认值：0。 示例值：0 |
| Limit | 否 | Integer | 返回记录条数，默认值：10，最大值：100。 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 符合过滤条件的记录总数。 示例值：1 |
| WorkflowInfoSet | Array of WorkflowInfo | 工作流信息数组。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询特定工作流
查询 ID 为78459的工作流。
输入示例
https://mps.tencentcloudapi.com/?Action=DescribeWorkflows
&WorkflowIds.0=78459
&<公共请求参数>输出示例
{
"Response": {
"TotalCount": 1,
"WorkflowInfoSet": [
{
"WorkflowId": 0,
"WorkflowName": "abc",
"Status": "abc",
"Trigger": {
"Type": "abc",
"CosFileUploadTrigger": {
"Bucket": "abc",
"Region": "abc",
"Dir": "abc",
"Formats": [
"abc"
]
},
"AwsS3FileUploadTrigger": {
"S3Bucket": "abc",
"S3Region": "abc",
"Dir": "abc",
"Formats": [
"abc"
],
"S3SecretId": "abc",
"S3SecretKey": "abc",
"AwsSQS": {
"SQSRegion": "abc",
"SQSQueueName": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
}
},
"OutputStorage": {
"Type": "abc",
"CosOutputStorage": {
"Bucket": "abc",
"Region": "abc"
},
"S3OutputStorage": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"MediaProcessTask": {
"TranscodeTaskSet": [
{
"Definition": 1,
"RawParameter": {
"Container": "abc",
"RemoveVideo": 0,
"RemoveAudio": 0,
"VideoTemplate": {
"Codec": "abc",
"Fps": 0,
"Bitrate": 0,
"ResolutionAdaptive": "abc",
"Width": 1,
"Height": 1,
"Gop": 1,
"FillType": "abc",
"Vcrf": 1,
"SegmentType": 0
},
"AudioTemplate": {
"Codec": "abc",
"Bitrate": 0,
"SampleRate": 1,
"AudioChannel": 0
},
"TEHDConfig": {
"Type": "abc",
"MaxVideoBitrate": 0
}
},
"OverrideParameter": {
"Container": "abc",
"RemoveVideo": 1,
"RemoveAudio": 1,
"VideoTemplate": {
"Codec": "abc",
"Fps": 0,
"Bitrate": 0,
"ResolutionAdaptive": "abc",
"Width": 1,
"Height": 1,
"Gop": 1,
"FillType": "abc",
"Vcrf": 1,
"ContentAdaptStream": 1,
"SegmentType": 0
},
"AudioTemplate": {
"Codec": "abc",
"Bitrate": 0,
"SampleRate": 1,
"AudioChannel": 0,
"StreamSelects": [
0
]
},
"TEHDConfig": {
"Type": "abc",
"MaxVideoBitrate": 0
},
"SubtitleTemplate": {
"Path": "abc",
"StreamIndex": 0,
"FontType": "abc",
"FontSize": "abc",
"FontColor": "abc",
"FontAlpha": 0
},
"AddonAudioStream": [
{
"Type": "abc",
"CosInputInfo": {
"Bucket": "abc",
"Region": "abc",
"Object": "abc"
},
"UrlInputInfo": {
"Url": "abc"
},
"S3InputInfo": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3Object": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
}
],
"StdExtInfo": "abc",
"AddOnSubtitles": [
{
"Type": "abc",
"Subtitle": {
"Type": "abc",
"CosInputInfo": {
"Bucket": "abc",
"Region": "abc",
"Object": "abc"
},
"UrlInputInfo": {
"Url": "abc"
},
"S3InputInfo": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3Object": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
}
}
]
},
"WatermarkSet": [
{
"Definition": 1,
"RawParameter": {
"Type": "abc",
"CoordinateOrigin": "abc",
"XPos": "abc",
"YPos": "abc",
"ImageTemplate": {
"ImageContent": {
"Type": "abc",
"CosInputInfo": {
"Bucket": "abc",
"Region": "abc",
"Object": "abc"
},
"UrlInputInfo": {
"Url": "abc"
},
"S3InputInfo": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3Object": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"Width": "abc",
"Height": "abc",
"RepeatType": "abc"
}
},
"TextContent": "abc",
"SvgContent": "abc",
"StartTimeOffset": 0,
"EndTimeOffset": 0
}
],
"MosaicSet": [
{
"CoordinateOrigin": "abc",
"XPos": "abc",
"YPos": "abc",
"Width": "abc",
"Height": "abc",
"StartTimeOffset": 0,
"EndTimeOffset": 0
}
],
"StartTimeOffset": 0,
"EndTimeOffset": 0,
"OutputStorage": {
"Type": "abc",
"CosOutputStorage": {
"Bucket": "abc",
"Region": "abc"
},
"S3OutputStorage": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"OutputObjectPath": "abc",
"SegmentObjectName": "abc",
"ObjectNumberFormat": {
"InitialValue": 1,
"Increment": 1,
"MinLength": 1,
"PlaceHolder": "abc"
},
"HeadTailParameter": {}
}
],
"AnimatedGraphicTaskSet": [
{
"Definition": 1,
"StartTimeOffset": 0,
"EndTimeOffset": 0,
"OutputStorage": {
"Type": "abc",
"CosOutputStorage": {
"Bucket": "abc",
"Region": "abc"
},
"S3OutputStorage": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"OutputObjectPath": "abc"
}
],
"SnapshotByTimeOffsetTaskSet": [
{
"Definition": 1,
"OutputStorage": {
"Type": "abc",
"CosOutputStorage": {
"Bucket": "abc",
"Region": "abc"
},
"S3OutputStorage": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"ExtTimeOffsetSet": [
"abc"
],
"TimeOffsetSet": [
0
],
"WatermarkSet": [
{
"Definition": 1,
"RawParameter": {
"Type": "abc",
"CoordinateOrigin": "abc",
"XPos": "abc",
"YPos": "abc",
"ImageTemplate": {
"Width": "abc",
"Height": "abc",
"RepeatType": "abc"
}
},
"TextContent": "abc",
"SvgContent": "abc",
"StartTimeOffset": 0,
"EndTimeOffset": 0
}
],
"OutputObjectPath": "abc",
"ObjectNumberFormat": {
"InitialValue": 1,
"Increment": 1,
"MinLength": 1,
"PlaceHolder": "abc"
}
}
],
"SampleSnapshotTaskSet": [
{
"Definition": 1,
"OutputStorage": {
"Type": "abc",
"CosOutputStorage": {
"Bucket": "abc",
"Region": "abc"
},
"S3OutputStorage": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"WatermarkSet": [
{
"Definition": 1,
"RawParameter": {
"Type": "abc",
"CoordinateOrigin": "abc",
"XPos": "abc",
"YPos": "abc",
"ImageTemplate": {
"Width": "abc",
"Height": "abc",
"RepeatType": "abc"
}
},
"TextContent": "abc",
"SvgContent": "abc",
"StartTimeOffset": 0,
"EndTimeOffset": 0
}
],
"OutputObjectPath": "abc",
"ObjectNumberFormat": {
"InitialValue": 1,
"Increment": 1,
"MinLength": 1,
"PlaceHolder": "abc"
}
}
],
"ImageSpriteTaskSet": [
{
"Definition": 1,
"OutputObjectPath": "abc",
"WebVttObjectName": "abc"
}
],
"AdaptiveDynamicStreamingTaskSet": [
{
"Definition": 1,
"WatermarkSet": [
{
"Definition": 1,
"RawParameter": {
"Type": "abc",
"CoordinateOrigin": "abc",
"XPos": "abc",
"YPos": "abc",
"ImageTemplate": {
"ImageContent": {
"Type": "abc",
"CosInputInfo": {
"Bucket": "abc",
"Region": "abc",
"Object": "abc"
},
"UrlInputInfo": {
"Url": "abc"
},
"S3InputInfo": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3Object": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"Width": "abc",
"Height": "abc",
"RepeatType": "abc"
}
},
"TextContent": "abc",
"SvgContent": "abc",
"StartTimeOffset": 0,
"EndTimeOffset": 0
}
],
"OutputStorage": {
"Type": "abc",
"CosOutputStorage": {
"Bucket": "abc",
"Region": "abc"
},
"S3OutputStorage": {
"S3Bucket": "abc",
"S3Region": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
}
},
"OutputObjectPath": "abc",
"SubStreamObjectName": "abc",
"SegmentObjectName": "abc",
"AddOnSubtitles": [
{
"Type": "abc"
}
],
"DrmInfo": {
"Type": "abc",
"SimpleAesDrm": {
"Uri": "abc",
"Key": "abc",
"Vector": "abc"
}
},
"DefinitionType": "abc"
}
]
},
"AiContentReviewTask": {
"Definition": 1
},
"AiAnalysisTask": {
"Definition": 1,
"ExtendedParameter": "abc"
},
"AiRecognitionTask": {
"Definition": 1
},
"TaskNotifyConfig": {
"NotifyType": "abc",
"NotifyMode": "abc",
"NotifyUrl": "abc",
"CmqModel": "abc",
"CmqRegion": "abc",
"TopicName": "abc",
"QueueName": "abc",
"AwsSQS": {
"SQSRegion": "abc",
"SQSQueueName": "abc",
"S3SecretId": "abc",
"S3SecretKey": "abc"
},
"NotifyKey": "abc"
},
"TaskPriority": 0,
"OutputDir": "abc",
"CreateTime": "abc",
"UpdateTime": "abc"
}
],
"RequestId": "abc"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.InvalidMpsUser | 操作失败：非法 mps 用户。 |
| InternalError | 内部错误。 |
| InvalidParameterValue | 参数取值错误。 |
