Modifies the description or name of a virtual private cloud (VPC) peering connection.

Usage notes

  • The ModifyVpcPeerConnection operation is asynchronous. After you send a request, the system returns RequestId, but the operation is still being performed in the background. You can call the GetVpcPeerConnectionAttribute operation to query the status of a VPC peering connection.
    • If a VPC peering connection is in the Updating state, the VPC peering connection is being modified.
    • If a VPC peering connection is in the Activated state, the VPC peering connection is modified.
  • You cannot repeatedly call the ModifyVpcPeerConnection operation for the same VPC peering connection 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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ModifyVpcPeerConnection

The operation that you want to perform. Set the value to ModifyVpcPeerConnection.

InstanceId String Yes pcc-lnk0m24khwvtkm****

The ID of the VPC peering connection whose name or description you want to modify.

Name String No vpcpeername

The new name of the VPC peering connection.

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

Description String No newdescription

The new description of the VPC peering connection.

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

Bandwidth Integer No 100

The new bandwidth of the VPC peering connection. Unit: Mbit/s. The value must be an integer greater than 0.

DryRun Boolean No false

Specifies whether to only precheck the request. Valid values:

  • true: checks the request without performing the operation. The system prechecks the required parameters, request syntax, and limits. If the request fails the precheck, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. If the request passes the precheck, an HTTP 2xx status code is returned and the operation is performed.
ClientToken String No 0c593ea1-3bea-11e9-b96b-88e9fe637760

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must make sure that it is unique among different requests. The token can contain only ASCII characters.

Note If you do not specify this parameter, the system uses RequestId as ClientToken. RequestId may be different for each API request.

Response parameters

Parameter Type Example Description
RequestId String 880C99E1-449B-524A-B81F-1EC53D2A7EAC

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ModifyVpcPeerConnection
&InstanceId=pcc-lnk0m24khwvtkm****
&Name=vpcpeername
&Description=newdescription
&Bandwidth=100
&DryRun=false
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe637760
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<ModifyVpcPeerConnectionResponse>
    <RequestId>880C99E1-449B-524A-B81F-1EC53D2A7EAC</RequestId>
</ModifyVpcPeerConnectionResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "880C99E1-449B-524A-B81F-1EC53D2A7EAC"
}

Error codes

HttpCode Error code Error message Description
400 ResourceNotFound.InstanceId The specified resource of %s is not found. The error message returned because the specified instance is not found and cannot be deleted.

For a list of error codes, visit the API Error Center.