DescribeDBInstancesAsCsv - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri daftar instans. Operasi ini tidak digunakan lagi: operasi ini masih dapat dipanggil tetapi tidak lagi dipelihara.

Catatan

API ini telah ditinggalkan. Kami merekomendasikan migrasi ke Rds(2014-08-15) - DescribeDBInstances guna memperoleh fungsionalitas yang lebih baik dan dukungan berkelanjutan. Meskipun API yang telah ditinggalkan ini masih dapat diakses sementara, tidak akan ada pembaruan atau perbaikan bug lebih lanjut.

Deskripsi operasi

Operasi ini tidak digunakan lagi: operasi ini masih dapat dipanggil, tetapi Alibaba Cloud tidak lagi memeliharanya. Gunakan operasi DescribeDBInstances sebagai gantinya.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

rds:DescribeDBInstancesAsCsv

get

DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

rds:ResourceTag
rds:ResourceTag

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	Yes	ID wilayah. Anda dapat memanggil DescribeRegions untuk mengkueri wilayah yang tersedia.	cn-hangzhou
DBInstanceId	string	No	ID instans. Anda dapat memanggil DescribeDBInstances untuk mengkueri ID instans.	rm-uf6wjk5****
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmy****
CachedAsync	boolean	No	Parameter yang tidak digunakan lagi. Anda tidak perlu mengonfigurasi parameter ini.	API
ExportKey	string	No	Parameter yang tidak digunakan lagi. Anda tidak perlu mengonfigurasi parameter ini.	API

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
Items	object
DBInstanceAttribute	array<object>	Set data yang terdiri dari entri DBInstanceAttribute.
	array<object>	Detail set data.
AccountMaxQuantity	integer	The maximum number of accounts.	500
AccountType	string	The type of the account.	super
AvailabilityValue	string	The service availability of the instance in percentage.	100
Category	string	The category of the instance.	0
ConnectionMode	string	The connection mode of the instance. Valid values: Performance: standard mode. Safety: enhanced mode	Performance
ConnectionString	string	The internal endpoint.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
CreationTime	string	The creation time.	2011-05-30T12:11:04Z
DBInstanceCPU	string	The number of CPU cores.	2
DBInstanceClass	string	The instance type of the instance.	rds.mys2.small
DBInstanceClassType	string	The instance family.	s
DBInstanceDescription	string	The instance description.	0
DBInstanceId	string	The instance ID.	rm-uf6wjk5****
DBInstanceMemory	integer	The memory capacity of the instance. Unit: MB.	4096
DBInstanceNetType	string	The network type of the instance. Valid values: Internet Intranet	Internet
DBInstanceStatus	string	The instance status.	Running
DBInstanceStorage	integer	The storage capacity of the instance. Unit: GB.	10
DBInstanceType	string	The instance type. Valid values: Primary: primary instance ReadOnly: read-only instance Guard: disaster recovery instance Temp: temporary instance	Primary
DBMaxQuantity	integer	The maximum number of databases that can be created on the instance.	200
Engine	string	The database engine of the instance.	MySQL
EngineVersion	string	The engine version.	8.0
ExpireTime	string	The expiration time.	2019-03-27T16:00:00Z
ExportKey	string	A deprecated parameter. You do not need to specify this parameter.	API
GuardDBInstanceId	string	The ID of the disaster recovery instance that is attached to the primary instance.	rm-uf64zsu****
IncrementSourceDBInstanceId	string	The ID of the instance from which incremental data comes. The incremental data of a disaster recovery instance comes from its primary instance. The incremental data of a read-only instance comes from its primary instance. If this parameter is not returned, the instance is a primary instance.	rm-uf6wjk5****
InstanceNetworkType	string	The network type.	VPC
LockMode	string	The lock mode of the instance.	Unlock
LockReason	string	The reason why the instance was locked.	instance_expired
MaintainTime	string	The maintenance window of the instance. The time follows the ISO 8601 standard and is displayed in UTC. In the ApsaraDB RDS console, the maintenance window is displayed in UTC+8.	00:00Z-02:00Z
MasterInstanceId	string	The primary instance ID.	rm-uf6wjk5****
MaxConnections	integer	The maximum number of concurrent connections.	60
MaxIOPS	integer	The maximum number of I/O requests per second.	150
PayType	string	The billing method of the instance.	Postpaid
Port	string	The port that is used to connect to the instance over an internal network.	3306
ReadDelayTime	string	The latency of data replication from the primary instance to the read-only instance. This parameter is valid for read-only instances.	0
RegionId	string	The region ID.	cn-hangzhou
SecurityIPList	string	The IP addresses in the whitelist.	42.XX.XX.XX
SlaveZones	object
slaveRegion	array	A deprecated parameter. You do not need to specify this parameter.
	string	A deprecated parameter. You do not need to specify this parameter.	API
SupportUpgradeAccountType	string	N/A.	No
Tags	string	The tags.	0
TempDBInstanceId	string	The ID of the temporary instance that is attached to the primary instance.	rm-uf64zs****
VSwitchId	string	The vSwitch ID.	vsw-uf6adz52c2p****
VpcId	string	The virtual private cloud (VPC) ID.	vpc-uf6f7l4fg90****
ZoneId	string	The zone ID.	cn-hangzhou-j
DBInstanceStorageType	string
RequestId	string	ID permintaan.	1AD222E9-E606-4A42-BF6D-8A444291****

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

HTTP status code	Error code	Error message
400	InstanceNames.Malformed	instance number of Instance Names should be less than 3000
400	400	Export all instances more than 6 times in an hour, please try 1 hour later.
400	ExportLimitExceeded	Export all instances more than 6 times in an hour, please try 1 hour later.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	Export.InProcess	There is already a task running, please try later
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.