调用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 返回结构发生变更 | 查看变更详情 |