Kueri instans - - Alibaba Cloud Documentation Center

Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri satu atau beberapa instans ApsaraDB RDS yang memenuhi kondisi tertentu.

Anda dapat menggunakan salah satu metode berikut untuk memeriksa respons:

MaxResultsNextTokenNextTokenDescribeDBInstancesNextTokenMetode 1: Gunakan parameter untuk menentukan jumlah entri per halaman, lalu gunakan parameter untuk menentukan token yang digunakan dalam menampilkan halaman berikutnya. Parameter diatur ke nilai yang dikembalikan dari pemanggilan terbaru operasi untuk parameter .
Catatan Saat pertama kali memanggil operasi DescribeDBInstances untuk melakukan kueri terpaginasi, Anda hanya perlu menentukan parameter MaxResults. Operasi tersebut akan mengembalikan data halaman pertama beserta nilai parameter NextToken.
Metode 2: Gunakan parameter PageSize untuk menentukan jumlah entri per halaman, lalu gunakan parameter PageNumber untuk menampilkan halaman berikutnya.

Catatan Anda hanya dapat menggunakan salah satu metode di atas. Jika jumlah entri yang dikembalikan besar, kami menyarankan menggunakan Metode 1 untuk meningkatkan kecepatan kueri.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kenyamanan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Wajib	Contoh	Deskripsi
Action	String	Ya	DescribeDBInstances	Operasi yang ingin Anda lakukan. Tetapkan nilai ke DescribeDBInstances.
ClientToken	String	Tidak	ETnLKlblzczshOTUbOCzxxxxxxx	Token client yang digunakan untuk memastikan idempotensi permintaan. Anda dapat menggunakan client untuk menghasilkan nilai tersebut, tetapi Anda harus memastikan nilainya unik di antara permintaan yang berbeda. Token hanya boleh berisi karakter ASCII dan panjangnya tidak boleh melebihi 64 karakter.
proxyId	String	Tidak	API	ID modus proxy yang digunakan pada instans-instans tersebut.
Engine	String	Tidak	MySQL	Database engine yang dijalankan oleh instans-instans tersebut. Nilai yang valid: MySQL SQLServer PostgreSQL MariaDB Secara default, operasi ini mengembalikan instans yang menjalankan salah satu database engine yang didukung.
ZoneId	String	Tidak	cn-hangzhou-a	ID zona tempat instans berada.
ResourceGroupId	String	Tidak	rg-acfmyxxxxx	ID kelompok sumber daya tempat instans tersebut berada.
DBInstanceStatus	String	Tidak	Running	Status instans. Untuk informasi selengkapnya, lihat Instance state table.
Expired	String	Tidak	True	Menentukan apakah instans telah kedaluwarsa. Nilai yang valid: True: menampilkan instans yang telah kedaluwarsa. False: menampilkan instans yang belum kedaluwarsa.
SearchKey	String	Tidak	rm-uf6w	Kata kunci yang terdapat dalam ID atau deskripsi instans.
DBInstanceId	String	Tidak	rm-uf6wjk5xxxxxxx	ID instans. Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID instans.
DBInstanceType	String	Tidak	Primary	Peran instans. Nilai yang valid: Primary: instans utama Readonly: instans hanya baca Guard: instans pemulihan bencana Temp: instans temporary Secara default, operasi ini mengembalikan instans yang mengasumsikan salah satu peran yang didukung.
RegionId	String	Ya	cn-hangzhou	ID wilayah tempat instans berada. Anda dapat memanggil operasi DescribeRegions untuk mengkueri daftar wilayah terbaru.
PageSize	Integer	Tidak	30	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 1 hingga 100. Nilai default: 30.
PageNumber	Integer	Tidak	1	Nomor halaman yang akan ditampilkan. Nilai yang valid: bilangan bulat positif bukan nol apa pun. Nilai default: 1.
InstanceNetworkType	String	Tidak	Classic	Jenis jaringan dari instans-instans tersebut. Nilai yang valid: VPC Classic Secara default, operasi ini mengembalikan instans yang berada di salah satu jenis jaringan yang didukung.
VpcId	String	Tidak	vpc-uf6f7l4fg90xxxxxxxxxx	ID virtual private cloud (VPC) tempat instans berada.
VSwitchId	String	Tidak	vsw-uf6adz52c2pxxxxxxxxxx	ID vSwitch.
DBInstanceClass	String	Tidak	rds.mys2.small	Tipe instans dari instans-instans tersebut. Untuk informasi selengkapnya, lihat Primary ApsaraDB RDS instance types.
EngineVersion	String	Tidak	5.7	Versi engine database yang dijalankan oleh instans-instans tersebut.
PayType	String	Tidak	Postpaid	Metode penagihan instans. Nilai yang valid: Postpaid: pay-as-you-go Prepaid: subscription
ConnectionMode	String	Tidak	Standard	Mode koneksi instans. Nilai yang valid: Standard: mode standar Safe: mode proksi database Secara default, operasi ini mengembalikan instans yang berjalan dalam salah satu mode koneksi yang didukung.
Tags	String	Tidak	{"key1":"value1"}	Tag yang ditambahkan ke instans. Setiap tag merupakan pasangan kunci-nilai yang terdiri dari dua bagian: TagKey dan TagValue. Anda dapat menentukan maksimal lima tag dalam format berikut untuk setiap permintaan: {"key1":"value1","key2":"value2"...}.
DedicatedHostGroupId	String	Tidak	dhg-7a9xxxxxxxx	ID klaster khusus tempat instans tersebut berada.
DedicatedHostId	String	Tidak	i-bpxxxxxxx	ID dari host tempat instans berada di dalam klaster khusus yang ditentukan.
InstanceLevel	Integer	Tidak	0	Menentukan apakah edisi RDS dari instans akan dikembalikan dengan menggunakan parameter Category. Nilai yang valid: 0: Anda ingin edisi RDS dari instans dikembalikan. 1: Anda tidak ingin edisi RDS dari instans dikembalikan.
ConnectionString	String	Tidak	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	Titik akhir instans. Anda hanya perlu menentukan parameter ini jika ingin melakukan kueri terhadap satu instans saja.
NextToken	String	Tidak	o7PORW5o2TJg**********	Token yang digunakan untuk menampilkan halaman berikutnya. Anda harus mengatur parameter ini ke nilai yang dikembalikan dari pemanggilan operasi DescribeDBInstances terbaru untuk parameter NextToken. Jika entri yang dikembalikan ditampilkan dalam multiple halaman, halaman berikutnya dapat ditampilkan saat Anda memanggil operasi ini kembali dengan menentukan parameter ini.
MaxResults	Integer	Tidak	30	Jumlah entri yang dikembalikan pada setiap halaman. Nilai yang valid: 1 hingga 100. Nilai default: 30. Catatan Jika Anda menentukan parameter ini, parameter PageSize dan parameter PageNumber tidak tersedia.

Parameter respons

Parameter	Type	Contoh	Deskripsi
RequestId	String	1AD222E9-E606-4A42-BF6D-8A4442913CEF	ID dari permintaan tersebut.
PageNumber	Integer	1	Nomor halaman dari halaman yang dikembalikan. Catatan Jika Anda menentukan parameter MaxResults atau parameter NextToken, hanya nilai 1 yang dikembalikan. Anda dapat mengabaikan nilai 1 tersebut.
PageRecordCount	Integer	10	Jumlah entri yang dikembalikan pada halaman saat ini.
TotalRecordCount	Integer	100	Jumlah total entri yang dikembalikan. Catatan Jika Anda menentukan parameter MaxResults atau parameter NextToken, hanya jumlah entri pada halaman saat ini yang dikembalikan. Anda dapat mengabaikan angka tersebut.
Items	Array of DBInstance		Detail instans.
DBInstance
VpcId	String	vpc-uf6f7l4fg90xxxxxxx	ID VPC tempat instans tersebut berada.
DedicatedHostIdForLog	String	dh-bpxxxx	ID dari host tempat instans logger berada.
CreateTime	String	2018-11-05T11:26:02Z	Waktu saat instans dibuat. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.
PayType	String	Postpaid	Metode penagihan instans. Nilai yang valid: Postpaid: pay-as-you-go Prepaid: subscription
DedicatedHostNameForLog	String	testlog	Nama host tempat instans logger berada.
MutriORsignle	Boolean	true	Menunjukkan apakah metode penerapan multi-zona digunakan untuk instans tersebut. Nilai yang valid: true dan false. Catatan Jika metode penerapan multi-zona digunakan untuk instans, ID zona instans tersebut berisi MAZ. Contoh: `cn-hangzhou-MAZ10(h,i)`.
DedicatedHostGroupName	String	testhostgroup	Nama klaster khusus tempat instans tersebut berada.
EngineVersion	String	5.7	Versi engine database yang dijalankan oleh instans.
DedicatedHostGroupId	String	dhg-7a9xxxxxxxx	ID klaster khusus tempat instans tersebut berada.
VpcName	String	test-huadong	Nama VPC tempat instans tersebut berada.
DedicatedHostZoneIdForMaster	String	cn-hangzhou-c	ID zona tempat instans primary berada.
ConnectionString	String	rm-uf6wjk5xxxxxxx.mysql.rds.aliyuncs.com	Titik akhir instans.
InstanceNetworkType	String	Classic	Jenis jaringan dari instans. Nilai yang valid: Classic VPC
MasterInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID dari instans primary. Jika nilai parameter ini null, maka instans tersebut merupakan instans primary.
ExpireTime	String	2019-02-27T16:00:00Z	Waktu kedaluwarsa instans. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC. Catatan Instans pay-as-you-go tidak pernah kedaluwarsa.
DestroyTime	String	2018-11-05T11:26:02Z	Waktu saat instans dihapus. Waktu mengikuti standar ISO 8601 dalam format yyyy-MM-ddTHH:mm:ssZ. Waktu ditampilkan dalam UTC.
GuardDBInstanceId	String	rm-uf64zsuxxxxxxxxxx	ID instans disaster recovery. Parameter ini hanya dikembalikan ketika instans tersebut merupakan instans primary dan memiliki instans disaster recovery.
DedicatedHostNameForMaster	String	testmaster	Nama host tempat instans primary berada.
ZoneId	String	cn-hangzhou-a	ID zona tempat instans berada.
DBInstanceId	String	rm-uf6wjk5xxxxxxxxxx	ID instans.
DedicatedHostIdForMaster	String	dh-bpxxxx	ID host tempat instans primary berada.
TempDBInstanceId	String	rm-uf64zsuxxxxxxxxxx	ID instans temporary. Parameter ini hanya dikembalikan ketika instans tersebut merupakan instans primary dan memiliki instans temporary.
DBInstanceStorageType	String	ModuleList.4.ModuleCode	Jenis storage dari instans tersebut.
ConnectionMode	String	Standard	Mode koneksi instans. Nilai yang valid: Standard: mode standar Safe: mode proksi database
LockMode	String	Unlock	Menunjukkan apakah instans terkunci. Nilai yang valid: Unlock: Instans tidak terkunci. ManualLock: Instans dikunci secara manual. LockByExpiration: Instans dikunci secara otomatis setelah masa berlakunya habis. LockByRestoration: Instans dikunci secara otomatis sebelum dipulihkan ke kondisi sebelumnya. LockByDiskQuota: Instans dikunci secara otomatis setelah kapasitas penyimpanannya habis. Released: Instans telah dirilis. Setelah instans dirilis, instans tersebut tidak dapat di-unlock. Anda hanya dapat memulihkan data backup instans tersebut ke instans baru. Proses ini memerlukan rentang waktu yang lama.
VpcCloudInstanceId	String	rm-uf6wjk5xxxxxxx	ID instans. Parameter ini hanya dikembalikan ketika instans berada di dalam VPC.
DedicatedHostZoneIdForSlave	String	cn-hangzhou-d	ID zona tempat instans secondary berada.
DedicatedHostZoneIdForLog	String	cn-hangzhou-b	ID zona dari Host tempat instans logger berada.
DedicatedHostNameForSlave	String	testslave	Nama host tempat instans secondary berada.
DBInstanceDescription	String	testdatabase	Deskripsi instans tersebut.
DBInstanceNetType	String	Internet	Jenis koneksi jaringan ke instans. Nilai yang valid: Internet: Internet Intranet: jaringan internal
DBInstanceType	String	Primary	Peran instans. Nilai yang valid: Primary: instans utama Readonly: instans hanya baca Guard: instans pemulihan bencana Temp: instans temporary
LockReason	String	instance_expired	Alasan mengapa instans tersebut terkunci.
DBInstanceStatus	String	Running	Status instans. Untuk informasi selengkapnya, lihat Instance state table.
RegionId	String	cn-hangzhou	ID wilayah dari instans tersebut.
VSwitchId	String	vsw-uf6adz52c2pxxxxxxx	ID vSwitch.
DedicatedHostIdForSlave	String	dh-bpxxxx	ID host tempat instans secondary berada.
ResourceGroupId	String	rg-acfmyxxxxxxx	ID kelompok sumber daya tempat instans tersebut berada.
Category	String	Basic	Edisi RDS dari instans. Nilai yang valid: Basic: Edisi Dasar HighAvailability: Edisi Ketersediaan Tinggi Finance: Edisi Perusahaan Catatan Parameter ini hanya dikembalikan ketika parameter InstanceLevel diatur ke 1.
Engine	String	MySQL	Engine database yang dijalankan oleh instans.
DBInstanceClass	String	rds.mys2.small	Tipe instans dari instans tersebut. Untuk informasi selengkapnya, lihat Primary ApsaraDB RDS instance types.
ReadOnlyDBInstanceIds	Array of ReadOnlyDBInstanceId		Array yang terdiri dari ID instans hanya baca yang disambungkan ke instans. Parameter ini hanya dikembalikan ketika instans adalah instans utama dan memiliki instans hanya baca.
ReadOnlyDBInstanceId
DBInstanceId	String	rr-uf6wjk5xxxxxxx	ID instans hanya baca.
DeletionProtection	Boolean	false	Menunjukkan apakah fitur release protection diaktifkan untuk instans hanya baca. Nilai yang valid: true: Fitur release protection diaktifkan. false: Fitur release protection dinonaktifkan.
NextToken	String	o7PORW5o2TJg**********	Token yang digunakan untuk menampilkan halaman berikutnya. Jika entri yang dikembalikan ditampilkan dalam beberapa halaman, halaman berikutnya dapat ditampilkan ketika Anda memanggil operasi ini lagi dengan parameter NextToken yang ditentukan.

Contoh

Permintaan contoh

http(s)://rds.aliyuncs.com/?Action=DescribeDBInstances
&RegionId=cn-hangzhou
&<Common request parameters>

Respons sukses contoh

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBInstancesResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <PageRecordCount>1</PageRecordCount>
    <RequestId>A436D75C-30B0-1F34-8544-4B46F4407CC1</RequestId>
    <NextToken>o7PORW5owHNg**********</NextToken>
    <PageNumber>1</PageNumber>
    <Items>
        <DBInstance>
            <EngineVersion>10.0</EngineVersion>
            <ZoneId>cn-hangzhou-h</ZoneId>
            <DBInstanceStatus>Running</DBInstanceStatus>
            <ResourceGroupId>rg-acfmyiu********</ResourceGroupId>
            <DBInstanceNetType>Intranet</DBInstanceNetType>
            <DBInstanceClass>pg.n2.small.2c</DBInstanceClass>
            <CreateTime>2021-02-02T09:14:48Z</CreateTime>
            <VSwitchId>vsw-bp10aqj6o4lcl********</VSwitchId>
            <TipsLevel>0</TipsLevel>
            <DBInstanceType>Primary</DBInstanceType>
            <PayType>Prepaid</PayType>
            <LockMode>Unlock</LockMode>
            <DeletionProtection>false</DeletionProtection>
            <MutriORsignle>false</MutriORsignle>
            <InstanceNetworkType>VPC</InstanceNetworkType>
            <InsId>1</InsId>
            <VpcId>vpc-bp1opxu1zkhn0********</VpcId>
            <DBInstanceId>pgm-bp10re7n********</DBInstanceId>
            <ConnectionMode>Standard</ConnectionMode>
            <ReadOnlyDBInstanceIds>
            </ReadOnlyDBInstanceIds>
            <VpcCloudInstanceId>pgm-bp10re7n********</VpcCloudInstanceId>
            <RegionId>cn-hangzhou</RegionId>
            <ConnectionString>pgm-bp10re7n**************.pg.rds.aliyuncs.com</ConnectionString>
            <ExpireTime>2021-02-03T09:14:48Z</ExpireTime>
            <Engine>PostgreSQL</Engine>
        </DBInstance>
    </Items>
</DescribeDBInstancesResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 1,
  "PageRecordCount" : 1,
  "RequestId" : "A436D75C-30B0-1F34-8544-4B46F4407CC1",
  "NextToken" : "o7PORW5owHNg**********",
  "PageNumber" : 1,
  "Items" : {
    "DBInstance" : [ {
      "EngineVersion" : "10.0",
      "ZoneId" : "cn-hangzhou-h",
      "DBInstanceStatus" : "Running",
      "ResourceGroupId" : "rg-acfmyiu********",
      "DBInstanceNetType" : "Intranet",
      "DBInstanceClass" : "pg.n2.small.2c",
      "CreateTime" : "2021-02-02T09:14:48Z",
      "VSwitchId" : "vsw-bp10aqj6o4lcl********",
      "TipsLevel" : 0,
      "DBInstanceType" : "Primary",
      "PayType" : "Prepaid",
      "LockMode" : "Unlock",
      "DeletionProtection" : false,
      "MutriORsignle" : false,
      "InstanceNetworkType" : "VPC",
      "InsId" : 1,
      "VpcId" : "vpc-bp1opxu1zkhn0********",
      "DBInstanceId" : "pgm-bp10re7n********",
      "ConnectionMode" : "Standard",
      "ReadOnlyDBInstanceIds" : {
        "ReadOnlyDBInstanceId" : [ ]
      },
      "VpcCloudInstanceId" : "pgm-bp10re7n********",
      "RegionId" : "cn-hangzhou",
      "ConnectionString" : "pgm-bp10re7n**************.pg.rds.aliyuncs.com",
      "ExpireTime" : "2021-02-03T09:14:48Z",
      "Engine" : "PostgreSQL"
    } ]
  }
}

Kode kesalahan

Kode status HTTP	Kode kesalahan	Pesan kesalahan	Deskripsi
400	Invalid.NextToken	The parameter NextToken is invalid.	Pesan kesalahan yang dikembalikan karena nilai parameter NextToken tidak valid.
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter"DBInstanceType" is not valid.	Pesan kesalahan yang dikembalikan karena tipe instans yang ditentukan tidak valid. Anda harus menentukan tipe instans yang valid.

Untuk daftar kode kesalahan, kunjungi Error Center.