1. 接口描述
接口请求域名: vod.tencentcloudapi.com 。
本接口仅用于定制开发的特殊场景,除非云点播客服人员主动告知您需要使用本接口,其它情况请勿调用。
默认接口请求频率限制:100次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ExecuteFunction。 |
Version | 是 | String | 公共参数,本接口取值:2018-07-17。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
FunctionName | 是 | String | 调用后端接口名称。 示例值:ExampleFunc |
FunctionArg | 是 | String | 接口参数,具体参数格式调用时与后端协调。 示例值:abc |
SubAppId | 否 | Integer | 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。 示例值:1490012345 |
SessionContext | 否 | String | 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。 示例值:"" |
SessionId | 否 | String | 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。 示例值:"" |
ExtInfo | 否 | String | 保留字段,特殊用途时使用。 示例值:"" |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | String | 处理结果打包后的字符串,具体与后台一同协调。 示例值:XXX |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 A 客户发起定制的视频处理
输入示例
https://vod.tencentcloudapi.com/?Action=ExecuteFunction
&FunctionName=ExampleFunc
&FunctionArg=XXX
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "8ad61e3a-6b8e-4b4e-9256-fdc701190064ef0",
"Result": "XXX"
}
}
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 | 操作失败。 |
FailedOperation.InvalidVodUser | 没有开通点播业务。 |
InternalError | 内部错误。 |
InvalidParameterValue.FunctionArg | 参数值错误:FunctionArg。 |
InvalidParameterValue.FunctionName | 参数值错误:FunctionName。 |
InvalidParameterValue.SessionContextTooLong | SessionContext 过长。 |
UnauthorizedOperation | 未授权操作。 |