調用ListTransitRouterVpnAttachment接口查詢VPN連接的狀態、IPsec連接ID、VPN連接的付費類型等信息。
接口說明
在您調用 ListTransitRouterVpnAttachments 接口的過程中支持以下三種查詢方式:
- 支持單獨輸入 TransitRouterAttachmentId 查詢則查詢指定 VPN 連接的信息。
- 支持單獨輸入 TransitRouterId 查詢當前轉發路由器下關聯的所有 VPN 連接的信息。
- 支持 CenId、RegionId 查詢當前云企業網中指定地域下的 VPN 連接的信息。
在調用 ListTransitRouterVpnAttachments 接口過程時請確保輸入的參數值無誤。如果您輸入的參數有誤調用接口后仍然會返回 RequestId 等信息,但不會顯示目標查詢 VPN 連接的信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:ListTransitRouterVpnAttachments | list |
|
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
CenId | string | 否 | 云企業網實例 ID。 | cen-rsgxs8ng2awen2**** |
RegionId | string | 否 | 轉發路由器實例所屬的地域 ID。 您可以通過調用 DescribeChildInstanceRegions 接口獲取地域 ID。 | cn-hangzhou |
TransitRouterAttachmentId | string | 否 | VPN 連接 ID。 | tr-attach-a6p8voaodog5c0**** |
TransitRouterId | string | 否 | 轉發路由器實例 ID。 | tr-p0wm740vjnbaprv0m**** |
MaxResults | integer | 否 | 分頁查詢時每頁顯示的條目數。默認值:20。 | 20 |
NextToken | string | 否 | 是否擁有下一次查詢的令牌(Token)。取值:
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
Tag | array<object> | 否 | 云企業網實例的標簽信息。 一次最多支持查詢 20 個標簽。 | |
object | 否 | |||
Key | string | 否 | 資源的標簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | tagtest |
Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標簽鍵對應一個標簽值,一次最多支持輸入 20 個標簽鍵對應的標簽值。 | value_A1 |
返回參數
示例
正常返回示例
JSON
格式
{
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"RequestId": "3D5530D2-3BBB-524E-8E98-59AB06A250E4",
"TotalCount": 1,
"MaxResults": 20,
"TransitRouterAttachments": [
{
"CreationTime": "2022-07-08T08:45Z",
"Status": "Attached",
"TransitRouterAttachmentId": "tr-attach-a6p8voaodog5c0****",
"TransitRouterId": "tr-p0wm740vjnbaprv0m****",
"ResourceType": "VPN",
"VpnOwnerId": 1210123456123456,
"VpnId": "vco-p0wtu1xgd0l7fjo7k****",
"TransitRouterAttachmentDescription": "desctest",
"VpnRegionId": "cn-hangzhou",
"AutoPublishRouteEnabled": true,
"TransitRouterAttachmentName": "nametest",
"Zones": [
{
"ZoneId": "cn-hangzhou-h"
}
],
"Tags": [
{
"Key": "test",
"Value": "value_A1"
}
],
"ChargeType": "POSTPAY",
"CenId": "cen-j3jzhw1zpau2km****\n",
"OrderType": "PayByCenOwner"
}
]
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | IllegalParam.NextToken | The specified NextToken is invalid. | NextToken是無效的。 |
400 | IllegalParam.TrInstance | The specified TransitRouter is invalid. | TransitRouter是無效的。 |
400 | IllegalParam.Region | The specified Region is invalid. | 參數中指定的Region不合法。 |
400 | IllegalParam.CenId | The specified CenId is invalid. | 云企業網實例ID非法。 |
400 | IllegalParam.CenIdOrRegionId | The specified CenId or RegionId is invalid. | 指定的CenId或RegionId不合法。 |
400 | IllegalParam.TransitRouterId | The specified TransitRouterId is illegal. | 參數中指定的TransitRouterId不合法。 |
400 | IllegalParam.MaxResults | The specified MaxResults is invalid. | 參數MaxResults不合法。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-03-01 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2022-12-22 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-09-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2022-09-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |