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

文档中心

立即注册

导航

DescribeDBInstanceProxyParameters

最近更新时间：2025.04.23 14:22:49首次发布时间：2025.04.23 14:22:49

调用 DescribeDBInstanceProxyParameters 接口查询实例默认终端开启读写分离后的连接数参数的配置。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-0af11cd4****	实例 ID。
ParameterName	String	否	ReadWriteProxyConnection	连接终端开启读写分离后，连接终端的代理相关参数。说明当前仅支持取值为 ReadWriteProxyConnection，即连接数参数。该参数默认值为空。取空值时，接口的返回值也为空。
EndpointId	String	否	postgres-0af11cd4****-cluster	连接终端 ID。说明该参数默认值为实例默认终端的 ID。当前仅支持传入实例默认终端的 ID。

返回参数

参数	类型	示例值	描述
InstanceId	String	postgres-0af11cd4****	实例 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。 `PostgreSQL_17`：PostgreSQL 17。
ParameterCount	String	1	参数个数。
Parameters	Object[]	请参见返回示例。	该 Proxy 当前运行的参数列表。

示例

请求示例

POST /?Action=DescribeDBInstanceProxyParameters&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-f511b775****",
    "EndpointId": "postgres-f511b775****-cluster",
    "ParameterName": "ReadWriteProxyConnection"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2025031919422828B3EE5B6F629AFF0F74-bb2104",
        "Action": "DescribeDBInstanceProxyParameters",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": {
        "DBEngineVersion": "PostgreSQL_17",
        "InstanceId": "postgres-f511b775****",
        "ParameterCount": "1",
        "Parameters": [
            {
                "CheckingCode": "[20-200]",
                "DefaultValue": "200",
                "Description": "After the endpoint opens the read-write split, the corresponding proxy connection number parameter.",
                "DescriptionZH": "终端开了读写分离后，其所对应的代理的连接数参数。",
                "ForceRestart": true,
                "Name": "ReadWriteProxyConnection",
                "Type": "integer",
                "Value": "20"
            }
        ]
    }
}