All Products
Search
Document Center

VPN Gateway:ModifySslVpnServer

Last Updated:Mar 04, 2024

Modifies the configurations of an SSL server.

Operation description

  • If you modify only the name of the SSL server, the operation is synchronous. If you also modify other configurations besides the name, the operation is asynchronous.

  • When ModifySslVpnServer is an asynchronous operation, the system returns a request ID and runs the task in the background. You can call DescribeVpnGateway to query the status of the task.

    • If a VPN gateway is in the updating state, the configurations of the SSL server are being modified.
    • If a VPN gateway is in the active state, the configurations of the SSL server are modified.
  • You cannot repeatedly call ModifySslVpnServer to modify the configurations of an SSL server within the specified period of time.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:ModifySslVpnServerWrite
  • SslVpnServer
    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.

Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.
02fb3da4-130e-11e9-8e44-0016e04115b
RegionIdstringYes

The region ID of the VPN gateway.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
SslVpnServerIdstringYes

The ID of the SSL server.

vss-bp18q7hzj6largv4v****
NamestringNo

The name of the SSL server.

The name must be 1 to 100 characters in length and cannot start with http:// or https://.

test
ClientIpPoolstringNo

The client IP address pool.

10.30.30.0/24
LocalSubnetstringNo

The CIDR block of the client.

10.20.20.0/24
ProtostringNo

The protocol that is used by the SSL server. Valid values:

  • TCP (default)
  • UDP
UDP
CipherstringNo

The encryption algorithm that is used in the SSL-VPN connection. Valid values:

  • AES-128-CBC (default)
  • AES-192-CBC
  • AES-256-CBC
  • none
AES-128-CBC
PortintegerNo

The port that is used by the SSL server. Valid values of port numbers: 1 to 65535. Default value: 1194.

The following ports are not supported: 22, 2222, 22222, 9000, 9001, 9002, 7505, 80, 443, 53, 68, 123, 4510, 4560, 500, and 4500.

1194
CompressbooleanNo

Specifies whether to enable data compression. Valid values:

  • true (default)
  • false
true
EnableMultiFactorAuthbooleanNo

Specifies whether to enable two-factor authentication. If you enable two-factor authentication, you must also specify an IDaaS instance ID. Valid values:

  • true
  • false
Note
  • Two-factor authentication supports only IDaaS instances of earlier versions. If you do not have and cannot create IDaaS instances of earlier versions, you cannot enable two-factor authentication.
  • For existing SSL servers, if two-factor authentication is already enabled, you can continue to use two-factor authentication.
  • false
    IDaaSInstanceIdstringNo

    The ID of the Identity as a Service (IDaaS) instance.

    idaas-cn-hangzhou-****
    IDaaSRegionIdstringNo

    The ID of the region where the IDaaS instance is created.

    cn-hangzhou

    Response parameters

    ParameterTypeDescriptionExample
    object
    InternetIpstring

    The public IP address.

    47.98.XX.XX
    IDaaSInstanceIdstring

    The ID of the IDaaS instance.

    idaas-cn-hangzhou-****
    CreateTimelong

    The time when the SSL server was created.

    1492753580000
    VpnGatewayIdstring

    The ID of the VPN gateway.

    vpn-bp1q8bgx4xnkm2ogj****
    Compressboolean

    Indicates whether data compression is enabled.

    false
    Portinteger

    The port that is used by the SSL server.

    1194
    LocalSubnetstring

    The CIDR block of the client.

    10.20.20.0/24
    RegionIdstring

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

    cn-hangzhou
    Cipherstring

    The encryption algorithm.

    AES-128-CBC
    RequestIdstring

    The request ID.

    DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
    Connectionsinteger

    The total number of current connections.

    0
    SslVpnServerIdstring

    The ID of the SSL server.

    vss-bp18q7hzj6largv4v****
    MaxConnectionsinteger

    The maximum number of connections.

    5
    Namestring

    The name of the SSL server.

    test
    EnableMultiFactorAuthboolean

    Indicates whether two-factor authentication is enabled.

    • true
    • false (default)
    false
    ClientIpPoolstring

    The client IP address pool.

    10.30.30.0/24
    Protostring

    The protocol that is used by the SSL server.

    UDP
    ResourceGroupIdstring

    The ID of the resource group to which the SSL server belongs.

    The SSL server and the VPN gateway associated with the SSL server belong to the same resource group. You can call the ListResourceGroups operation to query resource groups.

    rg-acfmzs372yg****

    Examples

    Sample success responses

    JSONformat

    {
      "InternetIp": "47.98.XX.XX",
      "IDaaSInstanceId": "idaas-cn-hangzhou-****",
      "CreateTime": 1492753580000,
      "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
      "Compress": false,
      "Port": 1194,
      "LocalSubnet": "10.20.20.0/24",
      "RegionId": "cn-hangzhou",
      "Cipher": "AES-128-CBC",
      "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
      "Connections": 0,
      "SslVpnServerId": "vss-bp18q7hzj6largv4v****",
      "MaxConnections": 5,
      "Name": "test",
      "EnableMultiFactorAuth": false,
      "ClientIpPool": "10.30.30.0/24",
      "Proto": "UDP",
      "ResourceGroupId": "rg-acfmzs372yg****"
    }

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidNameThe name is not validThe name format is invalid.
    400VpnGateway.ConfiguringThe specified service is configuring.The service is being configured. Try again later.
    400VpnGateway.FinancialLockedThe specified service is financial locked.The service is suspended due to overdue payments. Top up your account first.
    400IpConflictClient IP pool conflict with local IP range.The client IP pool conflicts with the local IP range.
    400IpConflictClient IP pool conflict with other SSL VPN server in the same VPC.The client IP address pool conflicts with SSL servers in the same VPC.
    400SslVpnServer.AddRouteErrorAdd route error whose destination is client IP pool, please check vpc route entry and relevant quota.The system failed to add the route that points to the client CIDR block. View the VPC route and quota.
    400ClientIpPool.NetmaskInvalidThe netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29.The subnet mask of the client IP pool must range from 16 to 29.
    400ClientIpPool.SubnetInvalidThe specified client IP pool cannot be used.The client CIDR block is unavailable.
    400MissingParameter.IDaaSInstanceIdThe input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.You must set the IDaaSInstanceId parameter when you enable two-factor authentication.
    400OperationFailed.GetIDaaSInfoFailed to get secret key from your IDaaS instance.-
    400OperationFailed.NoRamPermissionVpn Service has no permission to operate your IDaaS instances.The VPN service does not have the permissions to manage your IDaaS instance.
    400OperationUnsupported.NotSupportMultiFactorAuthCurrent version of the VPN does not support multi-factor authentication.-
    400SystemBusyThe system is busy. Please try again later.The system is busy. Please try again later.
    400SslVpnServerPort.IllegalThe server port is not in the range of [1-65535].The port of the SSL-VPN server must be from 1 to 65535.
    400EnableHaCheck.SslVpnServerClientCidrContainsVpcRouteDestSsl vpn client cidr contains vpc route prefix. The vpc route prefix is %s.The prefix %s in the VPC route table falls within the CIDR block of the SSL client.
    400InvalidInstanceId.NotFoundInstanceId is not found.The Express Connect circuit ID is invalid.
    400VpnRouteEntry.ConflictThe specified route entry has conflict.Route conflicts exist.
    403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
    403ForbiddenUser 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.
    404InvalidRegionId.NotFoundThe specified region is not found during access authentication.The specified area is not found during authentication.
    404InvalidIDaaSInstanceId.NotFoundThe specified IDaaS instance ID does not exist.The specified IDaaS instance does not exist.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-01-04The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404
    2023-10-19API Description Update. The API operation is not deprecated.. The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    API Deprecation DescriptionThe API operation is not deprecated..
    Error CodesThe Error code has changed.
      Error Codes 400 change
      Error Codes 404 change
      delete Error Codes: 403
    Output ParametersThe response structure of the API has changed.
    2023-05-30The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 403
      delete Error Codes: 404