調(diào)用DescribeRouteEntryList查詢路由條目列表。
接口說明
調(diào)用 DeleteRouteEntry 接口刪除路由條目前，您可以調(diào)用本接口查詢要?jiǎng)h除的路由條目的下一跳信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口，免去您計(jì)算簽名的困擾。運(yùn)行成功后，OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息，可以在RAM權(quán)限策略語(yǔ)句的Action元素中使用，用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下：
- 操作：是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別：是指每個(gè)操作的訪問級(jí)別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權(quán)的資源類型。具體說明如下：
- 對(duì)于必選的資源類型，用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作，用
全部資源表示。
- 條件關(guān)鍵字：是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作：是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限，操作才能成功。
| 操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
|---|---|---|---|---|
| vpc:DescribeRouteEntryList | get | *RouteTable acs:vpc:{#regionId}:{#accountId}:routetable/{#RouteTableId} |
| 無 |
請(qǐng)求參數(shù)
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 路由條目所在路由表的地域 ID。 您可以通過調(diào)用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| RouteTableId | string | 是 | 要查詢的路由表的 ID。 | vtb-bp1r9pvl4xen8s9ju**** |
| RouteEntryId | string | 否 | 要查詢的路由條目的 ID。 | rte-bp1mnnr2al0naomnp**** |
| DestinationCidrBlock | string | 否 | 路由條目的目標(biāo)網(wǎng)段，支持 IPv4 和 IPv6 網(wǎng)段。 | 192.168.2.0/24 |
| RouteEntryName | string | 否 | 路由條目的名稱。 名稱長(zhǎng)度為 1～128 個(gè)字符，不能以 | abc |
| IpVersion | string | 否 | IP 協(xié)議的版本。取值：
| ipv4 |
| RouteEntryType | string | 否 | 路由的類型。取值：
| System |
| NextHopId | string | 否 | 下一跳實(shí)例 ID。 | vpn-bp10zyaph5cc8b7c7**** |
| NextHopType | string | 否 | 下一跳類型。取值：
| Instance |
| MaxResult | integer | 否 | 分批次查詢時(shí)每次顯示的條目數(shù)。取值范圍：1~100，默認(rèn)值為 10。 | 10 |
| NextToken | string | 否 | 是否擁有下一次查詢的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| ServiceType | string | 否 | 路由托管的類型。如果該字段為空，即表示該路由沒有被托管。 取值：TR，表示托管類型為轉(zhuǎn)發(fā)路由器類型。 | TR |
| DestCidrBlockList | array | 否 | 路由條目的目標(biāo)網(wǎng)段列表。 | |
| string | 否 | 路由條目的目標(biāo)網(wǎng)段列表信息。最多支持輸入 20 個(gè)目標(biāo)網(wǎng)段。 | 192.168.0.0/24 |
返回參數(shù)
示例
正常返回示例
JSON格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "14A07460-EBE7-47CA-9757-12CC4761D47A",
"RouteEntrys": {
"RouteEntry": [
{
"Status": "Available",
"Type": "System",
"IpVersion": "ipv4",
"Description": "RouteEntryDescription",
"RouteEntryName": "aaa",
"DestinationCidrBlock": "192.168.2.0/24",
"RouteEntryId": "rte-bp1mnnr2al0naomnp****",
"RouteTableId": "vtb-bp15w5q90d2rk3bww****",
"GmtModified": "2022-05-09T03:00:07Z",
"NextHops": {
"NextHop": [
{
"NextHopRegionId": "cn-hangzhou",
"Weight": 100,
"NextHopId": "vpn-bp10zyaph5cc8b7c7****",
"Enabled": 1,
"NextHopType": "Instance",
"NextHopRelatedInfo": {
"InstanceId": "vpc-bp1t36rn9l53iwbsf****",
"InstanceType": "VPC",
"RegionId": "ch-hangzhou"
}
}
]
},
"ServiceType": "TR",
"Origin": "RoutePropagation"
}
]
}
}錯(cuò)誤碼
| HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | User nextToken is illegal. | - |
| 400 | InvalidNextHop.NotFound | The specified route entry nexthop does not exist in our records. | - |
| 400 | OperationFailed.QueryCenEntry | Operation is denied because getting CEN route entry has failed. | 由于暫時(shí)無法獲取云企業(yè)網(wǎng)路由導(dǎo)致查詢失敗。 |
| 400 | OperationDenied.UseGatewayRouteEntryQueryInterface | Use listGatewayRouteTableEntries to describe gateway route entries. | 查詢網(wǎng)關(guān)路由表路由條目，請(qǐng)使用listGatewayRouteTableEntries接口。 |
| 400 | InvalidRouteTable.NotFound | The specified RouteTable was not found. | 指定的路由表未找到。 |
| 400 | IllegalParam.RouteEntryType | The parameter of RouteEntryType is illegal. | 參數(shù)RouteEntryType非法。 |
| 400 | MissingParam.context | The param of context is missing. | 參數(shù)context缺失。 |
| 400 | MissingParam.aliUid | The param of aliUid is missing. | 參數(shù)aliUid缺失。 |
| 400 | MissingParam.bid | The param of bid is missing. | 參數(shù)bid缺失。 |
| 400 | IllegalParam.IpVersion | Param IpVersion illegal. | 非法參數(shù)：IpVersion。 |
| 400 | OperationFailed.FilterParamUnderWrongRouteType | Operation failed because only custom type support filter by routeEntryId or routeEntryName | 操作失敗，只有自定義路由條目才支持通過路由條目id或路由條目名進(jìn)行過濾 |
| 400 | IllegalParam.NextTokenExpired | The parameter of NextTokenExpired is illegal. | 參數(shù)NextTokenExpired非法。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
| 變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
|---|---|---|
| 2024-08-26 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
| 2024-01-05 | OpenAPI 描述信息更新、OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 返回結(jié)構(gòu)發(fā)生變更 | 查看變更詳情 |
| 2023-07-03 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |