CreateMultiPathGatewaySecretKey

1. API Description

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

This API creates an access key for the multi-channel security acceleration gateway. Customers use the access key to sign requests for accessing the gateway. Each site can have only one key, which is applicable to all gateways under that site. Query the key via the DescribeMultiPathGatewaySecretKey API.

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: CreateMultiPathGatewaySecretKey.
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.
SecretKey	No	String	Multi-Channel security acceleration gateway access key, base64 string, value range:length of the unencoded string: 32-48 characters, optional, automatically generated by the system if left blank, can be queried through the API DescribeMultiPathGatewaySecretKey.

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 Creating a Multi-Channel Security Acceleration Gateway Integration Key (Custom)

Create a user-defined multi-channel SCDN gateway integration key under the specified site (ZoneId zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192",
    "SecretKey": "b8sfnemqzF5TNCwwtshVmG/gyCJVi/rP+7A+jsBwqGY="
}

Output Example

{
    "Response": {
        "RequestId": "9153aae4-26b1-4580-adc3-fa7cd4d32bf5"
    }
}

Example2 Creating a Multi-Channel Security Acceleration Gateway Integration Key (System-Generated)

Create a system-generated multi-channel security acceleration gateway integration key for the specified site (ZoneId: zone-27q0p0bal192).

Input Example

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

{
    "ZoneId": "zone-27q0p0bal192"
}

Output Example

{
    "Response": {
        "RequestId": "1026aae4-26b1-4580-adc3-fa7cd4dasd19"
    }
}

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 Creating a Multi-Channel Security Acceleration Gateway Integration Key (Custom)
Example2 Creating a Multi-Channel Security Acceleration Gateway Integration Key (System-Generated)
5. Developer Resources
SDK
Command Line Interface
6. Error Code