All Products
Search
Document Center

ApsaraDB RDS:DescribeDBProxy

Last Updated:Feb 29, 2024

Queries the settings of the dedicated proxy for an instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDBProxyREAD
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
DBInstanceIdstringYes

The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

rm-bp1ja4f56s7us****
RegionIdstringNo

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBProxyEngineTypestringNo

A reserved parameter. You do not need to specify this parameter.

normal
ResourceGroupIdstringNo

The ID of the resource group.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

DBProxyInstanceLatestMinorVersionstring

The latest version that is available for the proxy instance.

1.13.12
RequestIdstring

The ID of the request.

909A69EE-71C8-4417-A0B9-FF085407E1E3
DBProxyInstanceCurrentMinorVersionstring

The version of the proxy instance.

1.13.11
DBProxyInstanceNuminteger

The number of proxies that are enabled on the instance.

1
DBProxyInstanceTypestring

The type of the database proxy that is enabled on the instance.

  • 1: shared proxy
  • 2: dedicated proxy
Note ApsaraDB RDS for PostgreSQL instances support only dedicated proxies.
2
DBProxyPersistentConnectionStatusstring

Connection Persistence State.

Valid values:

  • Enabled: Enabled
  • Disabled: Disabled
  • Unsupported: The instance does not support connection persistence
Disabled
DBProxyInstanceStatusstring

The status of the proxy instance.

  • DBInstanceClassChanging: The specifications of the proxy instance are being changed.
  • Creating: The proxy instance is being created.
  • Running: The proxy instance is running.
  • Deleting: The proxy instance is being deleted.
Running
DBProxyServiceStatusstring

The status of the database proxy.

  • Shutdown: disabled
  • Startup: enabled
Startup
DBProxyInstanceNamestring

The name of the proxy instance.

gos787jog2wk0ye1****
DBProxyInstanceSizestring

This parameter is available only for ApsaraDB RDS for PostgreSQL instances. The specifications of the proxy instance that is enabled.

Format: Number of cores/Memory capacity.

For example, a value of 4/8 indicates that the proxy instance has 4 cores and 8 GB of memory.

4/8
DBProxyEngineTypestring

An internal parameter. You can ignore this parameter.

normal
DBProxyConnectStringItemsobject []

An array consisting of the information about the database proxy endpoint that is created for the instance.

DBProxyConnectStringNetWorkTypestring

The network type of the database proxy. Valid values:

  • 0: Internet
  • 1: classic network
  • 2: virtual private cloud (VPC)
2
DBProxyConnectStringNetTypestring

The network type of the database proxy endpoint. A database proxy endpoint is formerly referred to as a proxy terminal. Valid values:

  • OuterString: Internet
  • InnerString: internal network
InnerString
DBProxyVpcInstanceIdstring

The ID of the database proxy instance.

rm-bp145737x5****131161274792****
DBProxyEndpointNamestring

The name of the database proxy endpoint. The name can be replaced by the ID of the database proxy endpoint.

gos787jog2wk0ye1****
DBProxyEndpointIdstring

The ID of the backend database proxy endpoint.

20****
DBProxyConnectStringPortstring

The port that is associated with the database proxy endpoint.

3306
DBProxyConnectStringstring

The database proxy endpoint.

gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
DBProxyVpcIdstring

The VPC of the database proxy.

vpc-uf6oobt****
DBProxyVswitchIdstring

The vSwitch of the database proxy.

vsw-uf6l0pic17****
DbProxyEndpointItemsobject []

The proxy terminals of the instance.

DbProxyEndpointAliasesstring

The description of the database proxy endpoint.

proxy-test
DbProxyEndpointNamestring

The ID of the database proxy endpoint.

gos787jog2wk0ye1****
DbProxyEndpointTypestring

The type of the database proxy endpoint. Valid values:

  • Custom: custom database proxy endpoint
  • RWSplit: default database proxy endpoint
RWSplit
DbProxyReadWriteModestring

The read and write attributes of the database proxy endpoint.

  • ReadOnly
  • ReadWrite
ReadWrite
ResourceGroupIdstring

The ID of the resource group.

rg-acfmy*****
DBProxyAVZonesarray

The list of zones that are available for the database proxy.

string

The zone that is available for the database proxy.

cn-shanghai-e

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400RWSplitNetTypeNotExistsSpecified rw split net type is not eixsts.-
400InvalidDBInstanceNameSpecified 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.
400InvalidInstanceLevelExtraInfoSpecified class code has error extra info.-
403IncorrectKindCodeCurrent 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.
403IncorrectDBInstanceTypeThe database instance type does not support the operation.The operation failed. The operation is not supported for the database engine of the RDS instance.
403IncorrectDBInstanceEngineCurrent 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.
404InvalidDBInstanceName.NotFoundThe 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 timeSummary of changesOperation
2023-12-19The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Error Codes 403 change
    Added Error Codes: 404
2023-12-12The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.
2023-11-23The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.
2023-03-14The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Output ParametersThe response structure of the API has changed.
2022-06-08The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
    delete Error Codes: 403
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: DBProxyEngineType
Output ParametersThe response structure of the API has changed.