You need to enable JavaScript to run this app.
RDS for MySQL

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Managing connectionsDescribeDBProxyConfig
Copy page
Download PDF
Managing connections
DescribeDBProxyConfig
Copy page
Download PDF
DescribeDBProxyConfig

Call the DescribeDBProxyConfig API to query the database proxy information of a specified MySQL instance.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-46609cf2****
Instance ID.

Response parameters

Name
Type
Example
Description
BinlogDump
Boolean
true

Whether binlog capability is supported. Valid values:

  • true: Yes.
  • false: No.

tip

This parameter is returned only when the database proxy feature of the instance is enabled.

CheckModifyDBProxyAllowed
Object
See the response example.

Judgment information indicating whether the ModifyDBProxy API can be executed.

tip

This field is deprecated.

Allowed
Boolean
true

Whether to allow to turn on or off the database proxy function. Value:

  • true: Allowed.
  • false: Not allowed.
Reason
String
Other
When Allowed is false, return the classification of the reasons why the database proxy function is not allowed to be enabled or disabled.
Message
String
The current instance status is not running and does not support switching the proxy.
When Allowed is false, return the specific reasons why it is not allowed to turn on or off the database proxy function.
CheckModifyDBProxyAllowedV2
Object[]
See the response example.
Check result indicating whether the ModifyDBProxyAPI can be executed.
Allowed
Boolean
false

Whether to allow to turn on or off the database proxy function. Values:

  • true: Allowed.
  • false: Not allowed.
CheckItem
String
InstanceConfig

Check items when enabling or disabling the database proxy function.

  • InstanceVersion: Instance version
  • InstanceStatus: Instance status
  • AllowlistLimit: Whitelist limit
  • InstanceConfig: Instance configuration
  • SystemConstraint: System constraint
  • Other: Others
Reason
String
The current instance has enabled the transaction-level connection pool and does not support switching the proxy.
The detailed reasons why the database proxy function is not allowed to be enabled or disabled.
ConnectionPoolType
String
Transaction

The type of the connection pool. This parameter is returned only when the database proxy is enabled. Valid values:

  • Direct: Direct connection mode.
  • Transaction: Transaction-level connection pool.
DBProxyStatus
String
Creation

The running status of the proxy instance. Values:

  • Creating: The proxy is being opened.
  • Running: The proxy is running.
  • Shutdown: The proxy has been closed.
  • Deleting: The proxy is being closed.

tip

This parameter is only returned when the database proxy function of the instance is enabled.

FeatureStates
Object[]
See the response example.
Feature status.
FeatureName
String
ProxyBinlogDump
Function Name.
Enable
Boolean
false

Whether to turn on. Values:

  • true: Turn on.
  • false: Turn off.
Support
Boolean
true

Whether the function is supported. Values:

  • true: Supported.
  • false: Not supported.
GlobalReadOnly
Boolean
true

Whether global read-only is enabled.

  • true: Yes.
  • false: No.
InstanceId
String
mysql-46609cf2****
Instance ID.
ProxyResourceInfo
Object
See the response example.
Configuration information of the instance's database proxy service.
MaxProxyCpuNum
Integer
1024
The maximum number of cores that the user can configure for the database proxy service.
MinProxyCpuNum
Integer
2
The minimum number of cores that a user can configure for the database proxy service.
CurrentProxyCpuNum
Integer
2
The number of cores of the current instance database proxy service.

Sample request 

POST /?Action=DescribeDBProxyConfig&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-46609cf2****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20230809195305F4B9418A25C0D091AECF",
        "Action": "DescribeDBProxyConfig",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BinlogDump": false,
        "CheckModifyDBProxyAllowed": {
            "Allowed": false,
            "Message": "当前实例已开启事务级连接池，不支持开关代理",
            "Reason": "Other"
        },
        "CheckModifyDBProxyAllowedV2": [
            {
                "Allowed": false,
                "CheckItem": "InstanceConfig",
                "Reason": "当前实例已开启事务级连接池，不支持开关代理"
            }
        ],
        "ConnectionPoolType": "Transaction",
        "DBProxyStatus": "Running",
        "FeatureStates": [
            {
                "Enable": false,
                "FeatureName": "ProxyBinlogDump",
                "Support": true
            }
        ],
        "GlobalReadOnly": false,
        "InstanceId": "mysql-46609cf2****",
        "ProxyResourceInfo": {
            "CurrentProxyCpuNum": 6,
            "MaxProxyCpuNum": 1024,
            "MinProxyCpuNum": 2
        }
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.08.25 16:17:35