調用ListTransitRouters接口查詢云企業網實例下轉發路由器實例的實例類型、實例的狀態、轉發路由器實例ID、是否開啟了組播功能等信息。
接口說明
在您調用本接口查詢云企業網實例下轉發路由器實例的信息時,您可以按需填寫參數 RegionId 和 TransitRouterId,關于這兩個參數的關系,請參見以下說明:
- 如果您未輸入 RegionId 和 TransitRouterId 的值,則表示您要查詢云企業網實例下所有轉發路由器實例的信息。
- 如果您只輸入了 RegionId 的值,則表示您要查詢云企業網實例指定地域下的轉發路由器實例的信息。
- 如果您只輸入了 TransitRouterId 的值,則表示您要查詢云企業網實例中指定的轉發路由器實例的信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:ListTransitRouters | get |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
PageNumber | integer | 否 | 列表的頁碼。默認值:1。 | 1 |
PageSize | integer | 否 | 分頁查詢時每頁顯示的條目數。取值范圍:1~50。默認值:10。 | 10 |
CenId | string | 是 | 云企業網實例 ID。 | cen-j3jzhw1zpau2km**** |
TransitRouterId | string | 否 | 轉發路由器實例 ID。 | tr-uf654ttymmljlvh2x**** |
RegionId | string | 否 | 轉發路由器實例所屬地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
object | 否 | 標簽信息。 | ||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
Status | string | 否 | 轉發路由器實例的狀態。
| Active |
Type | string | 否 | 轉發路由器實例的類型。
| Enterprise |
TransitRouterName | string | 否 | 轉發路由器實例的名稱。 名稱長度為 1~128 個字符不能以 | testname |
FeatureFilter | array<object> | 否 | 轉發路由器功能篩選字段。 | |
object | 否 | 轉發路由器功能篩選字段。 | ||
Key | string | 否 | 轉發路由器功能篩選字段鍵值。 目前支持字段:
| Multicast |
Value | array | 否 | 轉發路由器功能篩選字段值列表。 當鍵值為 Multicast 時,只支持填入 1 個字段,支持字段內容為:
| |
string | 否 | 轉發路由器功能篩選字段值。 當鍵值為 Multicast 時支持字段為:
| Enabled |
返回參數
示例
正常返回示例
JSON
格式
{
"PageSize": 10,
"RequestId": "68521297-5FA6-46CB-B4EB-658F1C68C8CC",
"PageNumber": 1,
"TotalCount": 1,
"TransitRouters": [
{
"CreationTime": "2021-03-15T09:39Z",
"Type": "Enterprise",
"Status": "Active",
"TransitRouterId": "tr-bp1su1ytdxtataupl****",
"TransitRouterDescription": "testdesc",
"TransitRouterName": "testname",
"CenId": "cen-j3jzhw1zpau2km****",
"AliUid": 1210123456123456,
"RegionId": "cn-hangzhou",
"SupportMulticast": false,
"TransitRouterCidrList": [
{
"Cidr": "192.168.1.0/24",
"Name": "CIDRname",
"Description": "CIDRdesc",
"TransitRouterCidrId": "cidr-46p5ceg21e8152****",
"PublishCidrRoute": true
}
],
"Tags": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidParameterCombination.TransitRouter | Region ID is required if no TransitRouterId or CenId specified. | 至少需要傳入Region,TransitRouterId 或CenId三者中的一個。 |
400 | InvalidOperation.UnsupportFilterValue | The specified FeatureFilter Value is not supported by this operation. | 參數中指定的FeatureFilter Value不合法。 |
400 | InvalidOperation.UnsupportFilter | The specified FeatureFilter is not supported by this operation. | 參數中指定的FeatureFilter不合法。 |
400 | IllegalParam.TagValue | The tag values are not valid. | 參數中指定的tag value不合法。 |
400 | IllegalParam.TagKey | The tag keys are not valid. | 參數中指定的tag key不合法。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-10-18 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-01-09 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |