API 文档

查询参数模板详情

最近更新时间:2022-05-05 10:58:54

我的收藏

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

查询参数模板详情。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeParamTemplateInfo。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
TemplateId String 参数模板 ID。

3. 输出参数

参数名称 类型 描述
TotalCount Integer 实例参数个数
TemplateId String 参数模板 ID。
Name String 参数模板名称。
ProductType Integer 产品类型:1 – Redis2.8内存版(集群架构),2 – Redis2.8内存版(标准架构),3 – CKV 3.2内存版(标准架构),4 – CKV 3.2内存版(集群架构),5 – Redis2.8内存版(单机),6 – Redis4.0内存版(标准架构),7 – Redis4.0内存版(集群架构),8 – Redis5.0内存版(标准架构),9 – Redis5.0内存版(集群架构)
Description String 参数模板描述
Items Array of ParameterDetail 参数详情
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 示例

输入示例

POST / HTTP/1.1
Host: redis.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeParamTemplateInfo
<公共请求参数>

{
    "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
  }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InvalidParameter 参数错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
UnauthorizedOperation 未授权操作。
UnauthorizedOperation.NoCAMAuthed 无cam 权限。
UnauthorizedOperation.UserNotInWhiteList 用户不在白名单中。
UnsupportedOperation.ClusterInstanceAccessedDeny redis 集群版不允许接入安全组。
目录