All Products
Search
Document Center

Virtual Private Cloud:ModifyCustomerGatewayAttribute

Last Updated:Mar 04, 2024

Modifies the configuration of a customer gateway.

Operation description

  • When you call ModifyCustomerGatewayAttribute, if a value is assigned to AuthKey, the operation is asynchronous. After a request is sent, the system returns a request ID and runs the task in the background. You can call DescribeVpnGateway to query the status of the task.

    • If a VPN gateway is in the updating state, the configurations are being modified.
    • If a VPN gateway is in the active state, the configurations are modified.
  • When you call ModifyCustomerGatewayAttribute, if no value is assigned to AuthKey, the operation is synchronous.

  • You cannot repeatedly call ModifyCustomerGatewayAttribute to modify the configurations of a customer gateway within the specified period of time.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the customer gateway is deployed.

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 client token can contain only ASCII characters.

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****
CustomerGatewayIdstringYes

The ID of the customer gateway.

cgw-bp1pvpl9r9adju6l5****
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
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****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

8AA5CE21-2E6A-4530-BDF5-F055849476E6
IpAddressstring

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

139.32.XX.XX
Descriptionstring

The description of the customer gateway.

desctest
CustomerGatewayIdstring

The ID of the customer gateway.

cgw-bp1pvpl9r9adju6l5****
CreateTimelong

The timestamp generated when the customer gateway was created.

1492747187000
Namestring

The name of the customer gateway.

nametest
ResourceGroupIdstring

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

You can call the ListResourceGroups operation to query resource groups.

rg-acfmzs372yg****

Examples

Sample success responses

JSONformat

{
  "RequestId": "8AA5CE21-2E6A-4530-BDF5-F055849476E6",
  "IpAddress": "139.32.XX.XX",
  "Description": "desctest",
  "CustomerGatewayId": "cgw-bp1pvpl9r9adju6l5****",
  "CreateTime": 1492747187000,
  "Name": "nametest",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidNameThe name is not validThe name format is invalid.
400InvalidDescriptionThe description is not validThe format of the description 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.
400InvalidAuthkey.MalformedThe specified BGP authentication key (%s) is malformed.The BGP authentication key is invalid.
400OperationDenied.VpnFinancialLockedThe associated VPN gateway is financially locked. You cannot update the attributes of the customer gateway.The associated VPN gateway is financially locked. You cannot update the attributes of the customer gateway.
400OperationDenied.VpnConfiguringThe associated VPN gateway is being configured. You cannot update the attributes of the customer gateway.The associated VPN gateway is being configured. You cannot update the attributes of the customer gateway.
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.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.
404InvalidCustomerGatewayInstanceId.NotFoundThe specified customer gateway instance id does not exist.The specified customer gateway does not exist. Check whether the ID of the customer gateway is correct.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-19API Description Update. The API operation is not deprecated.. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
API Deprecation DescriptionThe API operation is not deprecated..
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.