Last updated: 2019-11-29 18:05:50

1. API Description

Domain name for API request:

This API (CreateCustomerGateway) is used to create customer gateways.

A maximum of 100 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example:

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: CreateCustomerGateway
Version Yes String Common parameter. The value used for this API: 2017-03-12
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
CustomerGatewayName Yes String Customer gateway name, which is limited to 60 characters.
IpAddress Yes String Public IP of the customer gateway.

3. Output Parameters

Parameter Name Type Description
CustomerGateway CustomerGateway Customer gateway object
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameterValue.Duplicate The input parameter already exists.
VpcLimitExceeded The limit of requested VPC resources for the specific region has been reached.

5. Example

Example 1 Create a customer gateway

Input example
&<Common request parameters>

Output example

  "Response": {
    "CustomerGateway": {
      "CreateTime": "2018-04-18 10:00:00",
      "CustomerGatewayId": "cgw-mgp33pll",
      "CustomerGatewayName": "test-cgw",
      "IpAddress": ""
    "RequestId": "5bd98433-263a-47b6-9a1c-84aa613a8ff6"

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.