Queries IPsec servers.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action
policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resources
is used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
Operation | Access level | Resource type | Condition key | Associated operation |
---|---|---|---|---|
vpc:ListIpsecServers | list | *All Resources * |
| none |
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
RegionId | string | Yes | The ID of the region where the IPsec server is created. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
IpsecServerName | string | No | The name of the IPsec server. The name must be 1 to 100 characters in length and cannot start with | test |
VpnGatewayId | string | No | The ID of the VPN gateway. | vpn-bp1q8bgx4xnkm2ogj**** |
NextToken | string | No | The pagination token that is used in the next request to retrieve a new page of results. Valid values:
| caeba0bbb2be03f84eb48b699f0a**** |
MaxResults | integer | No | The number of entries to return on each page. Valid values: 1 to 20. Default value: 10. | 10 |
IpsecServerId | array | No | The ID of the IPsec server. | |
string | No | The ID of the IPsec server. Valid values of N: 1 to 20. | iss-bp1bo3xuvcxo7ixll**** | |
ResourceGroupId | string | No | The ID of the resource group to which the IPsec server belongs. The IPsec server has the same resource group as its associated VPN gateway instance. You can call the DescribeVpnGateway operation to query the ID of the resource group to which the VPN gateway instance belongs. | rg-acfmzs372yg**** |
Response parameters
Examples
Sample success responses
JSON
format
{
"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****"
}
]
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | IllegalParam.NextToken | The specified NextToken is invalid. | The specified NextToken is invalid. |
403 | Forbidden | User not authorized to operate on the specified resource. | You do not have the permissions to manage the specified resource. Apply for the permissions and try again. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-10-19 | API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |