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

RDS for MySQL

  • Documentation
    • RDS for MySQLAPI referenceV2（2022-01-01）Managing instancesDescribeDBProxy
Copy page
Download PDF
Managing instances
DescribeDBProxy
Copy page
Download PDF
DescribeDBProxy

Call the DescribeDBProxy API to query the proxy configuration of the instance.

Request type

Synchronous request.

Request parameters

Name
Type
Required
Example
Description
InstanceId
String
Yes
mysql-54fc7408****
Instance ID.

Response parameters

Name
Type
Example
Description
ProxyDetail
Object
Please refer to the return example.
Proxy information
DBProxyStatus
String
Shutdown

The status of the database proxy function of the instance. Values:

  • Creating: The proxy is being started.

  • Running: The proxy is running.

  • Shutdown: The proxy has been shut down.

  • Deleting: The proxy is being shut down.

ProxyResourceInfo
Object
Please refer to the return example.
The resource information of the database proxy service of the instance.
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=DescribeDBProxy&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-54fc7408****"
}

Sample response 

{
    "ResponseMetadata": {
        "RequestId": "20250724200740F86AA2C013975813C517-16fc92",
        "Action": "DescribeDBProxy",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "ProxyDetail": {
            "DBProxyStatus": "Running",
            "ProxyResourceInfo": {
                "CurrentProxyCpuNum": 2,
                "MaxProxyCpuNum": 1024,
                "MinProxyCpuNum": 2
            }
        }
    }
}

Error codes

For more details, refer to Error codes.

Last updated: 2025.08.15 18:32:46