DescribeDrdsDbInstance - PolarDB - Alibaba Cloud Documentation Center

Queries the details of an ApsaraDB RDS storage instance for a DRDS instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

drds:DescribeDrdsDbInstance

get

*instance

acs:drds:{#regionId}:{#accountId}:instance/{#instanceId}/db/{#DbName}

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance name.	drdshbga1138****
DbName	string	Yes	The database name.	drds_test
DbInstanceId	string	Yes	The instance ID of the custom ApsaraDB RDS instance.	rm-bp1t1mk5a5bdj****

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request was successful.	true
RequestId	string	The request ID.	4FE09970-CA69-4144-88CA-67FB4BTY56G3
DbInstance	object	The details of the custom ApsaraDB RDS instance.
ExpireTime	string	The expiration time of the instance. The value is a UNIX timestamp. Unit: seconds. Note This parameter is supported only for subscription instances.	12341434315
PayType	string	The billing method of the instance. Valid values: Prepaid: subscription. Postaid: pay-as-you-go.	Postpaid
DBInstanceStatus	string	The instance status.	1
NetworkType	string	The network type of the instance. Currently, only VPC is supported.	VPC
Port	integer	The port used to access the instance.	3306
EngineVersion	string	The database engine version of the instance. Currently, only version 5.7 is supported.	5.7
DmInstanceId	string	The resource ID.	dm-*************
ConnectUrl	string	The endpoint of the custom ApsaraDB RDS instance.	rm-***************.mysql.rds.aliyuncs.com
ReadWeight	integer	The read ratio of the instance.	70
RdsInstType	string	The instance type.	RDS
RemainDays	string	The number of remaining days before the instance expires.	0
DBInstanceId	string	The instance ID of the custom ApsaraDB RDS instance.	rm-***************
DbInstType	string	The instance type. Valid values: Primary: primary instance. ReadOnly: read-only instance.	Primary
Engine	string	The database engine. Currently, only MySQL is supported.	MySQL
ReadOnlyInstances	object
ReadOnlyInstance	array<object>	The list of read-only ApsaraDB RDS for MySQL instances.
	object
ExpireTime	string	The timestamp that indicates when the read-only instance expires.	1823487328173
PayType	string	The billing method of the read-only instance.	Postpaid
VersionAction	integer	This parameter is unavailable for read-only instances.	0
DBInstanceStatus	string	The state of the read-only instance.	1
NetworkType	string	The network type of the read-only instance.	VPC
Port	integer	The port used to connect to the read-only instance.	3306
EngineVersion	string	The engine version of the database that is run on the read-only instance.	5.7
DmInstanceId	string	The ID of the resource.	dm-*************
ConnectUrl	string	The URL used to connect to the read-only instance.	rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com
ReadWeight	integer	The read ratio of the read-only instance.	30
RdsInstType	string	The type of the ApsaraDB RDS for MySQL instance.	RDS
RemainDays	string	The number of remaining days before the read-only instance expires.	0
DBInstanceId	string	The ID of the read-only instance.	rm-bp1ub71ct9skc****
DbInstType	string	The role of the read-only instance.	RDS
Engine	string	The engine of the database that is run on the read-only instance.	MySQL

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "4FE09970-CA69-4144-88CA-67FB4BTY56G3",
  "DbInstance": {
    "ExpireTime": "12341434315",
    "PayType": "Postpaid",
    "DBInstanceStatus": "1",
    "NetworkType": "VPC",
    "Port": 3306,
    "EngineVersion": "5.7",
    "DmInstanceId": "dm-*************",
    "ConnectUrl": "rm-***************.mysql.rds.aliyuncs.com",
    "ReadWeight": 70,
    "RdsInstType": "RDS",
    "RemainDays": "0",
    "DBInstanceId": "rm-***************",
    "DbInstType": "Primary",
    "Engine": "MySQL",
    "ReadOnlyInstances": {
      "ReadOnlyInstance": [
        {
          "ExpireTime": "1823487328173",
          "PayType": "Postpaid",
          "VersionAction": 0,
          "DBInstanceStatus": "1",
          "NetworkType": "VPC",
          "Port": 3306,
          "EngineVersion": "5.7",
          "DmInstanceId": "dm-*************",
          "ConnectUrl": "rm-bp1ub71ct9skc3yxx.mysql.rds.aliyuncs.com",
          "ReadWeight": 30,
          "RdsInstType": "RDS",
          "RemainDays": "0",
          "DBInstanceId": "rm-bp1ub71ct9skc****",
          "DbInstType": "RDS",
          "Engine": "MySQL"
        }
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter.MasterDbInstanceRelease	The master db instance has been released
500	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.