DescribeDBInstances - ApsaraDB RDS - Alibaba Cloud Documentation Center

Mengkueri daftar instans RDS.

Deskripsi operasi

Mesin yang didukung

RDS MySQL
RDS PostgreSQL
RDS SQL Server
RDS MariaDB.

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

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
ClientToken	string	No	Token klien yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan klien untuk menghasilkan nilai ini, tetapi harus memastikan nilainya unik di antara permintaan yang berbeda. Nilai dapat berisi hingga 64 karakter ASCII dan tidak boleh berisi karakter non-ASCII.	ETnLKlblzczshOTUbOCz****
proxyId	string	No	Parameter yang tidak digunakan lagi. Anda tidak perlu menentukan parameter ini.	API
Engine	string	No	Tipe mesin database. Nilai valid: MySQL SQLServer PostgreSQL MariaDB Secara default, semua tipe mesin database dikembalikan.	MySQL
ZoneId	string	No	ID zona.	cn-hangzhou-a
ResourceGroupId	string	No	ID kelompok sumber daya.	rg-acfmy****
DBInstanceStatus	string	No	Status instans. Untuk informasi selengkapnya, lihat Status instans.	Running
Expired	string	No	Status kedaluwarsa instans. Nilai valid: True: kedaluwarsa False: belum kedaluwarsa.	True
SearchKey	string	No	Kata kunci yang digunakan untuk melakukan pencarian fuzzy berdasarkan ID instans atau deskripsi instans.	rm-uf6w
DBInstanceId	string	No	ID instans.	rm-uf6wjk5****
DBInstanceType	string	No	Tipe instans. Nilai valid: Primary: instans utama Readonly: instans baca-saja Guard: instans pemulihan bencana Temp: instans sementara Secara default, semua tipe instans dikembalikan.	Primary
RegionId	string	Yes	ID wilayah. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.	cn-hangzhou
PageSize	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 100. Nilai default: 30.	30
PageNumber	integer	No	Nomor halaman. Nilai valid: bilangan bulat positif bukan nol yang tidak melebihi nilai maksimum tipe data Integer. Nilai default: 1.	1
InstanceNetworkType	string	No	Jenis jaringan instans. Nilai valid: VPC: instans di virtual private cloud (VPC) Classic: instans di jaringan klasik Secara default, instans di semua jenis jaringan dikembalikan.	Classic
VpcId	string	No	ID VPC.	vpc-uf6f7l4fg90****
VSwitchId	string	No	ID vSwitch.	vsw-uf6adz52c2p****
DBInstanceClass	string	No	Tipe instans. Untuk informasi selengkapnya, lihat Tipe instans ApsaraDB RDS utama.	rds.mys2.small
EngineVersion	string	No	Versi mesin database.	8.0
PayType	string	No	Metode penagihan. Nilai valid: Postpaid: bayar sesuai pemakaian Prepaid: langganan.	Postpaid
ConnectionMode	string	No	Mode koneksi instans. Nilai valid: Standard: mode standar Safe: mode Proksi database Secara default, instans di semua mode koneksi dikembalikan.	Standard
Tags	string	No	Tag yang ditambahkan ke instans, termasuk TagKey dan TagValue. Hingga 5 kelompok tag dapat diteruskan sekaligus. Format: {"key1":"value1","key2":"value2"...}. Informasi instans dikembalikan jika salah satu kelompok tag yang diteruskan cocok.	{"key1":"value1"}
DedicatedHostGroupId	string	No	ID klaster khusus.	dhg-7a9****
DedicatedHostId	string	No	ID host di klaster khusus.	i-bp****
InstanceLevel	integer	No	Apakah akan mengembalikan informasi seri instans (Category). Nilai valid: 0: tidak mengembalikan 1: mengembalikan.	0
QueryAutoRenewal	boolean	No	Parameter yang dicadangkan. Anda tidak perlu menentukan parameter ini.	test
ConnectionString	string	No	String koneksi instans. Instans yang sesuai dikueri berdasarkan string koneksi.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
NextToken	string	No	Token paginasi. Atur nilai ke nilai parameter NextToken yang dikembalikan pada pemanggilan sebelumnya ke operasi DescribeDBInstances. Jika hasil ditampilkan dalam beberapa halaman, tentukan nilai ini saat Anda memanggil operasi ini lagi untuk menampilkan halaman konten berikutnya.	o7PORW5o2TJg****
MaxResults	integer	No	Jumlah entri per halaman. Nilai valid: 1 hingga 100. Nilai default: 30. Catatan Jika parameter ini ditentukan, parameter PageSize dan PageNumber tidak berlaku.	30
Filter	string	No	String JSON yang berisi parameter filter instans dan nilainya.	{"babelfishEnabled":"true"}
Category	string	No	Seri instans. Nilai valid: Basic: Edisi Dasar HighAvailability: Edisi Ketersediaan Tinggi cluster: Edisi Kluster serverless_basic: arsitektur tanpa server.	cluster

API ini mendukung dua metode berikut untuk melihat data yang dikembalikan:

Metode 1: Tentukan parameter MaxResults untuk mengatur jumlah catatan per halaman, dan tentukan parameter NextToken untuk mengatur token paginasi guna menampilkan halaman konten berikutnya. Nilai NextToken adalah nilai parameter NextToken yang dikembalikan dari pemanggilan sebelumnya ke operasi DescribeDBInstances.

Catatan

Saat Anda memanggil operasi ini untuk kueri paginasi pertama kali, Anda hanya perlu menentukan parameter MaxResults. Operasi ini mengembalikan data halaman pertama dan nilai parameter NextToken.

Metode 2: Tentukan parameter PageSize untuk mengatur jumlah catatan per halaman, dan tentukan parameter PageNumber untuk melakukan paginasi.

Catatan

Anda hanya dapat memilih salah satu dari dua metode tersebut. Ketika jumlah catatan yang dikembalikan besar, kami menyarankan Anda menggunakan Metode 1 untuk mendapatkan kecepatan kueri yang lebih cepat.

Elemen respons

Element	Type	Description	Example
	object	Detail parameter tanggapan.
Items	object
DBInstance	array<object>	Daftar instans.
	array<object>	Detail instans.
BpeEnabled	string	A deprecated parameter.	0
BurstingEnabled	boolean	Indicates whether the I/O burst feature is enabled. Valid values: true false	false
Category	string	The RDS edition of the instance. Valid values: Basic: RDS Basic Edition HighAvailability: RDS High-availability Edition Finance: RDS Enterprise Edition Catatan This parameter is returned only when the InstanceLevel parameter is set to 1.	Basic
IsAnalyticReadOnlyIns	boolean		false
ConnectionMode	string	The connection mode of the instance. Valid values: Standard: standard mode Safe: database proxy mode	Standard
ConnectionString	string	The endpoint of the instance.	rm-uf6wjk5****.mysql.rds.aliyuncs.com
CreateTime	string	The creation time of the instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-05T11:26:02Z
DBInstanceCPU	string	The number of CPU instances. Returns only when the InstanceLevel parameter is 1.	2
DBInstanceClass	string	The instance type of the instance. For information, see Primary ApsaraDB RDS instance types.	rds.mys2.small
DBInstanceDescription	string	The instance description.	testdb
DBInstanceId	string	The instance ID.	rm-uf6wjk5****
DBInstanceMemory	integer	The memory size of the node. Unit: MB. Returns only when the InstanceLevel parameter is 1.	4096
DBInstanceNetType	string	The type of the network connection to the instance. Valid values: Internet Intranet	Internet
DBInstanceStatus	string	The instance status. For more information, see Instance statuses.	Running
DBInstanceStorageType	string	The storage type of the instance.	ModuleList.4.ModuleCode
DBInstanceType	string	The type of the instance. Valid values: Primary: primary instance Readonly: read-only instance Guard: disaster recovery instance Temp: temporary instance	Primary
DedicatedHostGroupId	string	The ID of the dedicated cluster.	dhg-7a9****
DedicatedHostGroupName	string	The name of the dedicated cluster.	testhostgroup
DedicatedHostIdForLog	string	The ID of the host on which the logger instance resides.	dh-bp****
DedicatedHostIdForMaster	string	The ID of the host on which the primary instance resides.	dh-bp****
DedicatedHostIdForSlave	string	The ID of the host on which the secondary instance resides.	dh-bp****
DedicatedHostNameForLog	string	The name of the host on which the logger instance resides.	testlog
DedicatedHostNameForMaster	string	The name of the host on which the primary instance resides.	testmaster
DedicatedHostNameForSlave	string	The name of the host on which the secondary instance resides.	testslave
DedicatedHostZoneIdForLog	string	The zone ID of the host on which the logger instance resides.	cn-hangzhou-b
DedicatedHostZoneIdForMaster	string	The zone ID of the host on which the primary instance resides.	cn-hangzhou-c
DedicatedHostZoneIdForSlave	string	The zone ID of the host on which the secondary instance resides.	cn-hangzhou-d
DeletionProtection	boolean	Indicates whether the release protection feature is enabled for the instance. Valid values: true false	false
DestroyTime	string	The time when the instance was destroyed. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.	2018-11-05T11:26:02Z
Engine	string	The database engine of the instance.	MySQL
EngineVersion	string	The database engine version.	5.7
ExpireTime	string	The expiration time of the instance. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC. Catatan Pay-as-you-go instances never expire.	2019-02-27T16:00:00Z
GeneralGroupName	string	The name of the dedicated cluster to which the instance belongs. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.	TestGroup
GuardDBInstanceId	string	The ID of the disaster recovery instance. This parameter is returned only when the instance is a primary instance and has a disaster recovery instance attached.	rm-uf64zsu****
InstanceNetworkType	string	The network type of the instance. Valid values: Classic VPC	Classic
IoAccelerationEnabled	string	Indicates whether the I/O acceleration feature is enabled. Valid values: 1: enabled 0: disabled	0
LockMode	string	The lock mode of the instance. Valid values: Unlock: The instance is not locked. ManualLock: The instance is manually locked. LockByExpiration: The instance is automatically locked due to instance expiration. LockByRestoration: The instance is automatically locked before the instance is rolled back. LockByDiskQuota: The instance is automatically locked due to exhausted storage capacity. Released: The instance is released. After an instance is released, the instance cannot be unlocked. You can only restore the backup data of the instance to a new instance. This process requires a long period of time.	Unlock
LockReason	string	The reason why the instance was locked.	instance_expired
MasterInstanceId	string	The ID of the primary instance. If this parameter is null, the instance is a primary instance.	rm-uf6wjk5****
MutriORsignle	boolean	Indicates whether the multi-zone deployment method is used for the instance. Valid values: true false Catatan If the multi-zone deployment method is used for the instance, the zone ID of the instance contains MAZ. Example: `cn-hangzhou-MAZ10(h,i)`.	true
PayType	string	The billing method of the instance. Valid values: Postpaid: pay-as-you-go Prepaid: subscription	Postpaid
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array<object>	The IDs of the read-only instances. This parameter is returned only when the instance is a primary instance and has the read-only instances attached.
	object
DBInstanceId	string	The read-only instance ID.	rr-uf6wjk5****
RegionId	string	The region ID.	cn-hangzhou
ResourceGroupId	string	The resource group ID.	rg-acfmy****
SwitchWeight	integer	Indicates whether the instance supports weight-based switchovers for high availability. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values: 100: The instance supports weight-based switchovers for high availability. 0: The instance does not support weight-based switchovers for high availability.	100
TempDBInstanceId	string	The ID of the temporary instance. This parameter is returned only when the instance is a primary instance and has a temporary instance attached.	rm-uf64zsu****
Tips	string	The information about the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition.	normal
TipsLevel	integer	The severity of the exception that is detected on the instance. This parameter is returned only when the instance is created in an ApsaraDB MyBase cluster that runs MySQL on Standard Edition. Valid values: 1: The instance is normal. 2: The specifications of the read-only instances do not match the specifications of the primary instance, and instance performance may be affected. You must adjust the specifications of these instances based on your business requirements.	1
VSwitchId	string	The vSwitch ID.	vsw-uf6adz52c2p****
VpcCloudInstanceId	string	The ID of the instance. This parameter is returned only when the instance resides in a VPC.	rm-uf6wjk5****
VpcId	string	The virtual private cloud (VPC) ID.	vpc-uf6f7l4fg90****
VpcName	string	The VPC name.	test-huadong
ZoneId	string	The zone ID.	cn-hangzhou-a
BlueGreenDeploymentName	string		test
BlueInstanceName	string		test
GreenInstanceName	string		test
AutoRenewal	boolean		false
ColdDataEnabled	boolean	A reserved parameter.	false
IsAnalyticIns	string
NextToken	string	Token paginasi. Jika hasil ditampilkan dalam beberapa halaman, tentukan nilai ini untuk parameter NextToken saat Anda memanggil operasi ini lagi untuk menampilkan halaman konten berikutnya.	o7PORW5o2TJg****
PageNumber	integer	Nomor halaman. Catatan Jika Anda menentukan parameter MaxResults atau NextToken, nilai kembali ini selalu 1. Anda dapat mengabaikannya.	1
PageRecordCount	integer	Jumlah instans pada halaman saat ini.	10
RequestId	string	ID permintaan.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
TotalRecordCount	integer	Jumlah total catatan. Catatan Jika Anda menentukan parameter MaxResults atau NextToken, nilai kembali ini hanya menampilkan jumlah catatan pada halaman saat ini. Anda dapat mengabaikannya.	100

Contoh

Respons sukses

JSONformat

{
  "Items": {
    "DBInstance": [
      {
        "BpeEnabled": "0",
        "BurstingEnabled": false,
        "Category": "Basic",
        "IsAnalyticReadOnlyIns": false,
        "ConnectionMode": "Standard",
        "ConnectionString": "rm-uf6wjk5****.mysql.rds.aliyuncs.com",
        "CreateTime": "2018-11-05T11:26:02Z",
        "DBInstanceCPU": "2",
        "DBInstanceClass": "rds.mys2.small",
        "DBInstanceDescription": "testdb",
        "DBInstanceId": "rm-uf6wjk5****",
        "DBInstanceMemory": 4096,
        "DBInstanceNetType": "Internet",
        "DBInstanceStatus": "Running",
        "DBInstanceStorageType": "ModuleList.4.ModuleCode",
        "DBInstanceType": "Primary",
        "DedicatedHostGroupId": "dhg-7a9****",
        "DedicatedHostGroupName": "testhostgroup",
        "DedicatedHostIdForLog": "dh-bp****",
        "DedicatedHostIdForMaster": "dh-bp****",
        "DedicatedHostIdForSlave": "dh-bp****",
        "DedicatedHostNameForLog": "testlog",
        "DedicatedHostNameForMaster": "testmaster",
        "DedicatedHostNameForSlave": "testslave",
        "DedicatedHostZoneIdForLog": "cn-hangzhou-b",
        "DedicatedHostZoneIdForMaster": "cn-hangzhou-c",
        "DedicatedHostZoneIdForSlave": "cn-hangzhou-d",
        "DeletionProtection": false,
        "DestroyTime": "2018-11-05T11:26:02Z",
        "Engine": "MySQL",
        "EngineVersion": "5.7",
        "ExpireTime": "2019-02-27T16:00:00Z",
        "GeneralGroupName": "TestGroup",
        "GuardDBInstanceId": "rm-uf64zsu****",
        "InstanceNetworkType": "Classic",
        "IoAccelerationEnabled": "0",
        "LockMode": "Unlock",
        "LockReason": "instance_expired",
        "MasterInstanceId": "rm-uf6wjk5****",
        "MutriORsignle": true,
        "PayType": "Postpaid",
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rr-uf6wjk5****"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-acfmy****",
        "SwitchWeight": 100,
        "TempDBInstanceId": "rm-uf64zsu****",
        "Tips": "normal",
        "TipsLevel": 1,
        "VSwitchId": "vsw-uf6adz52c2p****",
        "VpcCloudInstanceId": "rm-uf6wjk5****",
        "VpcId": "vpc-uf6f7l4fg90****",
        "VpcName": "test-huadong",
        "ZoneId": "cn-hangzhou-a",
        "BlueGreenDeploymentName": "test",
        "BlueInstanceName": "test",
        "GreenInstanceName": "test",
        "AutoRenewal": false,
        "ColdDataEnabled": false,
        "IsAnalyticIns": ""
      }
    ]
  },
  "NextToken": "o7PORW5o2TJg****",
  "PageNumber": 1,
  "PageRecordCount": 10,
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "TotalRecordCount": 100
}

Kode kesalahan

HTTP status code	Error code	Error message
400	Invalid.NextToken	The parameter NextToken is invalid.
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter DBInstanceType is not valid.
400	InvalidParameter.OwnerAccount	The specified parameter OwnerAccount is not valid.
400	TimeoutRetryLater	Timeout, Please retry later.
400	InvalidExpired.Format	The instance expiration status parameter is incorrect.
400	Abs.InvalidAccount.NotFound	account is not found.
400	Abs.ImageNotFound	The specified Image is disabled or is deleted.
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	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	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.