CreateParamTemplate

最后更新时间:2021-11-18 10:45:17

1. API Description

Domain name for API request: redis.tencentcloudapi.com.

This API is used to create a parameter template.

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 parameter. The value used for this API: CreateParamTemplate.
Version Yes String Common parameter. The value used for this API: 2018-04-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
Name Yes String Parameter template name.
Description No String Parameter template description.
ProductType No Integer Instance type. Valid values: 1 (Redis 2.8 memory edition in cluster architecture), 2 (Redis 2.8 memory edition in standard architecture), 3 (CKV 3.2 memory edition in standard architecture), 4 (CKV 3.2 memory edition in cluster architecture), 5 (Redis 2.8 memory edition in standalone architecture), 6 (Redis 4.0 memory edition in standard architecture), 7 (Redis 4.0 memory edition in cluster architecture), 8 (Redis 5.0 memory edition in standard architecture), 9 (Redis 5.0 memory edition in cluster architecture). If TempateId is specified, this parameter can be left blank; otherwise, it is required.
TemplateId No String ID of the source parameter template. You can create a template by copying the source parameter template.
ParamList.N No Array of InstanceParam Parameter list.

3. Output Parameters

Parameter Name Type Description
TemplateId String Parameter template ID.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Sample request

Input Example

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

{
    "ParamList": [
        {
            "Value": "120",
            "Key": "timeout"
        }
    ],
    "TemplateId": "crs-cfg-sa23d5d3",
    "Description": "MyCustomParamTemplate",
    "ProductType": 6,
    "Name": "CustomParamTemplate"
}

Output Example

{
  "Response": {
    "TemplateId": "crs-cfg-sa23d5a2",
    "RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db"
  }
}

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

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
FailedOperation.SystemError Internal system error, which is irrelevant to the business.
InternalError.InternalError Internal error.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.