tencent cloud

Tencent Cloud Distributed Cache (Redis OSS-Compatible)

ドキュメントTencent Cloud Distributed Cache (Redis OSS-Compatible)API DocumentationParameter Management APIsDescribeParamTemplates

DescribeParamTemplates

Download
フォーカスモード
フォントサイズ
最終更新日: 2026-08-14 16:52:06

1. API Description

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

This API is used to query the parameter template list.

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: DescribeParamTemplates.
Version Yes String Common Params. The value used for this API: 2018-04-12.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ProductTypes.N No Array of Integer

Specified query for product version and architecture.

  • 6: Redis 4.0 standard architecture;
  • 7: Redis 4.0 cluster architecture;
  • 8: Redis 5.0 standard architecture;
  • 9: Redis 5.0 cluster architecture;
  • 15: Redis 6.2 standard architecture;
  • 16: Redis 6.2 cluster architecture;
  • 17: Redis 7.0 standard architecture;
  • 18: Redis 7.0 cluster architecture;
  • 19: ValKey 8.0 standard architecture;
  • 20: ValKey 8.0 cluster architecture.
TemplateNames.N No Array of String

Specify the parameter template name for the query.
TemplateIds.N No Array of String

Parameter template ID specified for query.
Limit No Integer

Specify the pagination size of the query result, which is the number of records returned per page.

  • Value ranges from 0–200.
  • Default value: 200.
Offset No Integer

Pagination offset, used to specify the starting position of the query result.

  • Value: Must be an integral multiple of Limit. Default value is 0.
  • Calculation formula: offset=limit*(page number-1).

3. Output Parameters

Parameter Name Type Description
TotalCount Integer

Number of parameter templates for this user.
Items Array of ParamTemplateInfo

Parameter template details.
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 Sample request

Input Example

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

{}

Output Example

{
    "Response": {
        "TotalCount": 1,
        "RequestId": "0e728fa9-c2e5-4bf8-8d6b-c1c4fab7b6db",
        "Items": [
            {
                "Name": "CustomParamTemplate",
                "Description": "MyCustomParamTemplate",
                "ProductType": 6,
                "TemplateId": "crs-cfg-sa23d5d3"
            }
        ]
    }
}

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.
InvalidParameter.PermissionDenied The API has no CAM permissions.
UnauthorizedOperation.NoCAMAuthed No CAM permissions.
UnauthorizedOperation.UserNotInWhiteList The user is not in the allowlist.
前の記事へ: DescribeInstanceSecurityGroup次の記事へ: DescribeProjectSecurityGroup

ヘルプとサポート

この記事はお役に立ちましたか？

フィードバック