Modifies the configuration of an IPsec server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes UpdateIpsecServer

The operation that you want to perform. Set the value to UpdateIpsecServer.

IpsecServerId String Yes iss-bp1bo3xuvcxo7ixll****

The ID of the IPsec server.

RegionId String Yes cn-shanghai

The ID of the region where the IPsec server is created.

You can call the DescribeRegions operation to query region IDs.

LocalSubnet String No 192.XX.XX.0/24,10.XX.XX.0/24

The local CIDR block. It refers to the CIDR block of the virtual private cloud (VPC) that is used to connect with the client.

Separate multiple CIDR blocks with commas (,). Example: 192.168.1.0/24,192.168.2.0/24.

ClientIpPool String No 10.XX.XX.0/24

The client CIDR block. It refers to the CIDR block that is allocated to the virtual interface of the client.

IpsecServerName String No test

The name of the IPsec server.

The name must be 2 to 128 characters in length, and can contain digits, periods (.), underscores (_), and hyphens (-). It must start with a letter.

EffectImmediately Boolean No false

Specifies whether to delete the current IPsec tunnel and reinitiate negotiations. Valid values:

  • true: initiates negotiations after the configuration is complete.
  • false (default): initiates negotiations when inbound traffic is detected.
IkeConfig String No {"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}

The configuration of Phase 1 negotiations.

  • IkeVersion: The IKE version. Valid values: ikev1 and ikev2. Default value: ikev2.
  • IkeMode: The IKE negotiation mode. Default value: main.
  • IkeEncAlg: The encryption algorithm that is used in Phase 1 negotiations. Default value: aes.
  • IkeAuthAlg: The authentication algorithm that is used in Phase 1 negotiations. Default value: sha1.
  • IkePfs: The Diffie-Hellman key exchange algorithm that is used in Phase 1 negotiations. Default value: group2.
  • IkeLifetime: The SA lifetime as a result of Phase 1 negotiations. Default value: 86400. Unit: seconds.
  • LocalId: The ID of the IPsec server. The value can be a fully qualified domain name (FQDN) or an IP address. By default, the ID of the IPsec server is the public IP address of the VPN gateway.
  • RemoteId: The ID of the customer gateway. The value can be an FQDN or an IP address. By default, this parameter is not specified.
IpsecConfig String No {"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}

The configuration of Phase 2 negotiations.

  • IpsecEncAlg: The encryption algorithm that is used in Phase 2 negotiations. Default value: aes.
  • IpsecAuthAlg: The authentication algorithm that is used in Phase 2 negotiations. Default value: sha1.
  • IpsecPfs: forwards packets of all protocols. The Diffie-Hellman key exchange algorithm that is used in Phase 2 negotiations. Default value: group2.
  • IpsecLifetime: The SA lifetime as a result of Phase 2 negotiations. Default value: 86400. Unit: seconds.
PskEnabled Boolean No true

Specifies whether to enable pre-shared key authentication. Only when you set the parameter to true, pre-shared key authentication is enabled.

Psk String No 123456

The pre-shared key.

The pre-shared key is used to authenticate the VPN gateway and the client. By default, the system generates a random string that is 16 bits in length. You can also specify the pre-shared key. The value must be 1 to 100 characters in length.

ClientToken String No e4567-e89b-12d3-a456-42665544****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate a token, but you must ensure that it is unique among different requests. ClientToken can contain only ASCII characters and cannot exceed 64 characters in length.

DryRun String No false

Specifies whether to only precheck the request. Valid values:

  • true: only prechecks the request. After the request passes the check, the system does not modify the configurations of the IPsec server. The system checks whether the required parameters are set, whether the values are in valid formats, and the service limits. If the request fails the check, the system returns error messages. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): prechecks the request. After the request passes the check, the system modifies the configurations of the IPsec server.

Response parameters

Parameter Type Example Description
RequestId String B61C08E5-403A-46A2-96C1-F7B1216DB10C

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=UpdateIpsecServer
&IpsecServerId=iss-bp1bo3xuvcxo7ixll****
&RegionId=cn-shanghai
&<Common request parameters>

Sample success responses

XML format

</UpdateIpsecServerResponse>
<RequestId>B61C08E5-403A-46A2-96C1-F7B1216DB10C</RequestId>
</UpdateIpsecServerResponse>

JSON format

{
    "RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}

Error codes

HttpCode Error code Error message Description
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you are unauthorized to perform the operation on the specified resource. To acquire the required permissions, submit a ticket.
400 VpnGateway.Configuring The specified service is configuring. The error message returned because the operation is not allowed when the specified service is being configured. Try again later.
400 VpnGateway.FinancialLocked The specified service is financial locked. The error message returned because the service is suspended due to overdue payments. Top up your account first.
400 IllegalParam.LocalSubnet The specified "LocalSubnet" (%s) is invalid. The error message returned because LocalSubnet is set to an invalid value.

For a list of error codes, visit the API Error Center.