AI 助理
文档备案控制台
开发者社区 PolarDB开源 PolarDB 分布式版 文章 正文

API参考—参数管理—DescribeParameterTemplates

2021-10-28 247
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 调用DescribeParameterTemplates接口查看参数模版详情。

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeParameterTemplates

系统规定参数。取值为DescribeParameterTemplates。
DBInstanceId String 是 pxc-*********************

实例ID。
RegionId String 是 cn-hangzhou

实例所在地域。
ParamLevel String 否 compute

参数级别，取值范围如下：

  • compute：计算级别
  • storage：存储级别

返回数据

名称 类型 示例值 描述
Data Struct

请求返回数据。
RequestId String 39FAD755-1328-4796-942A-726C14******

请求ID。

示例

请求示例


http(s)://polardbx.cn-hangzhou.aliyuncs.com/?Action=DescribeParameterTemplates
&DBInstanceId=pxc-*********************
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML 格式


<code>200</code>
<data>
    <RequestId>39FAD755-1328-4796-942A-726C14******</RequestId>
    <Data>
        <ParameterCount>20</ParameterCount>
        <EngineVersion>1.0</EngineVersion>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[1000-60000]</CheckingCode>
            <ParameterValue>5000</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>CONN_POOL_BLOCK_TIMEOUT</ParameterName>
            <ParameterDescription>物理连接池获取连接的最大等待时间</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[1-60]</CheckingCode>
            <ParameterValue>30</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>CONN_POOL_IDLE_TIMEOUT</ParameterName>
            <ParameterDescription>物理空闲链接超时时间</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[1-1600]</CheckingCode>
            <ParameterValue>60</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>CONN_POOL_MAX_POOL_SIZE</ParameterName>
            <ParameterDescription>物理分库链接数最大值</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[0-60]</CheckingCode>
            <ParameterValue>20</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>CONN_POOL_MIN_POOL_SIZE</ParameterName>
            <ParameterDescription>物理分库链接数最小值</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[true|false]</CheckingCode>
            <ParameterValue>true</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>ENABLE_BACKGROUND_STATISTIC_COLLECTION</ParameterName>
            <ParameterDescription>是否允许统计数据采集</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[true|false]</CheckingCode>
            <ParameterValue>true</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>ENABLE_COMPLEX_DML_CROSS_DB</ParameterName>
            <ParameterDescription>是否支持跨库复杂DML</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[true|false]</CheckingCode>
            <ParameterValue>true</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>ENABLE_LOCAL_MODE</ParameterName>
            <ParameterDescription>是否启用LOCAL执行模式</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[true|false]</CheckingCode>
            <ParameterValue>false</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>ENABLE_RECYCLEBIN</ParameterName>
            <ParameterDescription>是否开启回收站</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[ON|OFF]</CheckingCode>
            <ParameterValue>OFF</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>ENABLE_SQL_FLASHBACK_EXACT_MATCH</ParameterName>
            <ParameterDescription>SQL 精确闪回开关</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[true|false]</CheckingCode>
            <ParameterValue>true</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>FORBID_EXECUTE_DML_ALL</ParameterName>
            <ParameterDescription>是否禁止全表删除/更新</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[true|false]</CheckingCode>
            <ParameterValue>false</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>INFO_SCHEMA_QUERY_WITH_STAT</ParameterName>
            <ParameterDescription>INFORMATION_SCHEMA.TABLES 查询是否聚合统计信息</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[SYSTEM|±HH:mm]</CheckingCode>
            <ParameterValue>SYSTEM</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>LOGICAL_DB_TIME_ZONE</ParameterName>
            <ParameterDescription>数据库时区</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[3600000-86400000]</CheckingCode>
            <ParameterValue>28800000</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>LOGIC_IDLE_TIMEOUT</ParameterName>
            <ParameterDescription>逻辑空闲链接超时时间</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[4194304-33554432]</CheckingCode>
            <ParameterValue>16777216</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>MAX_ALLOWED_PACKET</ParameterName>
            <ParameterDescription>最大包大小</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[1-100]</CheckingCode>
            <ParameterValue>10</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>MERGE_UNION_SIZE</ParameterName>
            <ParameterDescription>分表union合并数</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[-1-8]</CheckingCode>
            <ParameterValue>0</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>PARALLELISM</ParameterName>
            <ParameterDescription>SQL 精确闪回开关</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[-1-9223372036854775807]</CheckingCode>
            <ParameterValue>-1</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>PER_QUERY_MEMORY_LIMIT</ParameterName>
            <ParameterDescription>查询级内存池大小限制</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>00:00~23:59</CheckingCode>
            <ParameterValue>00:00-01:00</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>PURGE_TRANS_START_TIME</ParameterName>
            <ParameterDescription>事务日志清理开始时间段</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[1000-900000]</CheckingCode>
            <ParameterValue>1000</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>SLOW_SQL_TIME</ParameterName>
            <ParameterDescription>慢SQL阈值</ParameterDescription>
        </Parameters>
        <Parameters>
            <Dynamic>1</Dynamic>
            <CheckingCode>[0~3600000]</CheckingCode>
            <ParameterValue>900000</ParameterValue>
            <Revisable>1</Revisable>
            <ParameterName>SOCKET_TIMEOUT</ParameterName>
            <ParameterDescription>物理SQL超时时间</ParameterDescription>
        </Parameters>
        <Engine>polarx</Engine>
    </Data>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>39FAD755-1328-4796-942A-726C14******</requestId>
<successResponse>true</successResponse>

JSON 格式


{
  "code":"200",
  "data":{
    "RequestId":"39FAD755-1328-4796-942A-726C14******",
    "Data":{
      "ParameterCount":"20",
      "EngineVersion":"1.0",
      "Parameters":[
        {
          "Dynamic":1,
          "CheckingCode":"[1000-60000]",
          "ParameterValue":"5000",
          "Revisable":1,
          "ParameterName":"CONN_POOL_BLOCK_TIMEOUT",
          "ParameterDescription":"物理连接池获取连接的最大等待时间"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[1-60]",
          "ParameterValue":"30",
          "Revisable":1,
          "ParameterName":"CONN_POOL_IDLE_TIMEOUT",
          "ParameterDescription":"物理空闲链接超时时间"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[1-1600]",
          "ParameterValue":"60",
          "Revisable":1,
          "ParameterName":"CONN_POOL_MAX_POOL_SIZE",
          "ParameterDescription":"物理分库链接数最大值"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[0-60]",
          "ParameterValue":"20",
          "Revisable":1,
          "ParameterName":"CONN_POOL_MIN_POOL_SIZE",
          "ParameterDescription":"物理分库链接数最小值"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[true|false]",
          "ParameterValue":"true",
          "Revisable":1,
          "ParameterName":"ENABLE_BACKGROUND_STATISTIC_COLLECTION",
          "ParameterDescription":"是否允许统计数据采集"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[true|false]",
          "ParameterValue":"true",
          "Revisable":1,
          "ParameterName":"ENABLE_COMPLEX_DML_CROSS_DB",
          "ParameterDescription":"是否支持跨库复杂DML"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[true|false]",
          "ParameterValue":"true",
          "Revisable":1,
          "ParameterName":"ENABLE_LOCAL_MODE",
          "ParameterDescription":"是否启用LOCAL执行模式"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[true|false]",
          "ParameterValue":"false",
          "Revisable":1,
          "ParameterName":"ENABLE_RECYCLEBIN",
          "ParameterDescription":"是否开启回收站"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[ON|OFF]",
          "ParameterValue":"OFF",
          "Revisable":1,
          "ParameterName":"ENABLE_SQL_FLASHBACK_EXACT_MATCH",
          "ParameterDescription":"SQL 精确闪回开关"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[true|false]",
          "ParameterValue":"true",
          "Revisable":1,
          "ParameterName":"FORBID_EXECUTE_DML_ALL",
          "ParameterDescription":"是否禁止全表删除/更新"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[true|false]",
          "ParameterValue":"false",
          "Revisable":1,
          "ParameterName":"INFO_SCHEMA_QUERY_WITH_STAT",
          "ParameterDescription":"INFORMATION_SCHEMA.TABLES 查询是否聚合统计信息"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[SYSTEM|±HH:mm]",
          "ParameterValue":"SYSTEM",
          "Revisable":1,
          "ParameterName":"LOGICAL_DB_TIME_ZONE",
          "ParameterDescription":"数据库时区"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[3600000-86400000]",
          "ParameterValue":"28800000",
          "Revisable":1,
          "ParameterName":"LOGIC_IDLE_TIMEOUT",
          "ParameterDescription":"逻辑空闲链接超时时间"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[4194304-33554432]",
          "ParameterValue":"16777216",
          "Revisable":1,
          "ParameterName":"MAX_ALLOWED_PACKET",
          "ParameterDescription":"最大包大小"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[1-100]",
          "ParameterValue":"10",
          "Revisable":1,
          "ParameterName":"MERGE_UNION_SIZE",
          "ParameterDescription":"分表union合并数"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[-1-8]",
          "ParameterValue":"0",
          "Revisable":1,
          "ParameterName":"PARALLELISM",
          "ParameterDescription":"SQL 精确闪回开关"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[-1-9223372036854775807]",
          "ParameterValue":"-1",
          "Revisable":1,
          "ParameterName":"PER_QUERY_MEMORY_LIMIT",
          "ParameterDescription":"查询级内存池大小限制"
        },
        {
          "Dynamic":1,
          "CheckingCode":"00:00~23:59",
          "ParameterValue":"00:00-01:00",
          "Revisable":1,
          "ParameterName":"PURGE_TRANS_START_TIME",
          "ParameterDescription":"事务日志清理开始时间段"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[1000-900000]",
          "ParameterValue":"1000",
          "Revisable":1,
          "ParameterName":"SLOW_SQL_TIME",
          "ParameterDescription":"慢SQL阈值"
        },
        {
          "Dynamic":1,
          "CheckingCode":"[0~3600000]",
          "ParameterValue":"900000",
          "Revisable":1,
          "ParameterName":"SOCKET_TIMEOUT",
          "ParameterDescription":"物理SQL超时时间"
        }
      ],
      "Engine":"polarx"
    }
  },
  "httpStatusCode":"200",
  "requestId":"39FAD755-1328-4796-942A-726C14******",
  "successResponse":true
}
文章标签：
云原生分布式数据库 PolarDB-X
API
数据格式
存储
JSON
XML
开发者小达人
目录
相关文章
公众号:码到三十五
|
存储 监控 NoSQL
RedisSearch与Elasticsearch：技术对比与选择指南
RedisSearch与Elasticsearch：技术对比与选择指南
公众号:码到三十五
1208 5
黑客下午茶
|
网络协议 Ubuntu 关系型数据库
分布式 PostgreSQL 集群(Citus)官方安装指南
分布式 PostgreSQL 集群(Citus)官方安装指南
黑客下午茶
1771 0
惜元
|
SQL 关系型数据库 分布式数据库
从Citus深度解密如何基于PostgreSQL做分布式数据库
前言分布式数据库能够解决海量数据存储、超高并发吞吐、大表瓶颈以及复杂计算效率等单机数据库瓶颈难题，当业务体量即将突破单机数据库承载极限和单表过大导致性能、维护问题时，分布式数据库是解决上述问题的高性价比方案。数据库作为分布式改造的最大难点，就是&quot;和使用单机数据库一样使用分布式数据库&quot;，这也一直是广大...
惜元
6446 0
从Citus深度解密如何基于PostgreSQL做分布式数据库
一码平川MACHEL
|
监控 大数据 数据挖掘
【最全资料下载】Python 系列直播——深入Python与日志服务，玩转大规模数据分析处理实战
直播讲师：丁来强（成喆）——阿里高级技术专家，从事阿里云日志服务相关的产品与研发工作，擅长AIOps/SecOps的大数据分析平台构建与场景落地，擅长C++与Python语言等。PyCon历届讲师，曾经在中国PyCon2015、2016与2018分享过7场/6个不同议题，覆盖Jupyter扩展、大数据分析可视化、工作流调度、函数式、设计模式、Python核心语言等方面，广受好评。
一码平川MACHEL
12965 0
开发者小达人
|
关系型数据库 MySQL 开发者
不可思议的一致性读场景
不可思议的一致性读场景
开发者小达人
252 0
行者武松
|
NoSQL 搜索推荐 测试技术
【独家】RediSearch - Redis强大的搜索引擎
行者武松
7468 0
人工智能 缓存 前端开发
10170 49
人工智能 JavaScript 开发工具
4070 13
开发工具 Swift git
1583 2
PolarDB开源

PolarDB 分布式版

热门文章

最新文章

  • 1
    PolarDB-X 开源 | 基于Paxos的MySQL三副本
  • 2
    Linux 环境 国产银河麒麟V10操作系统安装 Polardb-X 数据库 单机版 rpm 包 教程
  • 3
    Linux 环境 Docker 安装 Polardb-X 数据库 容器 教程
  • 4
    PolarDB-X 存储引擎核心技术 | Lizard分布式事务系统
  • 5
    Linux 环境 Polardb-X 数据库 单机版 rpm 包 安装教程
  • 6
    开源新发布｜PolarDB-X v2.4.2开源生态适配升级
  • 7
    PolarDB-X 分布式数据库中的外键
  • 8
    [重磅更新]PolarDB-X V2.3 集中式和分布式一体化开源发布
  • 9
    航天壹进制 PolarDB-X 1.0（DRDS） 数据备份容灾解决方案
  • 10
    Linux 环境 国产 华为 欧拉 openEuler 20.03 操作系统安装 Polardb-X 数据库 单机版 rpm 包 教程
  • 1
    PolarDB-X 存储引擎核心技术 | 索引前缀压缩 - Prefix Compression
    203
  • 2
    原理解读｜PolarDB-X 列存索引、列存快照
    388
  • 3
    PXD 部署 阿里云 PolarDB-X 集群（企业版、标准版）教程
    2480
  • 4
    K8S 部署 阿里云 PolarDB-X 集群（企业版、标准版）minikube 教程
    2934
  • 5
    Linux 环境 Docker 安装 Polardb-X 数据库 容器 教程
    1442
  • 6
    Linux 环境 Debian 10 操作系统安装 Polardb-X 数据库 单机版 deb 包 教程
    647
  • 7
    ARM Linux 环境 国产 华为 欧拉 openEuler 20.03 操作系统安装 Polardb-X 数据库 单机版 rpm 包 教程
    1351
  • 8
    Linux 环境 Ubuntu 18.04.6 操作系统安装 Polardb-X 数据库 单机版 deb 包 教程
    624
  • 9
    PolarDB-X 集中式三节点高可用集群部署 & Java 场景 CRUD 应用
    829
  • 10
    Linux 环境 国产 华为 欧拉 openEuler 20.03 操作系统安装 Polardb-X 数据库 单机版 rpm 包 教程
    1143

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    一条命令迁移，帮你实现 OpenClaw 与 Hermes Agent 记忆互通！