調用ListIpsecServers接口查看已創建的IPsec服務端。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| vpc:ListIpsecServers | list | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | IPsec 服務端所屬地域 ID。 您可以通過調用 DescribeRegions 接口獲取地域 ID。 | cn-hangzhou |
| IpsecServerName | string | 否 | IPsec 服務端名稱。 名稱長度為 1～100 個字符。 | test |
| VpnGatewayId | string | 否 | VPN 網關的 ID。 | vpn-bp1q8bgx4xnkm2ogj**** |
| NextToken | string | 否 | 是否擁有下一次查詢的令牌（Token）。取值：
| caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults | integer | 否 | 分頁大小，取值范圍：1~20，默認值：10。 | 10 |
| IpsecServerId | array | 否 | IPsec 服務端 ID。 | |
| string | 否 | IPsec 服務端 ID。N 的取值范圍：1~20。 | iss-bp1bo3xuvcxo7ixll**** | |
| ResourceGroupId | string | 否 | IPsec 服務端所屬的資源組 ID。 IPsec 服務端與其關聯的 VPN 網關實例的資源組相同。您可以調用 DescribeVpnGateway 接口查詢 VPN 網關實例所屬的資源組 ID。 | rg-acfmzs372yg**** |
返回參數
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
"TotalCount": 10,
"MaxResults": 1,
"IpsecServers": [
{
"CreationTime": "2018-12-03T10:11:55Z",
"OnlineClientCount": 1,
"InternetIp": "47.22.XX.XX",
"IpsecServerName": "test",
"IDaaSInstanceId": "idaas-cn-hangzhou-****",
"EffectImmediately": false,
"VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
"LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
"Psk": "pgw6dy7d****",
"RegionId": "cn-hangzhou",
"PskEnabled": true,
"IpsecServerId": "iss-bp1bo3xuvcxo7ixll****",
"MultiFactorAuthEnabled": true,
"MaxConnections": 5,
"ClientIpPool": "10.0.0.0/24",
"IkeConfig": {
"RemoteId": "139.67.XX.XX",
"IkeLifetime": 86400,
"IkeEncAlg": "aes",
"LocalId": "116.64.XX.XX",
"IkeMode": "main",
"IkeVersion": "ikev2",
"IkePfs": "group2",
"IkeAuthAlg": "sha1"
},
"IpsecConfig": {
"IpsecAuthAlg": "sha1",
"IpsecLifetime": 86400,
"IpsecEncAlg": "aes",
"IpsecPfs": "group2"
},
"ResourceGroupId": "rg-acfmzs372yg****"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | 參數NextToken非法. |
| 403 | Forbidden | User not authorized to operate on the specified resource. | 您沒有權限操作指定資源，請申請權限后再操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |