Release Notes
Announcements
Domain name for API request: redis.intl.tencentcloudapi.com.
This API is used to query the details of a parameter template.
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.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DescribeParamTemplateInfo. |
| 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. |
| TemplateId | Yes | String | The parameter template ID for query. Get parameter template list information through the DescribeParamTemplates API. |
| Parameter Name | Type | Description |
|---|---|---|
| TotalCount | Integer | Quantity of parameters in the parameter template |
| TemplateId | String | Parameter template ID. |
| Name | String | Parameter template name. |
| ProductType | Integer | Product type. - 2: Redis 2.8 Memory Edition (standard architecture). - 3: CKV 3.2 Memory Edition (standard architecture). - 4: CKV 3.2 Memory Edition (cluster architecture). - 5: Redis 2.8 Memory Edition (stand-alone). - 6: Redis 4.0 Memory Edition (standard architecture). - 7: Redis 4.0 Memory Edition (cluster architecture). - 8: Redis 5.0 Memory Edition (standard architecture). - 9: Redis 5.0 Memory Edition (cluster architecture). - 15: Redis 6.2 Memory Edition (standard architecture). - 16: Redis 6.2 Memory Edition (cluster architecture). - 17: Redis 7.0 Memory Edition (standard architecture). - 18: Redis 7.0 Memory Edition (cluster architecture). |
| Description | String | Parameter template description |
| Items | Array of ParameterDetail | Parameter details, including parameter name, current value, default value, maximum value, minimum value, enumeration value and other information. |
| 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. |
This example shows you how to query the template information by specifying a parameter template ID.
POST / HTTP/1.1
Host: redis.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParamTemplateInfo
<Common request parameters>
{
"TemplateId": "crs-cfg-7mgt****"
}{
"Response": {
"Description": "MyCustomParamTemplate",
"Items": [
{
"CurrentValue": "flushall",
"Default": "param_default_value",
"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-7mgt****",
"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. |
| InvalidParameter.PermissionDenied | The API has no CAM permissions. |
| UnauthorizedOperation | The operation is unauthorized. |
| 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. |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback