Modify Peer Gateway

Last updated: 2019-11-29 19:19:17

PDF

1. API Description

This API (ModifyUserGw) is used to modify customer gateway.
Domain for API request: vpc.api.qcloud.com

2. Input Parameters

The following request parameter list only provides API request parameters. Common request parameters need to be added when the API is called. For more information, refer to Common Request Parameters. The Action field for this API is ModifyUserGw.

Parameter Name Required Type Description
userGwId Yes String Customer gateway ID assigned by the system. For example: cgw-e098slul
userGwName Yes String Customer gateway name. You can use any content as long as it does not exceed 60 characters.

3. Output Parameters

Parameter Name Type Description
code Int Common error code. A value of 0 indicates success, and other values indicate failure. For more information, please refer to Common Error Codes on the Error Code page.
message String Module error message description depending on API.

4. Error Codes

The following list only provides the business logic error codes for this API. For additional common error codes, refer to VPC Error Codes.

Error code Description
InvalidUserGwName Invalid customer gateway name. It should be within 60 characters.
InvalidUserGw.NotFound Invalid customer gateway. Customer gateway resource does not exist. Please check the information you entered. You can query customer gateway by using the DescribeUserGw API.

5. Example

Input

https://vpc.api.qcloud.com/v2/index.php?Action=ModifyUserGw
&<Common request parameters>
&userGwId=cgw-e098slul
&userGwName=9101

Output

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