All Products
Search

This Product

    Virtual Private Cloud:ModifyVpcPeerConnection

    Document Center

    Virtual Private Cloud:ModifyVpcPeerConnection

    Last Updated:Dec 23, 2024

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

    Operation description

    • 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

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    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:ModifyVpcPeerConnectionupdate
    *All Resources
    *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

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

    		pcc-lnk0m24khwvtkm****
    NamestringNo

    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://.

    		vpcpeername
    DescriptionstringNo

    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://.

    		newdescription
    BandwidthintegerNo

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

    		100
    DryRunbooleanNo

    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.
    		false
    ClientTokenstringNo

    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.
    		0c593ea1-3bea-11e9-b96b-88e9fe637760
    LinkTypestringNo

    Type of connection. Valid values:

    • Platinum.

    • Gold: default value.

    Note
  • If you need to specify this parameter, ensure that the VPC peering connection is an inter-region connection.
    •
    		Gold

    Response parameters

    ParameterTypeDescriptionExample
    object

    RpcResponse

    RequestIdstring

    The ID of the request.

    		880C99E1-449B-524A-B81F-1EC53D2A7EAC

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400ResourceNotFound.InstanceIdThe specified resource of %s is not found.The specified instance is not found
    400IncorrectStatus.VpcPeerThe status of %s [%s] is incorrect.The status of the peer-to-peer connection instance does not meet the requirements. In this status, the peer-to-peer connection instance cannot be received.
    400IncorrectBusinessStatus.VpcPeerThe business status of %s [%s] is incorrect.The current instance status is abnormal and the current operation is not allowed.
    400OperationFailed.BandwidthCannotBeChangedInSameRegionThe operation failed because the bandwidth cannot be changed in the same region.The operation failed because VpcPeer instances in the same region are not allowed to modify the bandwidth value.
    400QuotaExceeded.BandwidthThe quota of bandwidth is exceeded.The specified bandwidth is invalid.
    400OperationFailed.InterRegionLinkTypeNotSupportedThe same region not supported link type feature.Link type characteristics are not supported in the same region.
    400OperationFailed.RegionIdNotSupportLinkTypeThe feature link type is not supported in the region.The gold, silver and copper settings for this feature are not supported in the region.
    400OperationFailed.SpecificLinkTypeNotSupportedThe operation failed because the special link type of user is not opened.The account does not support special link types.

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

    Change history

    Change timeSummary of changesOperation
    2024-12-04The Error code has changed. The request parameters of the API has changedView Change Details
    2024-01-23API Description Update. The Error code has changedView Change Details
    2023-07-25The Error code has changedView Change Details
    2022-07-05The Error code has changed. The request parameters of the API has changedView Change Details