1. 接口描述
接口请求域名: iotvideo.tencentcloudapi.com 。
获取产品转发规则
默认接口请求频率限制:5000次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeForwardRule。 |
Version | 是 | String | 公共参数,本接口取值:2021-11-25。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
ProductID | 是 | String | 产品ID 示例值:PTROMP3AOB |
Skey | 是 | String | 控制台Skey 示例值:safaweffawef |
QueueType | 是 | Integer | 队列类型,0:CMQ,1:Ckafka 示例值:1 |
Consecretid | 否 | String | 临时密钥 示例值:safawef |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Endpoint | String | 腾讯云账号 示例值:1242345132 |
QueueName | String | 队列名称 示例值:topic-fawe |
ProductID | String | 产品ID 示例值:PTROMP3AOB |
MsgType | Integer | 消息类型 1设备上报信息 2设备状态变化通知 3为全选 示例值:1 |
Result | Integer | 结果 2表示禁用 其他为成功 示例值:1 |
RoleName | String | 角色名 示例值:role |
RoleID | Integer | 角色ID 示例值:123 |
QueueRegion | String | 队列区域 示例值:gz |
QueueType | Integer | 队列类型,0:CMQ,1:Ckafka 示例值:1 |
InstanceId | String | 实例id, 目前只有Ckafka会用到 示例值:kafka-f123fasef |
InstanceName | String | 实例名称,目前只有Ckafka会用到 示例值:kafka-test |
ErrMsg | String | 错误消息 示例值:ok |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取产品转发规则
获取产品转发规则
输入示例
POST / HTTP/1.1
Host: iotvideo.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeForwardRule
<公共请求参数>
{
"Skey": "1213123",
"QueueType": 1,
"Consecretid": "fawefwe",
"ProductID": "PTROMP3AOB"
}
输出示例
{
"Response": {
"Endpoint": "1234141234",
"QueueType": 1,
"InstanceId": "topic-123aw",
"RoleID": 123,
"Result": 1,
"MsgType": 1,
"RequestId": "2172b7d1-9a49-4142-938a-ff4fa3d55881",
"QueueRegion": "gz",
"RoleName": "role-fawe",
"InstanceName": "kafka-test",
"QueueName": "kafka-t1132",
"ErrMsg": "",
"ProductID": "PTROMP3AOB"
}
}
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 | 参数错误。 |
UnsupportedOperation | 操作不支持。 |