Queries the settings of the dedicated proxy for an instance.
Operation description
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
Parameter | Type | Required | Description | Example |
---|---|---|---|---|
DBInstanceId | string | Yes | The instance ID. You can call the DescribeDBInstances operation to query the instance ID. | rm-bp1ja4f56s7us**** |
RegionId | string | No | The region ID. You can call the DescribeRegions operation to query the most recent region list. | cn-hangzhou |
DBProxyEngineType | string | No | A reserved parameter. You do not need to specify this parameter. | normal |
ResourceGroupId | string | No | The ID of the resource group. | rg-acfmy***** |
Response parameters
Examples
Sample success responses
JSON
format
{
"DBProxyInstanceLatestMinorVersion": "1.13.12",
"RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
"DBProxyInstanceCurrentMinorVersion": "1.13.11",
"DBProxyInstanceNum": 1,
"DBProxyInstanceType": "2",
"DBProxyPersistentConnectionStatus": "Disabled",
"DBProxyInstanceStatus": "Running",
"DBProxyServiceStatus": "Startup",
"DBProxyInstanceName": "gos787jog2wk0ye1****",
"DBProxyInstanceSize": "4/8",
"DBProxyEngineType": "normal",
"DBProxyConnectStringItems": {
"DBProxyConnectStringItems": [
{
"DBProxyConnectStringNetWorkType": "2",
"DBProxyConnectStringNetType": "InnerString",
"DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
"DBProxyEndpointName": "gos787jog2wk0ye1****",
"DBProxyEndpointId": "20****",
"DBProxyConnectStringPort": "3306",
"DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
"DBProxyVpcId": "vpc-uf6oobt****",
"DBProxyVswitchId": "vsw-uf6l0pic17****"
}
]
},
"DbProxyEndpointItems": {
"DbProxyEndpointItems": [
{
"DbProxyEndpointAliases": "proxy-test",
"DbProxyEndpointName": "gos787jog2wk0ye1****",
"DbProxyEndpointType": "RWSplit",
"DbProxyReadWriteMode": "ReadWrite"
}
]
},
"ResourceGroupId": "rg-acfmy*****",
"DBProxyAVZones": {
"DBProxyAVZones": [
"cn-shanghai-e"
]
}
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
400 | RWSplitNetTypeNotExists | Specified rw split net type is not eixsts. | - |
400 | InvalidDBInstanceName | Specified parameter DBInstanceName is not valid. | The value of the DBInstanceName parameter is invalid. Check that the value of this parameter is not null or an empty string. |
400 | InvalidInstanceLevelExtraInfo | Specified class code has error extra info. | - |
403 | IncorrectKindCode | Current custins kindCode does not support this operation. | The operation failed. The operation is not supported for the database engine that is run on the RDS instance. |
403 | IncorrectDBInstanceType | The database instance type does not support the operation. | The operation failed. The operation is not supported for the database engine of the RDS instance. |
403 | IncorrectDBInstanceEngine | Current DB Instance engine does not support this operation. | The operation failed. The operation is not supported for the database engine that is run on the RDS instance. |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | The name of the RDS instance cannot be found. Check the name of the RDS instance. |
For a list of error codes, visit the Service error codes.
Change history
Change time | Summary of changes | Operation |
---|---|---|
2023-12-19 | The Error code has changed | View Change Details |
2023-12-12 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-11-23 | The Error code has changed. The response structure of the API has changed | View Change Details |
2023-03-14 | The Error code has changed. The response structure of the API has changed | View Change Details |
2022-06-08 | The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed | View Change Details |