Skip to main content

CreateCustomerGateway

Description

call the CreateCustomerGateway interface to create a user gateway.

Request Method

POST

Request Path

/apsara/route/Vpc/CreateCustomerGateway

Request Parameters Common Parameters

NameLocationTypeRequiredSample valueDescription
DescriptionBODYstringNoGatewaydescription information of the user gateway. is described between 2 and 256 characters, starting with upper and lower case letters or Chinese, and can contain numbers, dashes (-), underscores (_), and full-width periods (.) , full-width comma (,) and full-width colon (:), but cannot be http:// or https:// start.
regionIdBODYstringYesNo sample value for this parameter.region id
IpAddressBODYstringYes116.XX.XX.222the IP address of the user gateway.
RegionIdBODYstringYescn-qingdao-env66-d01the region ID where the user gateway is located. you can obtain the region by calling DescribeRegions interface ID.
ClientTokenBODYstringNo02fb3da4-130e-11e9-8e44-0016e04115bis used to ensure the idempotence of the request. The parameter value is generated by the client. It must be unique between different requests, and the maximum value does not exceed 64 ASCII characters.  
versionBODYstringNo2016-01-01version of api
NameBODYstringNoGatewaythe name of the user gateway. is 2 to 128 characters in length, must start with a letter or Chinese, and can contain numbers, half-width periods (.), underscores (_), and dashes (-). But you cannot use http:// or https:// start.

Return data

NameTypeSample valueDescription
RequestIDstring1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DCRequest id

Example

Successful Response example

{
"RequestID":"1E3D5A1E0-67CA-43DA-24BC-EAF2D5A1E4DC"
}

Failed Response example

{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}

}