All Products
Search
Document Center

VPN Gateway:CreateCustomerGateway

Last Updated:Jun 03, 2024

Creates a customer gateway.

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:CreateCustomerGatewayWrite
  • CustomerGateway
    acs:vpc:{#regionId}:{#accountId}:customergateway/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the customer gateway.

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

cn-shanghai
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 token can contain only ASCII characters and cannot exceed 64 characters in length.

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

The public IP address of the gateway device in the data center.

101.12.XX.XX
NamestringNo

The name of the customer gateway.

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

nametest
DescriptionstringNo

The description of the customer gateway.

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

desctest
AsnstringNo

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: 123 × 65536 + 456 = 8061384.

65530
AuthKeystringNo

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 (?).

AuthKey****
Tagsobject []No

The tag value.

The tag value can be an empty string and cannot exceed 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Each tag key corresponds to one tag value. You can specify up to 20 tag values in each call.

KeystringNo

The tag key. The tag key cannot be an empty string.

It can be at most 64 characters in length, and cannot contain http:// or https://. It cannot start with aliyun or acs:.

You can specify at most 20 tag keys in each call.

TagKey
ValuestringNo

The tag value.

The tag value can be an empty string and cannot exceed 128 characters in length. It cannot start with aliyun or acs:, and cannot contain http:// or https://.

Each tag key corresponds to one tag value. You can specify at most 20 tag values in each call.

TagValue
ResourceGroupIdstringNo

The ID of the resource group to which the customer gateway belongs.

  • You can call the ListResourceGroups operation to query the resource group list.

  • If you do not specify a resource group, the customer gateway will belong to the default resource group after being created.

rg-aek2qo2h4jy****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

D32B3C26-6C6C-4988-93E9-D2A6444CE6AE
IpAddressstring

The public IP address of the gateway device in the data center.

101.12.XX.XX
Descriptionstring

The description of the customer gateway.

desctest
CustomerGatewayIdstring

The ID of the customer gateway.

cgw-bp1jrawp82av6bws9****
CreateTimelong

The timestamp generated when the customer gateway was created. Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

1493363486000
Namestring

The name of the customer gateway.

nametest

Examples

Sample success responses

JSONformat

{
  "RequestId": "D32B3C26-6C6C-4988-93E9-D2A6444CE6AE",
  "IpAddress": "101.12.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1jrawp82av6bws9****",
  "CreateTime": 1493363486000,
  "Name": "nametest"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidAuthkey.MalformedThe specified BGP authentication key (%s) is malformed.The BGP authentication key is invalid.
400InvalidIpAddress.AlreadyExistSpecified IpAddress is already exist.The IP address already exists. You cannot specify duplicate IP addresses by using the same account in the same region.
400InvalidIpAddress.WrongFormatSpecified IpAddress is invalid.The specified IP address is invalid.
400InvalidNameThe name is not validThe name format is invalid.
400InvalidDescriptionThe description is not validThe format of the description is invalid.
400Resource.QuotaFullThe quota of resource is fullThe resource quota is exhausted.
400IllegalParam.AsnThe specified Asn is invalid.The error message returned because the ASN is invalid.
400OperationDenied.MissingAsnThe autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.The autonomous system number of the customer gateway is mandatory when BGP authentication key is specified.
400InvalidParameter.TagValueThe specified parameter TagValue is invalid.The error message returned because the specified tag value is invalid.
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.The number of tags has reached the upper limit.
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.The tag resources are duplicate.
400InvalidParameter.TagKeyThe specified parameter TagKey is invalid.The error message returned because the specified tag key is invalid.
400Duplicated.TagKeyThe specified parameter TagKey is duplicated.The error message returned because the specified tag key already exists.
400OperationFailed.NoRamPermissionVpn Service has no permission to operate your IDaaS instances.The VPN service does not have the permissions to manage your IDaaS instance.
400CreateVpnUserGatewayQuotaFull.QuotaFullThe number of created VPN customer gateways exceeds the quota.The number of created VPN customer gateways exceeds the quota.
403Forbidden.SubUserUser 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. 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.
409OperationConflictThe operation against this instance is too frequent, please try again later.Operations are too frequently performed on the instance. Try again later.

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: 409
2023-10-19API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 409
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId