All Products
Search
Document Center

ApsaraDB RDS:DescribeDBProxy

最終更新日:Oct 31, 2024

Queries the settings of the database proxy feature for an instance.

Operation description

Supported database engines

  • RDS MySQL
  • RDS PostgreSQL

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

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 deprecated 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.

DBProxyAVZonesarray

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

DBProxyAVZonesstring

The zone that is available for the database proxy.

cn-shanghai-e
DBProxyConnectStringItemsarray<object>

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

DBProxyConnectStringItemsobject

The proxy endpoint that is created for the instance.

DBProxyConnectStringstring

The database proxy endpoint.

gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com
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
DBProxyConnectStringNetWorkTypestring

The network type of the database proxy. Valid values:

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

The port that is associated with the database proxy endpoint.

3306
DBProxyEndpointIdstring

The ID of the backend database proxy endpoint.

20****
DBProxyEndpointNamestring

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

gos787jog2wk0ye1****
DBProxyVpcIdstring

The VPC of the database proxy.

vpc-uf6oobt****
DBProxyVpcInstanceIdstring

The ID of the database proxy instance.

rm-bp145737x5****131161274792****
DBProxyVswitchIdstring

The vSwitch of the database proxy.

vsw-uf6l0pic17****
DBProxyEngineTypestring

An internal parameter. You can ignore this parameter.

normal
DBProxyInstanceCurrentMinorVersionstring

The version of the proxy instance.

1.13.11
DBProxyInstanceLatestMinorVersionstring

The latest version that is available for the proxy instance.

1.13.12
DBProxyInstanceNamestring

The name of the proxy instance.

gos787jog2wk0ye1****
DBProxyInstanceNuminteger

The number of proxies that are enabled on the instance.

1
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
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
DBProxyInstanceTypestring

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

  • 1: shared database proxy
  • 2: dedicated database proxy
  • 3: general-purpose database proxy
Note ApsaraDB RDS for PostgreSQL does not support shared database proxies.
2
DBProxyKindCodestring

Internal parameters, no need to pay attention.

18
DBProxyNodesarray<object>

The proxy node list.

DBProxyNodesobject
cpuCoresstring

The number of cpu cores for the node.

2
nodeIdstring

The proxy node id.

pn-xxxxxxx01
zoneIdstring

The id of the availability zone where the node is located.

cn-hangzhou-c
DBProxyPersistentConnectionStatusstring

The status of persistence connections. Valid values:

  • Enabled
  • Disabled
  • Unsupported
Disabled
DBProxyServiceStatusstring

The status of the database proxy.

  • Shutdown: disabled
  • Startup: enabled
Startup
DbProxyEndpointItemsarray<object>

The proxy terminals of the instance.

DbProxyEndpointItemsobject

The information about the proxy terminal.

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
RequestIdstring

The ID of the request.

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

The ID of the resource group.

rg-acfmy*****

Examples

Sample success responses

JSONformat

{
  "DBProxyAVZones": {
    "DBProxyAVZones": [
      "cn-shanghai-e"
    ]
  },
  "DBProxyConnectStringItems": {
    "DBProxyConnectStringItems": [
      {
        "DBProxyConnectString": "gos787jog2wk0ye1****-rw4rm.rwlb.rds.aliyuncs.com",
        "DBProxyConnectStringNetType": "InnerString",
        "DBProxyConnectStringNetWorkType": "2",
        "DBProxyConnectStringPort": "3306",
        "DBProxyEndpointId": "20****",
        "DBProxyEndpointName": "gos787jog2wk0ye1****",
        "DBProxyVpcId": "vpc-uf6oobt****",
        "DBProxyVpcInstanceId": "rm-bp145737x5****131161274792****",
        "DBProxyVswitchId": "vsw-uf6l0pic17****"
      }
    ]
  },
  "DBProxyEngineType": "normal",
  "DBProxyInstanceCurrentMinorVersion": "1.13.11",
  "DBProxyInstanceLatestMinorVersion": "1.13.12",
  "DBProxyInstanceName": "gos787jog2wk0ye1****",
  "DBProxyInstanceNum": 1,
  "DBProxyInstanceSize": "4/8",
  "DBProxyInstanceStatus": "Running",
  "DBProxyInstanceType": "2",
  "DBProxyKindCode": "18",
  "DBProxyNodes": {
    "DBProxyNodes": [
      {
        "cpuCores": "2",
        "nodeId": "pn-xxxxxxx01",
        "zoneId": "cn-hangzhou-c"
      }
    ]
  },
  "DBProxyPersistentConnectionStatus": "Disabled",
  "DBProxyServiceStatus": "Startup",
  "DbProxyEndpointItems": {
    "DbProxyEndpointItems": [
      {
        "DbProxyEndpointAliases": "proxy-test",
        "DbProxyEndpointName": "gos787jog2wk0ye1****",
        "DbProxyEndpointType": "RWSplit",
        "DbProxyReadWriteMode": "ReadWrite"
      }
    ]
  },
  "RequestId": "909A69EE-71C8-4417-A0B9-FF085407E1E3",
  "ResourceGroupId": "rg-acfmy*****"
}

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.-
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
400Order.NoRealNameAuthenticationYou have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
400RegionDissolvedEOMDear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400Price.CommoditySysCommodity system call exception.Commodity system call exception.
400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
400pay.noCreditCardAccount not bound to credit card.-
400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
400Api.NotSupportSpecified api is not supported.The current interface does not support.
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400KmsApiErrorUser secret key invalid.The user key is invalid.
400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
400RequiredParam.NotFoundRequired input param is not found.-
400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400InvalideStatus.FormatThe instance status does not support this operation.-
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
400Pay.NoCreditCardNo credit cards.No credit cards.
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
400ProductInstanceReleasedThe instance has been released. Please check before placing the order.The instance has been released, please verify and place an order.
400RegionEndTimeDissolvedIndiaThe region is no longer supported.The region is no longer supported.
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.
403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
403InvalidVswitchIdSpecified conn vswitch id is not valid.-
403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
403NotInFlowControllerSorry,no permission.Sorry,no permission.
403InvalidKmsKeyKms key is disabled.-
403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
404HostInfo.NotFoundThe specified host info is not found.-
500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-10-15The Error code has changed. The response structure of the API has changedView Change Details
2023-12-19The Error code has changedView Change Details
2023-12-12The Error code has changed. The response structure of the API has changedView Change Details
2023-11-23The Error code has changed. The response structure of the API has changedView Change Details
2023-03-14The Error code has changed. The response structure of the API has changedView Change Details
2022-06-08The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details