DescribeDBInstanceParameters--云数据库 PostgreSQL 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceParameters

最近更新时间：2024.12.13 12:00:08首次发布时间：2023.11.15 22:39:51

调用 DescribeDBInstanceParameters 接口查询实例参数。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
ParameterName	String	否	auto_increment_increment	参数名称，支持模糊查询。说明不传值或传空值时，会查询指定实例下的所有参数。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-21a3333b****	实例 ID。
DBEngineVersion	String	PostgreSQL_12	兼容版本。取值： `PostgreSQL_11`：PostgreSQL 11。 `PostgreSQL_12`：PostgreSQL 12。 `PostgreSQL_13`：PostgreSQL 13。 `PostgreSQL_14`：PostgreSQL 14。 `PostgreSQL_15`：PostgreSQL 15。 `PostgreSQL_16`：PostgreSQL 16。
ParameterCount	String	56	参数个数。
Parameters	Object[]	请参见返回示例。	该实例当前运行的参数列表。

示例

请求示例

POST /?Action=DescribeDBInstanceParameters&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "postgres-ca7b7019****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230804115231D0A40DAC141F3F09F3A9",
        "Action": "DescribeDBInstanceParameters",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBEngineVersion": "PostgreSQL_12",
        "InstanceId": "postgres-ca7b7019****",
        "ParameterCount": "2",
        "Parameters": [
            {
                "CheckingCode": "[on|off]",
                "DefaultValue": "off",
                "Description": "Use EXPLAIN ANALYZE for plan logging.",
                "ForceRestart": false,
                "Name": "auto_explain.log_analyze",
                "Type": "Enum",
                "Value": "on"
            },
            {
                "CheckingCode": "[0-1]",
                "DefaultValue": "1",
                "Description": "Fraction of queries to process.",
                "ForceRestart": false,
                "Name": "auto_explain.sample_rate",
                "Type": "Float",
                "Value": "1"
            }
        ]
    }
}