消息队列 CKafka 版查询安全组路由信息列表

1. 接口描述

接口请求域名： ckafka.tencentcloudapi.com 。

获取安全组路由信息列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeSecurityGroupRoutes。
Version	是	String	公共参数，本接口取值：2019-08-19。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceRoute	否	InstanceRoute	路由信息示例值：{"instanceId":"ckafka-test", "routeId":301}
Filters.N	否	Array of RouteFilter	过滤器示例值：[{"Name":"filtername-test","TagValue":["filtervalue-test"]}]
Offset	否	Integer	分页Offset,默认0 示例值：0
Limit	否	Integer	分页Limit,默认20 示例值：10
SearchWord	否	String	关键词,可根据实例id/实例名称/vip模糊搜索示例值：group-test

3. 输出参数

参数名称	类型	描述
Result	SecurityGroupRouteResp	返回的安全组路由信息结果对象示例值：{"securityGroupRoutes":[{"instanceRoute":{"instanceId":"ckafka-test", "routeId":301},"securityGroupIds":["sg-test"], "InstanceName":"ckafka测试","vpcId":"vpc-test","vip":"10.0.0.5"}], "returnMessage":"success"}
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取安全组路由信息列表

输入示例

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

{
    "Offset": 0,
    "Limit": 10
}

输出示例

{
    "Response": {
        "Result": {
            "SecurityGroupRoutes": [
                {
                    "InstanceRoute": {
                        "InstanceId": "ckafka-test",
                        "RouteId": 1234
                    },
                    "SecurityGroupIds": [],
                    "InstanceName": "ckafka测试",
                    "VpcId": "vpc-test",
                    "Vip": "10.0.0.5"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "test-reqId-1134"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
InternalError	内部错误。
InvalidFilter	无效的过滤器
InvalidParameter	参数错误。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
UnsupportedOperation	操作不支持。

查询安全组路由信息列表

本页目录：