Modify the name and description of a customer gateway.

Request parameters

Name Type Required Description
Action String Yes

The action to perform. Valid value:

ModifyCustomerGatewayAttribute
RegionId String Yes

The region of the customer gateway.

You can obtain the region ID by calling the DescribeRegions API.

NatGatewayId String Yes

The ID of the customer gateway.
Name String No

The name of the customer gateway.

The name can contain from 2 to 128 characters including a-z, A-Z, 0-9, underlines, and hyphens. The name must start with an English letter, but cannot start with http://  or https://.

Description String No

The description of the customer gateway.

The description can contain from 2 to 256 characters. The description must start with English letters, but cannot start with http:// or https://.

Response parameters

Name Type Description
RequestId String The ID of the request.
CustomerGatewayId String The ID of the customer gateway.
Name String The name of the customer gateway.
Description String The description of the customer gateway.
IpAddress String The IP address of the customer gateway.
CreateTime Long The time when the customer gateway was created.

Examples

Request example

https://vpc.aliyuncs.com/?Action=ModifyCustomerGatewayAttribute
&RegionId=cn-beijing
&CustomerGatewayId=cgw-bp1pvpl9r9adju6l5nxck
&CommonParameters
Response example

  • XML format

    <? xml version="1.0" encoding="UTF-8" ? >
<ModifyCustomerGatewayAttributeResponse>
    <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
    <RequestId>E61293C8-AF07-4E87-A272-542680038F93</RequestId>
    <CreateTime>1492747187000</CreateTime>
    <IpAddress>139.196.32.167</IpAddress>
</ModifyCustomerGatewayAttributeResponse>

  • JSON format

    {
    "CustomerGatewayId":"cgw-bp1pvpl9r9adju6l5nxck",
    "RequestId":"8AA5CE21-2E6A-4530-BDF5-F055849476E6",
    "CreateTime":1492747187000,
    "IpAddress":"139.196.32.167"
}