Modify the Attributes of a Cross-Region Peering Connection

Last updated: 2020-06-04 17:53:39

    Note:

    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new VPC API 3.0 which is standardized and faster.

    1. API Description

    This API (ModifyVpcPeeringConnectionEx) is used to modify the attributes of cross-region peering connections.
    Domain name for API requests: vpc.api.qcloud.com

    2. Input Parameters

    Below is a list of API request parameters. You need to add common request parameters to your request when calling this API. For more information, see the Common Request Parameters page. The Action field for this API is ModifyVpcPeeringConnectionEx.

    Parameter name Required Type Description
    peeringConnectionId Yes String ID of the VPC peering connection, for example: pcx-krmzap90.
    peeringConnectionName No String Peering connection name, which cannot exceed 60 characters.
    bandwidth No Int Upper limit of the bandwidth for the peering connection (in Mbps). Supported values: 10, 20, 50, 100, 200, 500, and 1,000.

    3. Output Parameters

    Parameter name Type Description
    code Int Error code. 0: Successful; other values: Failed.
    message String Error message
    taskId Int Task ID. You can query the execution result by using taskId. For more information, see the API for Querying Task Execution Results.

    4. Error Codes

    The following error codes only include business logic error codes for this API. For additional common error codes, see VPC Error Codes.

    Error code Description
    InvalidPeeringConnectionName Invalid peering connection name. This name cannot exceed 60 characters.
    InvalidVpc.NotFound Invalid VPC. This error code indicates that the VPC resource does not exist. In this case, verify whether the resource information that you entered is correct.
    InvalidPeeringConnection.NotFound Invalid peering connection. This error code indicates that the peering connection resource does not exist. In this case, verify whether the resource information that you entered is correct.

    5. Example

    Input

    https://vpc.api.qcloud.com/v2/index.php?Action=ModifyVpcPeeringConnectionEx
    &<Common Request Parameters>
    &peeringConnectionId=pcx-krmzap90
    &peeringConnectionName=uuuuuuu
    

    Output

    {
        "code":"0",
        "message":"",
        "taskId":1235
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help