Domain name for API request: redis.tencentcloudapi.com.
This API is used to query parameter template details.
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
This document describes the parameters for Signature V1. It's recommended to use the V3 signature, which provides higher security. Note that for Signature V3, the common parameters need to be placed in the HTTP Header. See details.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter. The value used for this API: DescribeParamTemplateInfo. |
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. |
TemplateId | Yes | String | Parameter template ID. |
Parameter Name | Type | Description |
---|---|---|
TotalCount | Integer | Number of instance parameters |
TemplateId | String | Parameter template ID |
Name | String | Parameter template name |
ProductType | 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) |
Description | String | Parameter template description |
Items | Array of ParameterDetail | Parameter details |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParamTemplateInfo
<Common request parameters>
{
"TemplateId": "crs-cfg-7mgtd2ro"
}
{
"Response": {
"Description": "MyCustomParamTemplate",
"Items": [
{
"CurrentValue": "",
"Default": "\"\"",
"Description": "commands in such config will not be allowed to run in this instance,you can config multi commands like this 'flushdb,keys'",
"EnumValue": [
"flushall",
"flushdb",
"keys",
"hgetall",
"eval",
"evalsha",
"script"
],
"Max": "",
"Min": "",
"Name": "disable-command-list",
"NeedReboot": 0,
"ParamType": "multi"
},
{
"CurrentValue": "512",
"Default": "512",
"Description": "Hashes are encoded using a memory efficient data structure when they have a small number of entries",
"EnumValue": null,
"Max": "10000",
"Min": "1",
"Name": "hash-max-ziplist-entries",
"NeedReboot": 0,
"ParamType": "integer"
},
{
"CurrentValue": "64",
"Default": "64",
"Description": "Hashes are encoded using a memory efficient data structure when the biggest entry does not exceed a given threshold",
"EnumValue": null,
"Max": "10000",
"Min": "1",
"Name": "hash-max-ziplist-value",
"NeedReboot": 0,
"ParamType": "integer"
},
{
"CurrentValue": "10",
"Default": "10",
"Description": "The frequency at which Redis background tasks are performed. A higher value results in higher CPU consumption but smaller latency. We recommend that you do not specify a value larger than 100.",
"EnumValue": null,
"Max": "500",
"Min": "1",
"Name": "hz",
"NeedReboot": 0,
"ParamType": "integer"
}
],
"Name": "redis_automation_is_awesome_1",
"ProductType": 2,
"RequestId": "72881d6c-c2a0-42af-862a-a5de09de104d",
"TemplateId": "crs-cfg-7mgtd2ro",
"TotalCount": 14
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
InvalidParameter | Incorrect parameter. |
UnauthorizedOperation | Unauthorized operation. |
UnauthorizedOperation.NoCAMAuthed | No CAM permissions. |
UnauthorizedOperation.UserNotInWhiteList | The user is not in the allowlist. |
UnsupportedOperation.ClusterInstanceAccessedDeny | The Redis cluster edition is not allowed to connect to a security group. |
本页内容是否解决了您的问题?