DescribeDrdsInstance - PolarDB - Alibaba Cloud Documentation Center

Queries the details of 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:DescribeDrdsInstance

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
DrdsInstanceId	string	Yes	The instance ID.	drdshbga1138****
RegionId	string	No	The region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the request is successful.	true
RequestId	string	The request ID.	B4F76641-BA45-4320-BE7C-9C62CFDAC9B2
Data	object	The instance details.
Type	string	The instance type. Valid values: PRIVATE (dedicated instance) and PUBLIC (shared instance).	PRIVATE
Status	string	The instance status.	RUN
CreateTime	integer	The timestamp when the instance was created.	1568620311000
VersionAction	string	The available action for the instance version.	Upgradeable
StorageType	string	The storage type of the instance.	RDS
NetworkType	string	The network type. Valid values: CLASSIC (classic network) and VPC (VPC network).	CLASSIC
Label	string	The instance label. Valid values: NORMAL: standard instance. HA: high-availability instance. VPC: VPC instance.	NORMAL
MysqlVersion	integer	The MySQL version supported by the instance.	5
InstanceSpec	string	The instance specification.	drds.sn2.4c16g.8C32G
VpcCloudInstanceId	string	The instance ID in the VPC cluster.	drdssen12****
Description	string	The instance description.	drds_test
Version	integer	The instance version. The value is empty.	0
ExpireDate	integer	The timestamp when the instance expires.	4724323200000
MasterInstanceId	string	The primary instance ID. Note This parameter is returned only when the instance is a read-only instance.	drdssen1243as
CommodityCode	string	The commodity code.	drdsPost
MachineType	string	The machine type of the instance. The value is fixed as ecs.	ecs
InstanceSeries	string	The instance specification series.	drds.sn2.4c16g
ProductVersion	string	The product version.	5.3.*
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The resource group ID. The value can be empty.	NULL
DrdsInstanceId	string	The instance ID.	drdssen1243as
ZoneId	string	The zone ID.	cn-hangzhou-e
InstRole	string	The instance role. Valid values: MASTER: primary instance. SLAVE: analytical read-only instance. SLAVE_FLOW: concurrent read-only instance.	MASTER
OrderInstanceId	string	The ID of the purchased instance.	drdssen12****
Vips	object
Vip	array<object>	The list of returned virtual IP addresses (VIPs).
	object
Type	string	The type of the VIP. Valid values: intranet and internet.	intranet
VpcId	string	The ID of the VPC.	vpc-bp**********
VswitchId	string	The ID of the vSwitch.	vsw-bp***********
Dns	string	The domain name that is mapped to the VIP.	drdssen1243as.drds.aliyuncs.com
Port	string	The ports that are opened on the VIP.	3306
ExpireDays	integer	The number of remaining days before the VIP expires.	0
RemoveWeight	boolean
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array	The details about each read-only instance that is associated with the instance.
	string		drdssen12****

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "B4F76641-BA45-4320-BE7C-9C62CFDAC9B2",
  "Data": {
    "Type": "PRIVATE",
    "Status": "RUN",
    "CreateTime": 1568620311000,
    "VersionAction": "Upgradeable",
    "StorageType": "RDS",
    "NetworkType": "CLASSIC",
    "Label": "NORMAL",
    "MysqlVersion": 5,
    "InstanceSpec": "drds.sn2.4c16g.8C32G",
    "VpcCloudInstanceId": "drdssen12****",
    "Description": "drds_test",
    "Version": 0,
    "ExpireDate": 4724323200000,
    "MasterInstanceId": "drdssen1243as",
    "CommodityCode": "drdsPost",
    "MachineType": "ecs",
    "InstanceSeries": "drds.sn2.4c16g",
    "ProductVersion": "5.3.*",
    "RegionId": "cn-hangzhou",
    "ResourceGroupId": "NULL",
    "DrdsInstanceId": "drdssen1243as",
    "ZoneId": "cn-hangzhou-e",
    "InstRole": "MASTER",
    "OrderInstanceId": "drdssen12****",
    "Vips": {
      "Vip": [
        {
          "Type": "intranet",
          "VpcId": "vpc-bp**********",
          "VswitchId": "vsw-bp***********",
          "Dns": "drdssen1243as.drds.aliyuncs.com",
          "Port": "3306",
          "ExpireDays": 0,
          "RemoveWeight": false
        }
      ]
    },
    "ReadOnlyDBInstanceIds": {
      "ReadOnlyDBInstanceId": [
        "drdssen12****"
      ]
    }
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ActionUnauthorized	The specified action is not available for you
400	InternalError	The request processing has failed due to some unknown error.
404	InvalidDRDSInstanceId.NotFound	The DrdsInstanceId provided does not exist in our records.
404	DrdsInstance.NotExists	The DRDS instance does not exist.	The DRDS instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.