DescribeDrdsInstances - PolarDB - Alibaba Cloud Documentation Center

Queries a list of DRDS instances.

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:DescribeDrdsInstances

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Type	string	No	The instance type. Valid values: Shared instance: 0 Dedicated instance: 1	1
Description	string	No	The description of the instance.	drds_test
Expired	boolean	No	Specifies whether the instance has expired.	false
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	20
ResourceGroupId	string	No	The resource group ID. This parameter can be left empty.	NULL
RegionId	string	Yes	The region ID.	cn-hangzhou
Mix	boolean	No	Specifies whether hybrid queries are supported.	FALSE
ProductVersion	string	No	The product version number. Valid values: V1 and V2.	V1
Tag	array<object>	No	The list of tags.
	object	No
Key	string	No	The tag key.	acs:newretail:domain
Value	string	No	The tag value.	NEW_RETAIL

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	8734773E-7B21-4A22-9106-CBD245F8****
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	20
Total	integer	The total number of instances.	1
Instances	object
Instance	array<object>	The list of instances.
	array<object>
VpcId	string	The virtual private network ID.	vpc-bp**********
Status	string	The instance status.	RUN
Type	string	The instance type. Valid values: PUBLIC: shared instance PRIVATE: dedicated instance	PRIVATE
CommodityCode	string	The commodity code.	drdsPost
MachineType	string	The machine type of the instance. Only ECS is supported.	ecs
CreateTime	integer	The creation timestamp.	1568620311000
VersionAction	string	The available operations for the instance version.	Upgradable
InstanceSeries	string	The instance series.	drds.sn2.4c16g
NetworkType	string	The network type. Valid values: CLASSIC: classic network VPC: VPC	CLASSIC
Label	string	The instance label. Valid values: NORMAL: regular instance HA: high availability (HA) instance VPC: VPC-connected instance	NORMAL
ProductVersion	string	The product version number.	V1
InstanceSpec	string	The instance specifications.	drds.sn2.4c16g.8C32G
RegionId	string	The region ID.	cn-hangzhou-e
VpcCloudInstanceId	string	The instance ID in the VPC cluster.	drdssen12****
Description	string	The instance description.	drds_test
Version	integer	The instance version.	0
ResourceGroupId	string	The resource group ID.	rg-aek2ljh3ye4****
ZoneId	string	The zone.	vsw-bpxxxxxxxxxxxxx96
DrdsInstanceId	string	The instance ID.	drdssen12****
ExpireDate	integer	The expiration timestamp.	4724323200000
MasterInstanceId	string	The primary instance ID.	drdssen12****
OrderInstanceId	string	The purchased instance ID.	drdssen12****
InstRole	string	The instance role. Valid values: MASTER: primary instance SLAVE: analytical read-only instance SLAVE_FLOW: concurrent read-only instance	MASTER
Vips	object
Vip	array<object>	The list of VIPs.
	object
VpcId	string	The virtual private network ID.	vpc-bpxxxxxxxxxxxy
Type	string	The VIP type. Valid values: intranet: internal network internet: Internet	intranet
VswitchId	string	The vSwitch ID.	vsw-bpxxxxxxxxxxxxx96
Port	string	The open port for the VIP.	3306
IP	string	The IP address.	10.23.*.*
dns	string	The domain name bound to the VIP.	drdssen1243as.drds.aliyuncs.com
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array
	string	The list of read-only instance IDs.	drdssen12****
series	string	The instance series. Valid values: starter: starter edition enterprise: enterprise edition standard: standard edition	enterprise

Examples

Success response

JSON format

{
  "RequestId": "8734773E-7B21-4A22-9106-CBD245F8****",
  "PageNumber": 1,
  "PageSize": 20,
  "Total": 1,
  "Instances": {
    "Instance": [
      {
        "VpcId": "vpc-bp**********",
        "Status": "RUN",
        "Type": "PRIVATE",
        "CommodityCode": "drdsPost",
        "MachineType": "ecs",
        "CreateTime": 1568620311000,
        "VersionAction": "Upgradable",
        "InstanceSeries": "drds.sn2.4c16g",
        "NetworkType": "CLASSIC",
        "Label": "NORMAL",
        "ProductVersion": "V1",
        "InstanceSpec": "drds.sn2.4c16g.8C32G",
        "RegionId": "cn-hangzhou-e",
        "VpcCloudInstanceId": "drdssen12****",
        "Description": "drds_test",
        "Version": 0,
        "ResourceGroupId": "rg-aek2ljh3ye4****",
        "ZoneId": "vsw-bpxxxxxxxxxxxxx96",
        "DrdsInstanceId": "drdssen12****",
        "ExpireDate": 4724323200000,
        "MasterInstanceId": "drdssen12****",
        "OrderInstanceId": "drdssen12****",
        "InstRole": "MASTER",
        "Vips": {
          "Vip": [
            {
              "VpcId": "vpc-bpxxxxxxxxxxxy",
              "Type": "intranet",
              "VswitchId": "vsw-bpxxxxxxxxxxxxx96",
              "Port": "3306",
              "IP": "10.23.***.***",
              "dns": "drdssen1243as.drds.aliyuncs.com"
            }
          ]
        },
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            "drdssen12****"
          ]
        },
        "series": "enterprise"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message
400	ActionUnauthorized	The specified action is not available for you
400	ServiceUnable	The service is not available now, please try again later
400	InvalidRegionId.NotFound	The RegionId provided does not exist in our records.
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.