获取消息路由列表

最近更新时间:2024-03-12 01:33:17

我的收藏

1. 接口描述

接口请求域名: iecp.tencentcloudapi.com 。

获取消息路由列表

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMessageRouteList。
Version String 公共参数,本接口取值:2021-09-14。
Region String 公共参数,本接口不需要传递此参数。
Limit Integer
Offset Integer
Filter String
StartTime String
EndTime String
Order String

3. 输出参数

参数名称 类型 描述
RouteList Array of RouteInfo
TotalCount Integer
示例值:1000
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeMessageRouteList

输入示例

POST / HTTP/1.1
Host: iecp.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeMessageRouteList
<公共请求参数>

{
    "Filter": "a",
    "Limit": 10,
    "StartTime": "xx",
    "Offset": 0,
    "EndTime": "-",
    "Order": "DESC"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "RouteList": [
            {
                "Status": "off",
                "SourceUnitIDList": [],
                "SourceUnitNameList": [],
                "MessageCount": 0,
                "TopicFilter": "0data",
                "SourceProductName": "cp",
                "Descript": "",
                "MessageLastTime": "",
                "RouteID": 1000000,
                "Healthy": "yes",
                "RouteName": "a",
                "SourceProductID": "KMUOZ5EOXH",
                "Mode": "topic-datasource",
                "TargetOptions": "{\"DataSourceId\":1000000}",
                "SourceDeviceNameList": [
                    "cpp"
                ],
                "CreateTime": "2022-02-25 11:31:00"
            }
        ],
        "RequestId": "6aab2bdf-5f76-464b-859f-470e765d29e8"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InternalError.DBError 数据库异常。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.DuplicateName 名字冲突。
ResourceInsufficient 资源不足。
ResourceNotFound 资源不存在。
ResourceUnavailable 资源不可用。
ResourcesSoldOut 资源售罄。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。