帮你快速理解、总结文档立即下载

结构体

最近更新时间:2025-09-02 15:50:51
我的收藏

MediaWorkflow_Topology_Nodes_Start_Input

节点名称(关键字)
描述
类型
是否必选
限制
ObjectPrefix
Object 前缀
String
是
无
NotifyConfig
回调信息,如果不设置,则使用队列的回调信息
Container
否
无
ExtFilter
文件后缀过滤器
Container
否
无
Container 类型
NotifyConfig
的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
默认值
限制
Url
回调地址
String
是
无
不能为内网地址
Type
回调类型
String
是
无
Url:url 回调
TDMQ:tdmq 消息回调
Event
回调信息
String
是
无
TaskFinish:任务完成
WorkflowFinish:工作流完成
支持多种事件,以逗号分隔
ResultFormat
回调格式
String
否
XML
XML:xml 格式
JSON:json 格式
MqRegion
TDMQ 所属地域
String
否
无
当回调类型为 TDMQ 时必填,支持地域详见 请求结构
MqMode
TDMQ 使用模式
String
否
无
当回调类型为 TDMQ 时必填。
Topic:主题订阅
Queue:队列服务
MqName
TDMQ 主题名称
String
否
无
当回调类型为 TDMQ 时必填。
KafkaConfig
回调kafka配置信息
Container
否
无
当回调类型为 Kafka 时必填。
Container 节点
KafkaConfig
的内容:
节点名称(关键字)
父节点
描述
类型
是否必选
默认值
限制
Region
Response.QueueList.NotifyConfig.KafkaConfig
Kafka 所属园区
String
是
无
目前支持园区:
ap-guangzhou(广州)
ap-shenzhen(深圳)
ap-shanghai(上海)
ap-nanjing(南京)
ap-chengdu(成都)
ap-beijing(北京)
ap-tianjin(天津)
ap-chongqing(重庆)
ap-hongkong(中国香港)
InstanceId
Response.QueueList.NotifyConfig.KafkaConfig
Kafka 实例 Id
String
是
无
有效的 Kafka 实例 id
Topic
Response.QueueList.NotifyConfig.KafkaConfig
Kafka 主题名称
String
是
无
当前实例下有效的 topic信息
Container 类型
ExtFilter
的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
默认值
限制
State
开关
String
否
Off
On/Off
Video
打开视频后缀限制
String
否
false
false/true
Audio
打开音频后缀限制
String
否
false
false/true
Image
打开图片后缀限制
String
否
false
false/true
ContentType
打开 ContentType 限制
String
否
false
false/true
Custom
打开自定义后缀限制
String
否
false
false/true
CustomExts
自定义后缀
String
否
无
多种文件后缀以/分隔,后缀个数不超过10个
当 Custom 为 true 时,该参数必填
AllFile
所有文件
String
否
false
false/true
AutoContentType
自定义 ContentType
String 数组
否
无
数组大小不能超过10个, 单个字符串长度不能超过64

MediaWorkflow_Topology_Nodes_***_Operation_Output

节点名称(关键字)
描述
类型
是否必选
限制
Region
存储桶的地域
String
是
无
Bucket
存储桶的名称
String
是
无
Object
结果文件名称
String
是
当工作流节点类型为 Snapshot 或 SmartCover,且结果文件不止一个时,必须包含 ${Number} $
当工作流节点类型为 Segment,设置了 Duration,且 Format 不为 HLS 或 m3u8 时,必须包含 ${Number}
SpriteObject
雪碧图的名称
String
否
当工作流节点类型为 Snapshot,且打开了雪碧图时,该字段必填
AuObject
人声结果文件名称
String
否
当工作流节点类型为 VoiceSeparate,且有人声输出时,该字段必填

MediaWorkflow_Topology_Nodes_Snapshot_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
截图模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_Animation_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
视频转动图模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_SmartCover_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
智能封面模板 ID
String
否
无
SmartCover
智能封面参数
Container,详情请参见 SmartCover
否
无
Output
输出地址
Container,详情请参见Output
是
无
说明
TemplateId 和 SmartCover 都可以不设置,默认以原视频大小生成3张封面。如果同时设置 TemplateId 和 SmartCover,TemplateId 优先生效。

MediaWorkflow_Topology_Nodes_Transcode_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
音视频转码模板 ID
String
否
无
WatermarkTemplateId
水印模板 ID
String 数组
否
可以使用多个水印模板,不超过3个
RemoveWatermark
去除水印参数
Container,详情请参见 RemoveWatermark
否
无
DigitalWatermark
数字水印参数
Container,详情请参见 DigitalWatermark
否
无
Output
输出地址
Container,详情请参见 Output
是
无
Input
输入配置
Container
否
无
TranscodeConfig
转码特殊配置
Container
否
无
Container 类型 MediaWorkflow_Topology_Nodes_Transcode_***_Operation.Input 的具体数据描述如下:
节点名称(关键字)
描述
类型
必选
限制
SpeedTranscodingQueueId
倍速转码队列
String
否
无
Container 类型 MediaWorkflow_Topology_Nodes_Transcode\\_\\*\\*\\*_Operation.TranscodeConfig 的具体数据描述如下:

节点名称(关键字)
描述
类型
必选
限制
FreeTranscode
是否开启显示转码,默认 false
String
否
true/false

MediaWorkflow_Topology_Nodes_Concat_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
拼接模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_VoiceSeparate_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
人声分离模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_VideoMontage_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
精彩集锦模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_SDRtoHDR_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
SDRtoHDR
SDRtoHDR 配置
Container
是
无
TranscodeTemplateId
音视频转码模板 ID
String
是
无
WatermarkTemplateId
水印模板 ID
String 数组
否
可以使用多个水印模板,不超过3个
Output
输出地址
Container,详情请参见 Output
是
无
Container 类型 SDRtoHDR 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
HdrMode
HDR 标准
String
是
HLG
HDR10

MediaWorkflow_Topology_Nodes_VideoProcess_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
视频增强模板 ID
String
是
无
TranscodeTemplateId
音视频转码模板 ID
String
是
无
WatermarkTemplateId
水印模板 ID
String 数组
否
可以使用多个水印模板,不超过3个
DigitalWatermark
数字水印参数
Container,详情请参见 DigitalWatermark
否
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_SCF_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
SCF
SCF 函数信息
Container
是
无
Container 类型 SCF 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
Region
函数地域
String
是
无
FunctionName
函数名称
String
是
无
Namespace
命名空间
String
否
无
Alias
函数别名
String
否
无

MediaWorkflow_Topology_Nodes_SuperResolution_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
超级分辨率模板 ID
String
是
无
TranscodeTemplateId
音视频转码模板 ID
String
是
无
WatermarkTemplateId
水印模板 ID
String 数组
否
可以使用多个水印模板,不超过3个
DigitalWatermark
数字水印参数
Container,详情请参见 DigitalWatermark
否
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_VideoEnhance_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
超级分辨率模板 ID
String
是
无
WatermarkTemplateId
水印模板 ID
String 数组
否
可以使用多个水印模板,不超过3个
DigitalWatermark
数字水印参数
Container,详情请参见 DigitalWatermark
否
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_FileInfo_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
FileInfo
文件信息节点参数
Container
是
无
Container 类型 FileInfo 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
AdvancedInformation
启用高级信息
String
否
false/true,默认为 false

MediaWorkflow_Topology_Nodes_Segment_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
Segment
音视频转封装参数
Container
是
无
Output
输出地址
Container,详情请参见 Output
是
无
Container 类型 Segment 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
Format
封装格式
String
否
aac、mp3、flac、mp4、ts、mkv、avi、hls、m3u8
若不指定,结果文件的格式与源文件相同
Format、Duration、AIGCMetadata 参数至少指定一个
Duration
转封装时长,单位:秒
String
否
不小于5的整数
Format、Duration、AIGCMetadata 参数至少指定一个
当指定该参数时,不支持设置 AIGCMetadata 参数
HlsEncrypt
hls 加密配置
Container
否
只有当封装格式为 hls 时生效,详情请参见 HlsEncrypt
AIGCMetadata
aigc 元数据配置
Container
否
Format、Duration、AIGCMetadata 参数至少指定一个
Container 类型 AIGCMetadata 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
Label
AIGC 元数据中的 Label 字段,用于表示内容是否为 AI 生成合成的
String
是
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21~0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
ContentProducer
AIGC 元数据中的 ContentProducer 字段,用于表示 AI 生产方的业务标识
String
是
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
ProduceID
AIGC 元数据中的 ProduceID 字段,用于表示 AI 生产方的文件标识
String
是
支持通配符:
${InputName}: COS 源文件名,不带后缀,不带路径
${InputNameAndExt}: COS 源文件名,带后缀,不带路径
${JobId}: 添加 aigc 元数据信息的执行任务 id
${InputPath}: COS 源文件路径,不包含文件名
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
ReservedCode1
AIGC 元数据中的 ReservedCode1字段,用于表示 AI 生产方提供的防止数据篡改的标识,需经过 base64编码后传入
String
否
长度限制(base64编码前):2048个 UTF-8字符数
字符限制(base64编码前):GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
ContentPropagator
AIGC 元数据中的 ContentPropagator 字段,用于表示 AI 传播方的业务标识
String
否
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
PropagateID
AIGC 元数据中的 PropagateID 字段,用于表示 AI 传播方的文件标识
String
否
支持通配符:
${InputName}: COS 源文件名,不带后缀,不带路径
${InputNameAndExt}: COS 源文件名,带后缀,不带路径
${JobId}: 添加 AIGC 元数据信息的执行任务id
${InputPath}: COS 源文件路径,不包含文件名
长度限制:2048个 UTF-8字符数
字符限制:GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符
ReservedCode2
AIGC 元数据中的 ReservedCode2字段,用于表示 AI 传播方提供的防止数据篡改的标识,需经过 base64编码后传入
String
否
长度限制(base64编码前):2048个 UTF-8 字符数
字符限制(base64编码前):GB18030—2022(ASCII)中码位为0x21 - 0x7E 的字符,即包含阿拉伯数字、大小写英文及可打印字符

MediaWorkflow_Topology_Nodes_PicProcess_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
图片处理模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_Tts_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
语音合成模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_SpeechRecognition_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
语音识别模板 ID
String
是
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_StreamPackConfig_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
StreamPackConfig
打包配置
Container
否
无
Container 类型 StreamPackConfig 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
PackType
打包类型。默认值:HLS
String
否
HLS/DASH
IgnoreFailedStream
忽略转码失败的子流,继续打包。默认值:true
String
否
true/false

MediaWorkflow_Topology_Nodes_VideoStream_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
音视频转码模板 ID
String
否
无
WatermarkTemplateId
水印模板 ID
String 数组
否
可以使用多个水印模板,不超过3个
RemoveWatermark
去除水印参数
Container,详情请参见 RemoveWatermark
否
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_StreamPack_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
StreamPackInfo
打包规则
Container
否
无
Container 类型 StreamPackInfo 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
VideoStreamConfig
视频子流配置
Container
否
无
Container 类型 VideoStreamConfig 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
VideoStreamName
视频子流名称
String
是
必须和存在的视频节点对应
BandWidth
视频子流带宽限制,单位b/s,范围[0, 2000000000],0表示不限制
String
否
大于等于0,默认值是0

MediaWorkflow_Topology_Nodes_Condition_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
Condition
条件配置,详情请参见 Condition
Container
是
无

MediaWorkflow_Topology_Nodes_SegmentVideoBody_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
SegmentVideoBody
视频人像抠图配置
Container
否
无
Output
输出地址
Container,详情请参见 Output
是
无
Container 类型 SegmentVideoBody 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
Mode
抠图模式,当前只支持 Mask (输出 alpha 通道结果)
String
否

MediaWorkflow_Topology_Nodes_NoiseReduction_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
TemplateId
音频降噪模板 ID
String
否
无
Output
输出地址
Container,详情请参见 Output
是
无

MediaWorkflow_Topology_Nodes_ImageInspect_***_Operation

节点名称(关键字)
描述
类型
是否必选
限制
ImageInspect
异常图片检测处理规则
Container
否
无
Container 类型 ImageInspect 的具体数据描述如下:
节点名称(关键字)
描述
类型
是否必选
限制
AutoProcess
是否开启识别到图片异常后自动对图片进行如移动到其他目录、设置为私有权限、删除等动作。取值:true/false,默认为 false
String
否
无
ProcessType
指定检测到异常图片后的处理动作
BackupObject:将图片移动 abnormal_images_backup下,该目录由后台自动创建
SwitchObjectToPrivate:将图片权限设置为私有
DeleteObject:删除图片
默认值:BackupObject
当 AutoProcess 为 true 时,该参数生效
String
否
无

AudioMix

节点名称(关键字)
描述
类型
必选
默认值
限制
AudioSource
需要被混音的音轨媒体地址, 需要做 URLEncode
String
是
无
需与 Input 媒体文件存储于同一 bucket
MixMode
混音模式
String
否
Repeat
Repeat: 混音循环
Once: 混音一次播放
Replace
是否用混音音轨媒体替换Input媒体文件的原音频
String
否
false
true/false
EffectConfig
混音淡入淡出配置
Container
否
false
无
Container 类型 EffectConfig 的具体数据描述如下:
节点名称(关键字)
描述
类型
必选
默认值
限制
EnableStartFadein
开启淡入
String
否
false
true/false
StartFadeinTime
淡入时长
String
否
无
大于0, 支持浮点数
EnableEndFadeout
开启淡出
String
否
false
true/false
EndFadeoutTime
淡出时长
String
否
无
大于0, 支持浮点数
EnableBgmFade
开启 bgm 转换淡入
String
否
false
true/false
BgmFadeTime
bgm 转换淡入时长
String
否
无
大于0, 支持浮点数

AudioMixArray

AudioMixArray 是数组,每一个子项内容同 AudioMix。
说明
仅第一个 Replace 生效。

CallBackMqConfig

节点名称(关键字)
描述
类型
是否必选
MqRegion
消息队列所属园区,目前支持园区 sh(上海)、bj(北京)、gz(广州)、cd(成都)、hk(中国香港)
String
是
MqMode
消息队列使用模式,默认 Queue :
主题订阅:Topic
队列服务: Queue
String
是
MqName
TDMQ 主题名称
String
是

DigitalWatermark

节点名称(关键字)
描述
类型
是否必选
限制
Message
嵌入数字水印的水印信息
String
是
长度不超过64个字符,仅支持中文、英文、数字、_、-和*
Type
数字水印类型
String
是
当前仅可设置为 Text
Version
数字水印版本
String
是
当前仅可设置为 V1
IgnoreError
当添加水印失败是否忽略错误继续执行任务
String
否
限制为 true/false
State
添加水印是否成功,执行中为 Running,成功为 Success,失败为 Failed
String
否
该字段不能主动设置,当任务提交成功时,会返回该字段

DashEncrypt

节点名称(关键字)
描述
类型
是否必选
默认值
限制
IsEncrypt
是否开启 DASH 加密
String
否
false
true/false
UriKey
DASH 加密的 key
String
否
无
当 IsEncrypt 为 true 时,该参数才有意义

HlsEncrypt

节点名称(关键字)
描述
类型
是否必选
默认值
限制
IsEncrypt
是否开启 HLS 加密
String
否
false
true/false
UriKey
HLS 加密的 key
String
否
无
当 IsEncrypt 为 true 时,该参数才有意义

RemoveWatermark

节点名称(关键字)
描述
类型
是否必选
限制
Dx
距离左上角原点 x 偏移
String
是
值范围:[0, 4096]
单位:px
Dy
距离左上角原点 y 偏移
String
是
值范围:[0, 4096]
单位:px
Width
水印的宽度
String
是
值范围:(0, 4096]
单位:px
Height
水印的高度
String
是
值范围:(0, 4096]
单位:px

SmartCover

节点名称(关键字)
描述
类型
是否必选
默认值
限制
Format
图片格式
String
否
jpg
jpg、png 、webp
Width
宽
String
否
视频原始宽度
值范围:[128,4096]
单位:px
若只设置 Width 时,按照视频原始比例计算 Height
Height
高
String
否
视频原始高度
值范围:[128,4096]
单位:px
若只设置 Height 时,按照视频原始比例计算 Width
Count
截图数量
String
否
3
[1,10]
DeleteDuplicates
封面去重
String
否
false
true/false

Condition

节点名称(关键字)
描述
类型
是否必选
限制
Express
表达式详情
String
是
详情请参见 jsonLogic

Express

Express 表达式中的参数内容:
参数
描述
是否必选
限制
Duration
音视频时长
否
无
Height
音视频高
否
无
Width
音视频宽
否
无
Dar
音视频宽高比
否
无
ImageHeight
图片高
否
无
ImageWidth
图片宽
否
无
ImageDar
图片宽高比
否
无
Size
文件大小
否
无
Codec
视频编码格式
否
H.264
H.265
VP8
VP9
AV1
Bitrate
视频码率
否
无

MediaResult

Container 节点 MediaResult 的内容:
节点名称(关键字)
描述
类型
OutputFile
输出文件的基本信息
Container
Container 节点 OutputFile 的内容:
节点名称(关键字)
描述
类型
Bucket
输出文件所在的存储桶
String
Region
输出文件所在的存储桶所在的园区
String
ObjectName
输出文件名,可能有多个
String 数组
Md5Info
输出文件的 MD5 信息
Container 数组
Container 节点 Md5Info 的内容:
节点名称(关键字)
描述
类型
ObjectName
输出文件名
String
Md5
输出文件的 MD5 值
String