Gunakan ListInstances untuk kueri instans database - Data Management - Alibaba Cloud - Data Management

Mengambil daftar instans.

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

dms:ListInstances

list

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
Tid	integer	No	ID penyewa. Anda dapat memanggil operasi GetUserActiveTenant untuk memperoleh parameter ini.	3***
SearchKey	string	No	Kata kunci pencarian.	test.
DbType	string	No	Tipe database. Untuk informasi lebih lanjut tentang nilai valid, lihat Deskripsi parameter DbType.	MySQL.
EnvType	string	No	Tipe lingkungan. Nilai valid:	Produk
InstanceSource	string	No	Sumber instans. Nilai valid:	RDS.
NetType	string	No	Jenis jaringan instans. Nilai valid:	VPC.
InstanceState	string	No	Status instans. Nilai valid:	NORMAL.
PageNumber	integer	No	Nomor halaman.	1
PageSize	integer	No	Jumlah entri per halaman. Nilainya tidak boleh melebihi 100.	50
Region	string	No	ID wilayah instans.	cn-hangzhou.
RealLoginUserUid	string	No	ID akun Alibaba Cloud dari pengguna yang sebenarnya memanggil API.	21400447956867****

Elemen respons

Element	Type	Description	Example
	object	Parameter tanggapan.
TotalCount	integer	Jumlah total instans yang memenuhi kondisi.	1
RequestId	string	ID permintaan.	B4B07137-F6AE-4756-8474-7F92BB6C4E04
ErrorCode	string	Kode kesalahan.	UnknownError.
ErrorMessage	string	Paket kesalahan.	UnknownError.
InstanceList	object
Instance	array<object>	Daftar instans.
	array<object>	Informasi instans.
VpcId	string	ID VPC tempat instans berada.	vpc-o6wrloqsdqc9io3mg****
DatabaseUser	string	Nama pengguna database.	dbUser
DbaId	string	ID DBA instans.	31****
UseDsql	integer	Apakah kueri lintas database diaktifkan untuk instans. 0: dinonaktifkan 1: diaktifkan	1
Port	integer	Port koneksi instans.	3306
EcsInstanceId	string	ID Instance ECS.	150****
EnvType	string	Jenis lingkungan instans. Nilai valid: product: lingkungan produksi dev: lingkungan pengembangan pre: lingkungan pra-rilis test: Lingkungan pengujian sit: lingkungan SIT uat: lingkungan UAT pet: lingkungan uji stres stag: lingkungan STAG	product
Sid	string	SID instans.	test
OwnerIdList	object
OwnerIds	array	Daftar ID pengguna pemilik instans.
	string	ID pengguna pemilik instans.	12****
SafeRuleId	string	ID aturan keamanan instans.	1
OwnerNameList	object
OwnerNames	array	Daftar nama panggilan pemilik instans.
	string	Nama panggilan pemilik instans.	yuyang_test
DbaNickName	string	Nama panggilan DBA instans.	dbaName
QueryTimeout	integer	Periode waktu tunggu kueri instans.	60
InstanceSource	string	Sumber instans.	RDS
Host	string	Titik akhir instans.	****.mysql.rds.aliyuncs.com
State	string	Status instans.	NORMAL
DataLinkName	string	Nama DataLink.	dblink_test
ExportTimeout	integer	Periode waktu tunggu ekspor.	86400
InstanceId	string	ID instans.	150***
InstanceType	string	Jenis database instans.	mysql
DatabasePassword	string	Kata sandi pengguna database.	******
InstanceAlias	string	Alias instans.	test
DdlOnline	integer	Konfigurasi DdlOnline instans.	1
EcsRegion	string	Wilayah tempat instans berada.	cn-hangzhou
StandardGroup	object	Informasi mode kontrol instans.
GroupName	string	Nama aturan keamanan yang sesuai dengan mode kontrol.	test
GroupMode	string	Jenis mode kontrol. Nilai valid: COMMON: mode kolaborasi keamanan NONE_CONTROL: mode operasi bebas STABLE: mode perubahan stabil	COMMON
SellSitd	boolean	Apakah perlindungan data sensitif diaktifkan. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	true
SellTrust	string	Apakah hosting keamanan diaktifkan. Nilai valid: true: Diaktifkan. false: Dinonaktifkan.	true
UseSsl	integer		0
Success	boolean	Apakah permintaan berhasil. Nilai valid:	true.

Contoh

Respons sukses

JSONformat

{
  "TotalCount": 1,
  "RequestId": "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "InstanceList": {
    "Instance": [
      {
        "VpcId": "vpc-o6wrloqsdqc9io3mg****",
        "DatabaseUser": "dbUser",
        "DbaId": "31****",
        "UseDsql": 1,
        "Port": 3306,
        "EcsInstanceId": "150****",
        "EnvType": "product",
        "Sid": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "12****"
          ]
        },
        "SafeRuleId": "1",
        "OwnerNameList": {
          "OwnerNames": [
            "yuyang_test"
          ]
        },
        "DbaNickName": "dbaName",
        "QueryTimeout": 60,
        "InstanceSource": "RDS",
        "Host": "****.mysql.rds.aliyuncs.com",
        "State": "NORMAL",
        "DataLinkName": "dblink_test",
        "ExportTimeout": 86400,
        "InstanceId": "150***",
        "InstanceType": "mysql",
        "DatabasePassword": "******",
        "InstanceAlias": "test",
        "DdlOnline": 1,
        "EcsRegion": "cn-hangzhou",
        "StandardGroup": {
          "GroupName": "test",
          "GroupMode": "COMMON"
        },
        "SellSitd": true,
        "SellTrust": "true",
        "UseSsl": 0
      }
    ]
  },
  "Success": true
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.