1. 接口描述
接口请求域名： ckafka.tencentcloudapi.com 。
查看路由信息
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeRoute。 |
| Version | 是 | String | 公共参数，本接口取值：2019-08-19。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| InstanceId | 是 | String | ckafka集群实例Id 示例值：ckafka-test |
| RouteId | 否 | Integer | 路由Id 示例值：301 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | RouteResponse | 返回的路由信息结果集 示例值：{"Routers":[{"AccessType":0,"RouteId":301,"VipType":3,"VipList":[{"Vip":"1.0.0.5","Vport":"9092"}],"Domain":"","DomainPort":0,"DeleteTimestamp":1566144000,"InternalFlag":0,"UsedFor":"","Subnet":"subnet-test","BrokerVipList":[{"Vip":"1.0.0.5","Vport":"9093"},{"Vip":"1.0.0.5","Vport":"9094"},{"Vip":"1.0.0.5","Vport":"9095"}],"Processing":1,"VpcId":"vpc-test"}]} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查看路由信息
查看路由信息
输入示例
https://ckafka.tencentcloudapi.com/?Action=DescribeRoute
&InstanceId=ckafka-na37x9qa
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "972ab361-b677-4431-9f49-f54f8e1e62ab",
"Result": {
"Routers": [
{
"AccessType": 0,
"BrokerVipList": [
{
"Vip": "11.135.14.76",
"Vport": "7609"
},
{
"Vip": "11.135.14.76",
"Vport": "7610"
},
{
"Vip": "11.135.14.76",
"Vport": "7611"
}
],
"DeleteTimestamp": "",
"Domain": "",
"DomainPort": 0,
"RouteId": 136207,
"Subnet": "subnet-m7o87b20",
"VipList": [
{
"Vip": "11.135.14.76",
"Vport": "7608"
}
],
"VipType": 7,
"VpcId": "vpc-n3n50e5r"
},
{
"AccessType": 0,
"BrokerVipList": [
{
"Vip": "10.0.0.15",
"Vport": "9093"
},
{
"Vip": "10.0.0.15",
"Vport": "9094"
},
{
"Vip": "10.0.0.15",
"Vport": "9095"
}
],
"DeleteTimestamp": "",
"Domain": "",
"DomainPort": 0,
"RouteId": 137005,
"Subnet": "subnet-pu55o55e",
"VipList": [
{
"Vip": "10.0.0.15",
"Vport": "9092"
}
],
"VipType": 3,
"VpcId": "vpc-ktradax5"
},
{
"AccessType": 1,
"BrokerVipList": [
{
"Vip": "106.55.222.195",
"Vport": "50009"
},
{
"Vip": "106.55.222.195",
"Vport": "50010"
},
{
"Vip": "106.55.222.195",
"Vport": "50011"
}
],
"DeleteTimestamp": "",
"Domain": "ckafka-na37x9qa.ap-guangzhou.ckafka.tencentcloudmq.com",
"DomainPort": 50000,
"RouteId": 137270,
"Subnet": "",
"VipList": [
{
"Vip": "81.71.20.57",
"Vport": "50000"
}
],
"VipType": 1,
"VpcId": "vpc-ks7w9y0b"
},
{
"AccessType": 0,
"BrokerVipList": [
{
"Vip": "11.135.14.109",
"Vport": "8281"
},
{
"Vip": "11.135.14.109",
"Vport": "8282"
},
{
"Vip": "11.135.14.109",
"Vport": "8283"
}
],
"DeleteTimestamp": "",
"Domain": "",
"DomainPort": 0,
"RouteId": 137606,
"Subnet": "subnet-m7o87b20",
"VipList": [
{
"Vip": "11.135.14.109",
"Vport": "8280"
}
],
"VipType": 7,
"VpcId": "vpc-n3n50e5r"
}
]
}
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InstanceNotExist | 实例不存在。 |
| InvalidParameterValue.RepetitionValue | 已存在相同参数。 |
| InvalidParameterValue.SubnetIdInvalid | 无效的子网id。 |
| InvalidParameterValue.SubnetNotBelongToZone | 子网不属于zone。 |
| InvalidParameterValue.VpcIdInvalid | 无效的 Vpc Id。 |
| InvalidParameterValue.WrongAction | Action参数取值错误。 |
| InvalidParameterValue.ZoneNotSupport | zone不支持。 |
| ResourceNotFound | 资源不存在。 |
| ResourceUnavailable | 资源不可用。 |
| UnauthorizedOperation | 未授权操作。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.BatchDelInstanceLimit | 批量删除实例限制。 |
| UnsupportedOperation.OssReject | Oss拒绝该操作。 |
