DescribeDrdsInstances - PolarDB - Alibaba Cloud Documentation Center

Queries a list of DRDS instances by calling the DescribeDrdsInstances operation.

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: 0: shared instance 1: dedicated instance.	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 Edition version number. Valid values: V1 and V2.	V1
Tag	array<object>	No	The list of tag properties.
	object	No
Key	string	No	The key of the tag.	acs:newretail:domain
Value	string	No	The value of the tag.	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 ID of the VPC to which the instance belongs.	vpc-bp**********
Status	string	The status of the instance.	RUN
Type	string	The type of the instance. Valid values: PUBLIC: The returned instance is a shared instance. PRIVATE: The returned instance is a dedicated instance.	PRIVATE
CommodityCode	string	The commodity code of the service.	drdsPost
MachineType	string	The machine type of the instance. Valid value: ecs.	ecs
CreateTime	integer	The timestamp that indicates when the instance is created.	1568620311000
VersionAction	string	Indicates whether the version of the instance can be upgraded.	Upgradable
InstanceSeries	string	The instance series.	drds.sn2.4c16g
NetworkType	string	The network type of the instance. Valid values: CLASSIC VPC	CLASSIC
Label	string	The tag of the instance. Valid values: NORMAL: The instance is a standard instance. HA: The instance is a high-availability (HA) instance. VPC: The instance is a VPC-based instance.	NORMAL
ProductVersion	string	The version of the service.	V1
InstanceSpec	string	The specification of the instance.	drds.sn2.4c16g.8C32G
RegionId	string	The ID of the region.	cn-hangzhou-e
VpcCloudInstanceId	string	The ID of the instance that is deployed in the VPC.	drdssen12****
Description	string	The description of the instance.	drds_test
Version	integer	The version of the instance.	0
ResourceGroupId	string	The ID of the resource group to which the instance belongs.	rg-aek2ljh3ye4****
ZoneId	string	The ID of the zone in which the resource is located.	vsw-bpxxxxxxxxxxxxx96
DrdsInstanceId	string	The ID of the instance.	drdssen12****
ExpireDate	integer	The timestamp that indicates when the instance expires.	4724323200000
MasterInstanceId	string	The ID of the primary instance.	drdssen12****
OrderInstanceId	string	The ID of the purchased instance.	drdssen12****
InstRole	string	The role of the instance. Valid values: MASTER: The instance is a primary instance. SLAVE: The instance is a read-only instance to analyze complex queries. SLAVE_FLOW: The instance is a read-only instance for high-concurrency scenarios.	MASTER
Vips	object
Vip	array<object>	The list of returned virtual IP addresses (VIPs).
	object
VpcId	string	The ID of the VPC.	vpc-bpxxxxxxxxxxxy
Type	string	The type of the VIP. Valid values: intranet: a private IP address internet: a public IP address	intranet
VswitchId	string	The ID of the vSwitch.	vsw-bpxxxxxxxxxxxxx96
Port	string	The ports that are opened on the VIP.	3306
IP	string	The virtual IP address.	10.23.*.*
dns	string	The domain name that is mapped to the VIP.	drdssen1243as.drds.aliyuncs.com
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array	The IDs of read-only instances that are associated with the instance.
	string	The list of read-only instance IDs.	drdssen12****
series	string	The edition of the instance. 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.