ModifyMultiPathGateway

1. API Description

Domain name for API request: teo.intl.tencentcloudapi.com.

This API is used to modify multi-channel security acceleration gateway information, such as name, gateway ID, IP and port.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyMultiPathGateway.
Version	Yes	String	Common Params. The value used for this API: 2022-09-01.
Region	No	String	Common Params. This parameter is not required for this API.
ZoneId	Yes	String	Zone ID.
GatewayId	Yes	String	Specifies the gateway ID.
GatewayName	No	String	Gateway name, up to 16 characters, allowed characters (a-z, A-Z, 0-9, -, _).
GatewayIP	No	String	Gateway address, if GatewayType value is private (private gateway), you can fill in and modify it. When using this address, please ensure it has been entered into the Tencent cloud multi-channel security acceleration gateway system. if not entered, you need to submit a ticket or contact the architect to enter the gateway IP address into the Tencent cloud multi-channel security acceleration gateway system in advance before making API calls.
GatewayPort	No	Integer	Gateway port, range 1-65535 (excluding 8888), supports modifying GatewayType with a value of private gateway.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Modify Multi-Channel Security Acceleration Gateway Info

Modify the gateway name, IP and port information of the multi-channel SCDN gateway with GatewayId mpgw-lbxuhk1oh under the specified site with ZoneId zone-27q0p0bal192.

Input Example

POST / HTTP/1.1
Host: teo.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyMultiPathGateway
<Common request parameters>

{
    "ZoneId": "zone-27q0p0bal192",
    "GatewayId": "mpgw-lbxuhk1oh",
    "GatewayName": "eomp",
    "GatewayIP": "101.31.33.19",
    "GatewayPort": 8080
}

Output Example

{
    "Response": {
        "RequestId": "175a5e55-a849-41f1-93d2-c9741859fedd"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
InternalError	Internal error.
InvalidParameter	Parameter error.
InvalidParameterValue	Invalid parameter value.
MissingParameter	Missing parameters.
OperationDenied	Operation denied.

1. API Description
2. Input Parameters
3. Output Parameters
4. Example
Example1 Modify Multi-Channel Security Acceleration Gateway Info
5. Developer Resources
SDK
Command Line Interface
6. Error Code