1. 接口描述
接口请求域名: tiw.tencentcloudapi.com 。
查询白板应用任务相关的配置,包括存储桶、回调等
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeWhiteboardApplicationConfig。 |
Version | 是 | String | 公共参数,本接口取值:2019-09-19。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
SdkAppId | 是 | Integer | 客户的SdkAppId 示例值:1400000001 |
TaskTypes.N | 是 | Array of String | 需要查询的任务类型 recording: 实时录制 transcode: 文档转码 示例值:["transcode","recording"] |
SdkAppIds.N | 否 | Array of Integer | 需要查询配置的SdkAppId列表 示例值:[0] |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
SdkAppId | Integer | 客户的SdkAppId 示例值:1400127140 |
Configs | Array of WhiteboardApplicationConfig | 白板应用任务相关配置 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询应用资源配置
输入示例
POST / HTTP/1.1
Host: tiw.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeWhiteboardApplicationConfig
<公共请求参数>
{
"SdkAppId": 1400000001,
"TaskTypes": [
"transcode",
"recording"
]
}
输出示例
{
"Response": {
"Configs": [
{
"BucketLocation": "ap-nanjing",
"BucketName": "example-120000001",
"BucketPrefix": "video",
"Callback": "http://www.test.com",
"CallbackKey": "",
"ResultDomain": "example-120000001.cos.ap-nanjing.myqcloud.com",
"TaskType": "recording",
"SdkAppId": 1400127140
},
{
"BucketLocation": "ap-nanjing",
"BucketName": "example-120000001",
"BucketPrefix": "",
"Callback": "http://www.test.com/qcapi",
"CallbackKey": "abcde",
"ResultDomain": "example-120000001.cos.ap-nanjing.myqcloud.com",
"TaskType": "transcode",
"SdkAppId": 1400127140
}
],
"SdkAppId": 1400127140,
"RequestId": "9f5a59d6-2b77-41b2-a945-78084577e225"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
AuthFailure | CAM签名/鉴权错误。 |
FailedOperation | 操作失败。 |
InvalidParameter | 参数错误。 |
InvalidParameter.BodyParameterTypeUnmatched | 参数类型不匹配。 |
InvalidParameter.InvalidTaskType | 设置应用配置任务类型不支持。 |
InvalidParameter.SdkAppIdNotFound | SdkAppId不存在或格式错误。 |
ResourceUnavailable.NotRegistered | 未开通互动白板。 |
ResourceUnavailable.ServiceExpired | 账户欠费或者互动白板服务已过期。 |
UnauthorizedOperation.SdkAppId | SdkAppId不存在或者SdkAppId与当前腾讯云账号不对应。 |