调用DescribeVcoRouteEntries接口查询IPsec连接下路由条目的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
vpc:DescribeVcoRouteEntries | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | IPsec 连接所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-hangzhou |
VpnConnectionId | string | 是 | IPsec 连接 ID。 | vco-p0w2jpkhi2eeop6q6**** |
RouteEntryType | string | 否 | 路由条目类型。取值:
| custom |
PageNumber | integer | 否 | 列表的页码。默认值:1。 | 1 |
PageSize | integer | 否 | 分页查询时每页的条目数。默认值:10。取值范围:1~50。 | 10 |
ClientToken | string | 否 | 客户端 Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。 说明
若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
| 123e4567-e89b-12d3-a456-4266**** |
返回参数
示例
正常返回示例
JSON
格式
{
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10,
"VcoRouteEntries": [
{
"VpnConnectionId": "vco-p0w2jpkhi2eeop6q6****",
"RouteDest": "192.168.10.0/24",
"NextHop": "vco-p0w2jpkhi2eeop6q6****",
"Weight": 100,
"State": "published",
"RouteEntryType": "custom",
"CreateTime": 1658217008000,
"AsPath": "[12000]",
"Community": "65535:65510",
"Source": "CLOUD",
"NextHopTunnelIdList": [
""
]
}
],
"RequestId": "E18980E8-C8C2-31BD-8156-AE2BBDEC87E1",
"VpnRouteCounts": [
{
"RouteEntryType": "",
"RouteCount": 0,
"Source": ""
}
]
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | IllegalParam.RouteEntryType | The specified RouteEntryType is invalid. | 指定的路由条目类型不合规范。 |
400 | Vco.StatusNotSupport | The current VPN connection state does not support this operation. | 当前的实例状态不支持该操作 |
403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | 您没有权限操作该资源,请您申请操作权限后再试。 |
403 | Forbidden | User not authorized to operate on the specified resource. | 您没有权限操作指定资源,请申请权限后再操作。 |
404 | InvalidVpnConnectionInstanceId.NotFound | The specified vpn connection instance id does not exist. | 指定的VPN连接不存在,请您检查该VPN连接ID是否正确。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-10-24 | OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更 | 查看变更详情 |