All Products
Search

This Product

    Virtual Private Cloud:ModifyVpcPeerConnection

    Document Center

    Virtual Private Cloud:ModifyVpcPeerConnection

    Last Updated:Mar 03, 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

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    Authorization information

    There is currently no authorization information disclosed in the API.

    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

    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.-
    400IncorrectBusinessStatus.VpcPeerThe business status of %s [%s] is incorrect.-
    400OperationFailed.BandwidthCannotBeChangedInSameRegionThe operation failed because the bandwidth cannot be changed in the same region.-
    400QuotaExceeded.BandwidthThe quota of bandwidth is exceeded.The specified bandwidth is invalid.

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

    Change history

    Change timeSummary of changesOperation
    2024-01-23API Description Update. The Error code has changedsee changesets
    Change itemChange content
    API DescriptionAPI Description Update.
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2023-07-25The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
    2022-07-05The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: Bandwidth