调用DescribeParameterTemplates接口查看参数模版详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

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

系统规定参数。取值为DescribeParameterTemplates

DBInstanceId String pxc-*********************

实例ID。

RegionId String cn-hangzhou

实例所在地域。

ParamLevel String compute

参数级别,取值范围如下:

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

返回数据

名称 类型 示例值 描述
Data Struct

请求返回数据。

Engine String polarx

引擎类型,目前仅支持polarx

EngineVersion String 1.0

引擎版本,目前仅支持1.0

ParameterCount Integer 20

参数个数。

Parameters Array of TemplateRecord

参数详情列表。

CheckingCode String [true|false]

目标参数的取值范围。

Dynamic Integer 1

是否需要重启实例新参数值才能生效,取值范围如下:

  • 1:需要重启
  • 0:不需要重启
ParameterDescription String 是否开启回收站

参数的描述信息。

ParameterName String ENABLE_RECYCLEBIN

参数名称。

ParameterValue String false

参数的默认值。

Revisable Integer 1

参数是否对支持被修改,取值范围如下:

  • 1:支持修改
  • 0:不支持修改(即目标参数为只读参数)
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
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidDBInstance.NotFound The specified DB instance does not exist. 数据库实例不存在

访问错误中心查看更多错误码。