1. 接口描述
接口请求域名: trro.tencentcloudapi.com 。
设置回调URL
录制回调事件内容参考:https://cloud.tencent.com/document/product/647/81113
转推回调事件内容参考:https://cloud.tencent.com/document/product/647/88552
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyCallbackUrl。 |
Version | 是 | String | 公共参数,本接口取值:2022-03-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProjectId | 是 | String | 项目id 示例值:m82k541ovkfsub1h |
CallbackUrl | 是 | String | 回调URL 示例值:http://123.1.1.1/cb_url |
SignKey | 否 | String | 回调签名密钥,用于校验回调信息的完整性 示例值:abcd1234 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Code | Integer | 响应码,0:成功,其他:失败 示例值:0 |
Msg | String | 响应消息,ok:成功,其他:失败 示例值:ok |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 设置回调URL
输入示例
POST / HTTP/1.1
Host: trro.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyCallbackUrl
<公共请求参数>
{
"ProjectId": "m82k5408n123phvb",
"CallbackUrl": "http://123.45.81.121:9999",
"SignKey": "abcd1234"
}
输出示例
{
"Response": {
"Code": 0,
"Msg": "ok",
"RequestId": "c1f72a62-e199-4d04-bf2c-ee3e97a3c4af"
}
}
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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |