Creates a customer gateway.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | CreateCustomerGateway |
The operation that you want to perform. Set the value to CreateCustomerGateway. |
RegionId | String | Yes | cn-shanghai |
The region ID of the customer gateway. You can call the DescribeRegions operation to query the most recent region list. |
ClientToken | String | No | 02fb3da4-130e-11e9-8e44**** |
The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. Note If you do not set this parameter, the system automatically uses RequestId as ClientToken. RequestId may be different for each API request.
|
IpAddress | String | Yes | 101.12.XX.XX |
The static public IP address of the gateway device in the data center. |
Name | String | No | nametest |
The name of the customer gateway. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter. |
Description | String | No | desctest |
The description of the customer gateway. The name must be 2 to 100 characters in length, and can contain digits, underscores (_), and hyphens (-). It must start with a letter. |
Asn | String | No | 65530 |
The autonomous system number (ASN) of the gateway device in the data center. Asn is a 4-byte number. You can enter the number in two segments and separate the first 16 bits from the following 16 bits with a period (.). Enter the number in each segment in the decimal format. For example, if you enter 123.456, the ASN is 8061384. The ASN is calculated by using the following formula: 123 × 65536 + 456 = 8061384. |
AuthKey | String | No | AuthKey**** |
The authentication key of the BGP routing protocol for the gateway device in the data center. The key must be 1 to 64 characters in length. It can contain only ASCII characters and cannot contain spaces or question marks (?). |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | D32B3C26-6C6C-4988-93E9-D2A6444CE6AE |
The ID of the request. |
IpAddress | String | 101.12.XX.XX |
The static public IP address of the gateway device in the data center. |
Description | String | desctest |
The description of the customer gateway. |
CustomerGatewayId | String | cgw-bp1jrawp82av6bws9**** |
The ID of the customer gateway. |
CreateTime | Long | 1493363486000 |
The timestamp generated when the customer gateway was created. |
Name | String | nametest |
The name of the customer gateway. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreateCustomerGateway
&IpAddress=101.12.XX.X
&RegionId=cn-shanghai
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<CreateCustomerGatewayResponse>
<RequestId>D32B3C26-6C6C-4988-93E9-D2A6444CE6AE</RequestId>
<IpAddress>101.12.XX.XX</IpAddress>
<Description>desctest</Description>
<CustomerGatewayId>cgw-bp1jrawp82av6bws9****</CustomerGatewayId>
<CreateTime>1493363486000</CreateTime>
<Name>nametest</Name>
</CreateCustomerGatewayResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
"IpAddress" : "101.12.XX.XX",
"Description" : "desctest",
"CustomerGatewayId" : "cgw-bp1jrawp82av6bws9****",
"CreateTime" : 1493363486000,
"Name" : "nametest"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | InvalidAuthkey.Malformed | The specified BGP authentication key (%s) is malformed. | The error message returned because the BGP authentication key is invalid. |
400 | InvalidIpAddress.AlreadyExist | Specified IpAddress is already exist. | The error message returned because the specified IP address already exists. One user in one region cannot use duplicate IP addresses. |
400 | InvalidIpAddress.WrongFormat | Specified IpAddress is invalid. | The error message returned because the specified IP address is invalid. |
400 | InvalidName | The name is not valid | The error message returned because the format of the name is invalid. |
400 | InvalidDescription | The description is not valid | The error message returned because the format of the description is invalid. |
400 | Resource.QuotaFull | The quota of resource is full | The error message returned because the resource quota is reached. |
400 | OperationDenied.MissingAsn | The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified. | The error message returned because when you specify the BGP authentication key, you must also specify an autonomous system number (ASN). |
403 | Forbbiden.SubUser | User not authorized to operate on the specified resource as your account is created by another user. | The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again. |
403 | Forbidden | User not authorized to operate on the specified resource. | The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again. |
For a list of error codes, visit the API Error Center.