1. 接口描述
接口请求域名： mps.tencentcloudapi.com 。
修改编排
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifySchedule。 |
| Version | 是 | String | 公共参数，本接口取值：2019-06-12。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| ScheduleId | 是 | Integer | 编排唯一标识。 示例值：20010 |
| ScheduleName | 否 | String | 编排名称。 示例值：“” |
| Trigger | 否 | WorkflowTrigger | 编排绑定的触发规则。 |
| Activities.N | 否 | Array of Activity | 编排任务列表。 注意：内部不允许部分更新，如果需要更新需全量提交编排任务列表。 |
| OutputStorage | 否 | TaskOutputStorage | 媒体处理的文件输出存储位置。 |
| OutputDir | 否 | String | 媒体处理生成的文件输出的目标目录，必选以 / 开头和结尾。 注意：如果设置为空，则表示取消老配置的OutputDir值。 |
| TaskNotifyConfig | 否 | TaskNotifyConfig | 任务的事件通知配置。 |
| ResourceId | 否 | String | 资源ID，需要保证对应资源是开启状态。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改编排
修改编排
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySchedule
<公共请求参数>
{
"ScheduleId": 22435,
"Trigger": {
"Type": "AwsS3FileUpload",
"AwsS3FileUploadTrigger": {
"S3Bucket": "evanxia-test",
"S3Region": "us-east-1",
"Dir": "/input/"
}
}
}输出示例
{
"Response": {
"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.GenerateResource | 生成资源失败。 |
| FailedOperation.InvalidMpsUser | 操作失败：非法 mps 用户。 |
| FailedOperation.InvalidUser | 操作失败：无效用户。 |
| InternalError | 内部错误。 |
| InternalError.AccessDBError | 数据错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound.TemplateNotExist | 资源不存在：模板不存在。 |
