VMRack
首页
产品
解决方案
定价
支持
推广联盟
开发者中心
OpenApi签名规则
地域和Endpoint
队列管理
删除队列
创建队列
修改队列
队列列表
转码任务
创建任务
重试任务
任务详情
删除任务
任务列表
批量删除任务
获取可选择的任务处理类型
批量重试任务
预设管理
创建预设
预设详情
删除预设
更新预设
预设列表
工作流管理
创建工作流
复制工作流
查询工作流
删除工作流
修改工作流
工作流列表
域名管理
查询域名列表
对象信息管理
Object - 获取对象信息
Object - 删除对象
Object - 中断分片上传、复制、移动、修改存储类型任务
Object - 完成分片复制、移动、修改存储类型任务
Object - 复制对象
Object - 创建分片复制、移动、修改存储类型任务
Object - 创建目录
Object - 删除目录
Object - 获取对象列表
Object - 获取元数据
Object - 更新元数据
Object - 移动对象
Object - 执行分片复制、移动、修改存储类型
Object - 完成分片上传任务
Object - 创建分片上传任务
Object - 预下载
Object - 预签
Object - 修改对象存储类型
桶信息管理
Bucket - 清空所有桶数据
Bucket - 查询桶信息
Bucket - 创建桶
Bucket - 删除桶(包括桶内数据)
Bucket - 修改桶访问控制权限
Bucket - 获取跨域配置
Bucket - 更新跨域配置
Bucket - 创建跨域配置
Bucket - 删除跨域配置
Bucket - 获取跨域配置列表
Bucket - 查询桶生命周期列表
Bucket - 更新桶生命周期
Bucket - 创建桶生命周期
Bucket - 删除桶生命周期
Bucket - 查询桶列表
Bucket - 修改客户端缓存Maxage
Bucket - 获取防盗链配置
Bucket - 编辑防盗链配置
版本说明
  1. 开发者中心
  2. /
  3. 工作流管理
  4. /
  5. 工作流列表

工作流列表

工作流列表

请求参数

offsetnumber
选填

起始条数,默认为0

limitnumber
选填

分页条数,0-500条

sortstring
选填

排序字段,可选值:created_at,updated_at

orderstring
选填

排序方式,可选值:asc,desc

workflow_namestring
选填

工作流名称,1-100个字符

响应参数

listobject[]
选填

工作流列表

idstring
选填

工作流ID

workflow_namestring
选填

工作流名称

user_idstring
选填

用户ID

region_idstring
选填

区域ID

workflow_detailsobject
选填
listobject[]
选填

工作流节点列表

workflow_typenumber
选填

工作流节点类型

1: 普通转码

2: 视频拼接

3: 截图

4: 输出

basic_transcoding_paramsobject
选填

普通转码配置

transcoding_preset_idstring
选填

转码预设ID

watermark_preset_idsstring[]
选填

水印预设ID列表

container_formatnumber
选填

封装格式

0: MP4

1: MKV

2: HLS

video_paramsobject
选填

视频参数

codecnumber
选填

视频编码格式

0: H264

1: H265

2: AV1

bitrate_paramsobject
选填

码率配置

bitrate_typenumber
选填

码率配置类型

0: 默认

1: 固定码率

2: CRF

valuenumber
选填

码率配置值

resolution_paramsobject
选填

分辨率配置

resolution_typenumber
选填

分辨率配置类型

0: 原分辨率

1: 4K

2: 2K

3: 1080P

4: 720P

5: 480P

6: 自定义分辨率

widthnumber
选填

分辨率宽度

heightnumber
选填

分辨率高度

aspect_paramsobject
选填

显示宽高比配置

aspect_typenumber
选填

显示宽高比配置类型

0: 原宽高比

1: 16:10

2: 16:9

3: 4:3

4: 1:1

5: 自定义宽高比

widthnumber
选填

自定义显示宽度

heightnumber
选填

自定义显示高度

remove_black_barsboolean
选填

是否去除黑边

video_scalingobject
选填

缩放配置,为null表示不设置

scaling_typenumber
选填

缩放配置类型

0: 拉伸平铺

1: 等比例留黑

framerate_paramsobject
选填

视频帧率配置,为null表示不设置

valuenumber
选填

自定义帧率值

gop_paramsobject
选填

关键帧配置,为null表示不设置

valuenumber
选填

自定义关键帧值

clip_segment_paramsobject
选填

片段截取配置,为null表示不设置

start_timenumber
选填

开始时间(秒)

durationnumber
选填

持续时间(秒)

segment_durationnumber
选填

分段时长, HLS 类型时必填

audio_paramsobject
选填

音频参数

disable_audioboolean
选填

是否禁用音频

codecnumber
选填

音频编码格式

0: 默认

2: MP3

1: AAC

3: ACC_HE

channelsnumber
选填

音频通道数配置,0表示原数量不变。注意通道数需要跟音频编码对应,否则可能会导致转码异常或输出视频异常

bitrate_paramsobject
选填

音频码率配置

bitrate_typenumber
选填

音频码率配置类型

0: 默认

1: 96k

2: 128K

3: 192K

4: 256K

5: 320K

6: 自定义

valuenumber
选填

音频码率配置值

sample_rate_paramsobject
选填

音频采样率配置

sample_rate_typenumber
选填

音频采样率配置类型

0: 默认

1: 8000

2: 11025

3: 12000

4: 16000

5: 22050

6: 24000

7: 32000

8: 44100

9: 48000

10: 64000

11: 88200

12: 96000

20: 自定义

valuenumber
选填

音频采样率配置值

subtitle_paramsobject
选填

字幕参数

disable_subtitleboolean
选填

是否禁用字幕

subtitle_fileobject
选填

输入文件列表

bucketstring
选填

bucket名称

object_namestring
选填

对象名称

ffy_oss_idstring
选填

云存储数据ID

subtitle_placeholdernumber
选填

字幕序号,从1开始有序,为0表示不添加字幕

hardcode_subtitleboolean
选填

是否将软字幕转为硬字幕

subtitle_indexnumber
选填

字幕索引号,从0起有序

watermark_paramsobject
选填

水印参数

watermark_listobject[]
选填

水印列表

watermark_typenumber
选填

水印类型

0: 文字

1: 图片

watermark_text_paramsobject
选填

文字水印配置

textstring
选填

文字水印内容

fontnumber
选填

水印文字字体

0: 方正宋体

1: 方正黑体

2: 方正楷体

3: MapleMono

font_sizenumber
选填

文字水印字体大小(PX)

font_colorstring
选填

文字水印颜色

add_borderboolean
选填

是否添加文字描边

border_widthnumber
选填

边框宽度(1-5PX)

border_colorstring
选填

边框颜色(十六进制颜色值)

border_opacitynumber
选填

边框透明度(0-1.0)

italicboolean
选填

是否斜字

boldboolean
选填

是否加粗

watermark_image_paramsobject
选填

图片水印配置

image_fileobject
选填

输入文件列表

bucketstring
选填

bucket名称

object_namestring
选填

对象名称

ffy_oss_idstring
选填

云存储数据ID

image_scaling_paramsobject
选填

图片缩放配置

rationumber
选填

缩放比例,(0-1],水印与视频尺寸的比例

watermark_positionnumber
选填

水印位置

0: 左上

4: 中上

2: 右上

1: 左中

5: 正中

3: 右中

6: 左下

7: 中下

8: 右下

margin_xnumber
选填

水印横向边距(PX)

margin_ynumber
选填

水印纵向边距(PX)

watermark_timeline_paramsobject
选填

水印时间线配置

start_typenumber
选填

水印时间线开始类型

0: 从片头开始

1: 从片尾开始

start_timenumber
选填

开始时间(秒)

durationnumber
选填

持续时间(秒)

watermark_animationboolean
选填

水印动画

watermark_end_positionnumber
选填

水印位置

0: 左上

4: 中上

2: 右上

1: 左中

5: 正中

3: 右中

6: 左下

7: 中下

8: 右下

watermark_end_margin_xnumber
选填

水印结束横向边距(PX)

watermark_end_margin_ynumber
选填

水印结束纵向边距(PX)

watermark_animation_time_modenumber
选填

水印动画时间模式

0: 一次

1: 循环

watermark_animation_start_timenumber
选填

水印动画开始时间(秒)

watermark_animation_intervalnumber
选填

水印动画间隔(秒)

watermark_animation_durationnumber
选填

水印动画显示时间(秒)

video_concatenation_paramsobject
选填

视频拼接配置

concatenation_preset_idstring
选填

拼接预设ID

container_formatnumber
选填

视频拼接封装格式

0: MP4

1: MKV

resolution_paramsobject
选填

分辨率配置

resolution_typenumber
选填

分辨率配置类型

0: 原分辨率

1: 4K

2: 2K

3: 1080P

4: 720P

5: 480P

6: 自定义分辨率

widthnumber
选填

分辨率宽度

heightnumber
选填

分辨率高度

max_bitrateobject
选填

峰值码率配置,为null表示不设置

valuenumber
选填

峰值码率配置值

input_filesobject[]
选填

拼接输入文件列表

bucketstring
选填

bucket名称

object_namestring
选填

对象名称

ffy_oss_idstring
选填

云存储数据ID

pad_audioboolean
选填

是否为无音轨视频填充音频

add_black_bordersboolean
选填

是否加黑边

source_indexnumber
选填

源视频的位置,0表示索引的第一个视频

screenshot_paramsobject
选填

截图配置

screenshot_preset_idstring
选填

截图预设ID

screenshot_typenumber
选填

截图类型

0: 单张

1: 多张

container_formatnumber
选填

截图封装格式

0: JPEG

1: PNG

resolution_paramsobject
选填

分辨率配置

resolution_typenumber
选填

分辨率配置类型

0: 原分辨率

1: 4K

2: 2K

3: 1080P

4: 720P

5: 480P

6: 自定义分辨率

widthnumber
选填

分辨率宽度

heightnumber
选填

分辨率高度

start_timenumber
选填

截图开始时间(秒)

durationnumber
选填

截图时长(秒),多张截图必填

intervalnumber
选填

截图间隔(秒),多张截图必填

interval_typenumber
选填

截图间隔类型

0: 秒

1: 百分比

interval_percentnumber
选填

截图间隔百分比(1-100)

time_modenumber
选填

批量截图时间选取模式

0: 精确时间

1: 百分比区间

start_percentnumber
选填

截图开始百分比(仅百分比区间模式有效)

end_percentnumber
选填

截图结束百分比(仅百分比区间模式有效)

screenshot_countnumber
选填

截图数量,仅百分比区间模式有效

output_paramsobject
选填

输出配置

bucketstring
选填

输出bucket

pathstring
选填

输出路径,如aa/bb

file_name_prefixstring
选填

输出文件名前缀

ts_name_prefixstring
选填

TS文件名前缀

file_name_suffixstring
选填

文件后缀名,如mp4/mkv/png/jpg/zip

bucket_idstring
选填

bucket ID

ts_file_name_stylenumber
选填

TS文件名风格

child_workflowsRecord<string, unknown>[]
选填

子节点列表

indexnumber
选填

工作流节点索引

workflow_statusnumber
选填

转码工作流状态

0: 待执行

1: 处理中

2: 处理成功

3: 处理失败

fail_reasonstring
选填

工作流节点失败原因

created_atstring
选填

创建时间(unix时间戳)

updated_atstring
选填

更新时间(unix时间戳)

totalstring
选填

总数

响应示例

{
  "list": [
    {
      "id": "10000000000000000001",
      "workflow_name": "WorkflowA",
      "user_id": "10000000000000000001",
      "region_id": "10000000000000000001",
      "workflow_details": {
        "list": [
          {
            "workflow_type": 1,
            "basic_transcoding_params": {
              "transcoding_preset_id": "10000000000000000001",
              "watermark_preset_ids": [
                "10000000000000000001"
              ],
              "container_format": 0,
              "video_params": {
                "codec": 0,
                "bitrate_params": {
                  "bitrate_type": 0,
                  "value": 1000
                },
                "resolution_params": {
                  "resolution_type": 0,
                  "width": 1920,
                  "height": 1080
                }
              },
              "audio_params": {
                "disable_audio": false,
                "codec": 0,
                "channels": 2,
                "bitrate_params": {
                  "bitrate_type": 2,
                  "value": 128
                }
              },
              "subtitle_params": {
                "disable_subtitle": false
              }
            },
            "index": 0,
            "workflow_status": 0,
            "fail_reason": ""
          }
        ]
      },
      "created_at": 1700000000,
      "updated_at": 1700000000
    }
  ],
  "total": 20
}
VMRack
  • 产品
  • 云服务器
  • 云服务器
    无限流量
  • 裸金属
  • GPU算力租用
  • CDN
    公测
  • 定制CDN
  • 对象存储
    公测
  • 云转码
    公测
  • 解决方案
  • BYOIP自有IP
  • 硬件定制
  • 服务器托管
  • 资源
  • 定价
  • 帮助文档
  • 专题文章
  • 开发者中心
  • 推广联盟
  • 联系销售
  • 公司
  • 关于我们
  • 服务协议
  • 用户协议
  • 隐私政策
  • 服务等级