查询默认参数列表

最近更新时间:2024-06-07 02:17:38

我的收藏

1. 接口描述

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

本接口(DescribeDefaultParameters)主要用于查询某个数据库版本和引擎支持的所有参数。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDefaultParameters。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DBMajorVersion String 数据库版本,大版本号,例如11,12,13
示例值:13
DBEngine String 数据库引擎,例如:postgresql,mssql_compatible
示例值:postgresql

3. 输出参数

参数名称 类型 描述
TotalCount Integer 参数个数
示例值:2
ParamInfoSet Array of ParamInfo 参数信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:[ { "Advanced": false, "ClassificationCN": "AUTOVACUUM", "ClassificationEN": "Autovacuum", "CurrentValue": "", "DefaultValue": "-1", "EnumValue": null, "ID": 1409, "LastModifyTime": "", "Max": 10000, "Min": -1, "Name": "autovacuum_vacuum_cost_limit", "NeedReboot": false, "ParamDescriptionCH": "指定用于AUTOVACUUM操作中的代价限制值。如果指定-1(默认值),则使用vacuum_cost_limit值", "ParamDescriptionEN": "Vacuum cost amount available before napping, for autovacuum.", "ParamValueType": "integer", "SpecRelated": false, "StandbyRelated": 0, "Unit": "" } ]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询某个参数模板支持添加的所有参数的信息

输入示例

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

{
    "DBMajorVersion": "13",
    "DBEngine": "postgresql"
}

输出示例

{
    "Response": {
        "RequestId": "b6cf4dfc-09ce-4ee4-9c3e-0979e105bb4d",
        "TotalCount": 4,
        "ParamInfoSet": [
            {
                "Advanced": false,
                "ClassificationCN": "查询优化",
                "ClassificationEN": "Query Tuning",
                "CurrentValue": "",
                "DefaultValue": "500000",
                "EnumValue": [],
                "ID": 14092,
                "LastModifyTime": "",
                "Max": 123124123,
                "Min": -1,
                "Name": "jit_inline_above_cost",
                "NeedReboot": false,
                "ParamDescriptionCH": "设置JIT编译尝试内联函数和操作符的查询代价阈值,如果查询代价超过这个值,JIT编译就会尝试内联",
                "ParamDescriptionEN": "Perform JIT inlining if query is more expensive.-1 disables inlining.",
                "ParamValueType": "real",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            },
            {
                "Advanced": false,
                "ClassificationCN": "AUTOVACUUM",
                "ClassificationEN": "Autovacuum",
                "CurrentValue": "",
                "DefaultValue": "400000000",
                "EnumValue": [],
                "ID": 14131,
                "LastModifyTime": "",
                "Max": 2000000000,
                "Min": 10000,
                "Name": "autovacuum_multixact_freeze_max_age",
                "NeedReboot": true,
                "ParamDescriptionCH": "设置表上多事务场景下的最大年龄,达到这个阀值将触发 autovacuum进程,从而避免 wraparound.",
                "ParamDescriptionEN": "Multixact age at which to autovacuum a table to prevent multixact wraparound.",
                "ParamValueType": "integer",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            },
            {
                "Advanced": false,
                "ClassificationCN": "客户端连接默认值",
                "ClassificationEN": "Client Connection Defaults",
                "CurrentValue": "",
                "DefaultValue": "\"$user\", public",
                "EnumValue": [],
                "ID": 14173,
                "LastModifyTime": "",
                "Max": 0,
                "Min": 0,
                "Name": "search_path",
                "NeedReboot": false,
                "ParamDescriptionCH": "默认的search_path",
                "ParamDescriptionEN": "Sets the schema search order for names that are not schema-qualified.",
                "ParamValueType": "string",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            },
            {
                "Advanced": false,
                "ClassificationCN": "客户端连接默认值",
                "ClassificationEN": "Client Connection Defaults",
                "CurrentValue": "",
                "DefaultValue": "150000000",
                "EnumValue": [],
                "ID": 14175,
                "LastModifyTime": "",
                "Max": 2000000000,
                "Min": 0,
                "Name": "vacuum_multixact_freeze_table_age",
                "NeedReboot": false,
                "ParamDescriptionCH": "当表的pg_class.relfrozenxid域达到该设置指定的年龄时,VACUUM会执行一次全表扫描。 积极的扫描不同于常规的VACUUM,因为它会访问每个可能包含未冻结XID或MXID的页面,而不仅仅是那些可能包含死元组的页面",
                "ParamDescriptionEN": "Multixact age at which VACUUM should scan whole table to freeze tuples.",
                "ParamValueType": "integer",
                "SpecRelated": false,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            }
        ]
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DatabaseAccessError 管控元数据库访问失败,请稍后重试。如果持续不成功,请联系客服进行处理。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
InvalidParameter.ParameterCheckError 参数检查失败。
InvalidParameterValue.InvalidParameterValueError 参数值有误。