edit-icon download-icon

ModifyCustomerGatewayAttribute

Last Updated: Apr 12, 2018

Description

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.

CustomerGatewayId String Yes The ID of the customer gateway.
Name String No

The name of the customer gateway.

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

The description of the customer gateway.

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

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 creation time of the customer gateway.

Error codes

See VPC API Error Center.

Examples

Request example

  1. https://vpc.aliyuncs.com/?Action=ModifyCustomerGatewayAttribute
  2. &RegionID=cn-beijing
  3. &CustomerGatewayId=cgw-bp1pvpl9r9adju6l5nxck
  4. &<CommonParameters>

Response example

XML format

  1. <ModifyCustomerGatewayAttributeResponse>
  2. <CustomerGatewayId>cgw-bp1pvpl9r9adju6l5nxck</CustomerGatewayId>
  3. <RequestId>E61293C8-AF07-4E87-A272-542680038F93</RequestId>
  4. <CreateTime>1492747187000</CreateTime>
  5. <IpAddress>139.196.32.167</IpAddress>
  6. </ModifyCustomerGatewayAttributeResponse>

JSON format

  1. {
  2. "CustomerGatewayId":"cgw-bp1pvpl9r9adju6l5nxck",
  3. "RequestId":"8AA5CE21-2E6A-4530-BDF5-F055849476E6",
  4. "CreateTime":1492747187000,
  5. "IpAddress":"139.196.32.167"
  6. }
Thank you! We've received your feedback.