查询实例参数

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

我的收藏

1. 接口描述

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

本接口(DescribeDBInstanceAttribute)用于查询实例的参数信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDBInstanceParameters。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
DBInstanceId String 实例ID
示例值:postgres-xxx
ParamName String 查询指定参数详情。ParamName为空或不传,默认返回全部参数列表
示例值:wal_level

3. 输出参数

参数名称 类型 描述
TotalCount Integer 参数列表总数
示例值:1
Detail Array of ParamInfo 参数列表返回详情
示例值:[ { "Advanced": false, "ClassificationCN": "连接和认证", "ClassificationEN": "Connections and Authentication", "CurrentValue": "2048", "DefaultValue": "2048", "EnumValue": null, "ID": 15124, "LastModifyTime": "", "Max": 2048, "Min": 100, "Name": "max_connections", "NeedReboot": true, "ParamDescriptionCH": "实例最大连接数", "ParamDescriptionEN": "Sets the maximum number of concurrent connections.", "ParamValueType": "integer", "SpecRelated": true, "SpecRelationSet": null, "StandbyRelated": 0, "Unit": "", "VersionRelationSet": null } ]
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询实例指定参数信息

查询实例postgres-lzrwgg6d的max_connecions参数信息

输入示例

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

{
    "ParamName": "max_connections",
    "DBInstanceId": "postgres-lzrwgg6d"
}

输出示例

{
    "Response": {
        "Detail": [
            {
                "Advanced": false,
                "ClassificationCN": "连接和认证",
                "ClassificationEN": "Connections and Authentication",
                "CurrentValue": "2048",
                "DefaultValue": "2048",
                "EnumValue": null,
                "ID": 15124,
                "LastModifyTime": "",
                "Max": 2048,
                "Min": 100,
                "Name": "max_connections",
                "NeedReboot": true,
                "ParamDescriptionCH": "实例最大连接数",
                "ParamDescriptionEN": "Sets the maximum number of concurrent connections.",
                "ParamValueType": "integer",
                "SpecRelated": true,
                "SpecRelationSet": null,
                "StandbyRelated": 0,
                "Unit": "",
                "VersionRelationSet": null
            }
        ],
        "RequestId": "ce4ecf74-b26f-44e7-9340-539032e92b9f",
        "TotalCount": 1
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CamAuthFailed CAM鉴权失败。
FailedOperation.FailedOperationError 操作失败,请稍后重试。
InternalError.InternalHttpServerError 请求执行异常。
InternalError.UnknownError 其他未知错误。出现这种错误时,请联系客服支持。
InvalidParameterValue.InvalidParameterValueError 参数值有误。
OperationDenied.CamDeniedError 当前操作被限制。
OperationDenied.InstanceAccessDeniedError 您没有权限操作当前资源。
ResourceNotFound.InstanceNotFoundError 实例不存在。
UnknownError 其他未知错误。出现这种错误时,请联系客服支持。