All Products
Search
Document Center

ApsaraDB RDS:DescribeDBInstancesAsCsv

Last Updated:May 29, 2023

You can call the DescribeDBInstancesAsCsv operation to query information about an instance.

Operation Description

This operation is no longer available. You can call the DescribeDBInstanceAttribute operation to query information about an instance.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
rds:DescribeDBInstancesAsCsvREAD
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/*
  • RDS
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou
DBInstanceIdstringNo

The ID of the instance. You can call the DescribeDBInstances operation to query the ID of the instance.

rm-uf6wjk5xxxxxxxxxx
ResourceGroupIdstringNo

The ID of the resource group to which the instance belongs.

rg-acfmy*****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request.

1AD222E9-E606-4A42-BF6D-8A444291****
Itemsobject []

An array that consists of the fields in DBInstanceAttribute.

VpcIdstring

The ID of the VPC.

vpc-uf6f7l4fg90xxxxxxxxxx
CreationTimestring

The time when the audio or video file was created.

2011-05-30T12:11:04Z
TempDBInstanceIdstring

The ID of the temporary instance that is attached to the instance.

rm-uf64zsuxxxxxxxxxx
SupportUpgradeAccountTypestring

None.

No
IncrementSourceDBInstanceIdstring

The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance or read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.

rm-uf6wjk5xxxxxxxxxx
DBInstanceMemorylong

The memory size of the instance. Unit: MB.

4096
MaintainTimestring

The maintenance window of the instance. The time is displayed in UTC. Take note that the maintenance window that is displayed in the ApsaraDB RDS console is equal to the value of this parameter plus 8 hours.

00:00Z-02:00Z
PayTypestring

The billing method of the instance.

Postpaid
Tagsstring

The tag.

0
AvailabilityValuestring

The service availability of the instance in percentage.

100
ReadDelayTimestring

The latency of data replication from the primary instance to the read-only instance. This parameter is valid for read-only instances.

0
ConnectionModestring

The connection mode of the instance. Valid values:

  • Performance: standard mode
  • Safety: enhanced mode
Performance
Portstring

The port that is used to connect to the instance over an internal network.

3306
AccountTypestring

The type of the account.

super
LockModestring

The lock mode of the instance.

Unlock
EngineVersionstring

The engine version of the instance.

8.0
MaxIOPSinteger

The maximum number of I/O requests that is processed by the instance per second.

150
ConnectionStringstring

The internal endpoint of the instance.

rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com
InstanceNetworkTypestring

The type of the network.

VPC
SecurityIPListstring

The IP address whitelist of the instance.

42.xx.xx.xx
MasterInstanceIdstring

The ID of the primary instance.

rm-uf6wjk5xxxxxxxxxx
DBInstanceClassTypestring

The instance family.

s
DBInstanceDescriptionstring

The description of the instance.

0
DBInstanceCPUstring

The number of cores that are configured for the instance.

2
ExpireTimestring

The expiration time.

2019-03-27T16:00:00Z
DBInstanceNetTypestring

The network type of the instance. Valid values:

  • Internet
  • Intranet
Internet
DBInstanceTypestring

The type of the instance. Valid values:

  • Primary: primary instance
  • Readonly: read-only instance
  • Guard: disaster recovery instance
  • Temp: temporary instance
Primary
AccountMaxQuantityinteger

The maximum number of accounts.

500
LockReasonstring

The reason why the instance was locked.

instance_expired
DBInstanceStatusstring

The status of the instance.

Running
DBMaxQuantityinteger

The maximum number of databases that can be created on the instance.

200
GuardDBInstanceIdstring

The ID of the disaster recovery instance that is attached to the instance.

rm-uf64zsuxxxxxxxxxx
RegionIdstring

The ID of the region in which the instance resides.

cn-hangzhou
DBInstanceStorageinteger

The storage capacity of the instance. Unit: GB.

10
VSwitchIdstring

The ID of the vSwitch.

vsw-uf6adz52c2pxxxxxxxxxx
ZoneIdstring

The ID of the zone in which the instance resides.

cn-hangzhou-h
Categorystring

The category of the instance.

0
MaxConnectionsinteger

The maximum number of concurrent connections that are allowed by the instance.

60
DBInstanceIdstring

The ID of the instance.

rm-uf6wjk5xxxxxxxxxx
DBInstanceClassstring

The instance type of the instance.

rds.mys2.small
Enginestring

The type of the database engine.

MySQL

Examples

Sample success responses

JSONformat

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A444291****\t",
  "Items": {
    "DBInstanceAttribute": [
      {
        "VpcId": "vpc-uf6f7l4fg90xxxxxxxxxx\t ",
        "CreationTime": "2011-05-30T12:11:04Z",
        "TempDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
        "SupportUpgradeAccountType": "No",
        "IncrementSourceDBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "DBInstanceMemory": 4096,
        "MaintainTime": "00:00Z-02:00Z",
        "PayType": "Postpaid",
        "Tags": "0",
        "AvailabilityValue": "100",
        "ReadDelayTime": "0",
        "ConnectionMode": "Performance",
        "Port": "3306",
        "AccountType": "super",
        "LockMode": "Unlock",
        "EngineVersion": "8.0",
        "MaxIOPS": 150,
        "ConnectionString": "rm-uf6wjk5xxxxxxxxxx.mysql.rds.aliyuncs.com",
        "InstanceNetworkType": "VPC",
        "SecurityIPList": "42.xx.xx.xx",
        "MasterInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "DBInstanceClassType": "s",
        "DBInstanceDescription": "0",
        "DBInstanceCPU": "2",
        "ExpireTime": "2019-03-27T16:00:00Z",
        "DBInstanceNetType": "Internet",
        "DBInstanceType": "Primary",
        "AccountMaxQuantity": 500,
        "LockReason": "instance_expired",
        "DBInstanceStatus": "Running",
        "DBMaxQuantity": 200,
        "GuardDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
        "RegionId": "cn-hangzhou",
        "DBInstanceStorage": 10,
        "VSwitchId": "vsw-uf6adz52c2pxxxxxxxxxx\t",
        "ZoneId": "cn-hangzhou-h",
        "Category": "0",
        "MaxConnections": 60,
        "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "DBInstanceClass": "rds.mys2.small",
        "Engine": "MySQL"
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400InstanceNames.Malformedinstance number of Instance Names should be less than 3000The operation failed. The instance name must be less than 3,000 characters in length.
400400Export all instances more than 6 times in an hour, please try 1 hour later.-
403Export.InProcessThere is already a task running, please try laterA task is running. Please try again later.

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