Gunakan DescribeDBInstanceAttribute untuk mengkueri detail instans - AnalyticDB

Mengambil detail instans AnalyticDB for PostgreSQL.

Deskripsi operasi

Cara Penggunaan

API ini umumnya digunakan untuk melihat informasi instans AnalyticDB for PostgreSQL, seperti spesifikasi, jenis jaringan, dan status.

Batas Permintaan per Detik (QPS)

Batas QPS default untuk API ini adalah 1.000 permintaan per detik per pengguna. Jika batas ini terlampaui, panggilan API akan dibatasi lajunya, yang dapat memengaruhi operasi bisnis Anda. Pastikan Anda memanggil API secara tepat.

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

gpdb:DescribeDBInstanceAttribute

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

None

Parameter permintaan

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	Parameter ini sudah tidak digunakan lagi dan tidak perlu ditentukan.	null
DBInstanceId	string	Yes	ID instans. Catatan Anda dapat memanggil API DescribeDBInstances untuk melihat ID instans semua instans AnalyticDB for PostgreSQL di wilayah tujuan.	gp-bp13ue79qk8y1****

Elemen respons

Element	Type	Description	Example
	object
Items	object
DBInstanceAttribute	array<object>	Daftar detail instans.
	array<object>	Detail.
AvailabilityValue	string	Kueri status ketersediaan instans saat ini, dalam persentase (%). Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	100.0%
ConnectionMode	string	Mode akses. Nilai yang valid: Performance: Mode akses standar. Safty: Mode akses keamanan tinggi. LVS: Mode tautan LVS.	LVS
ConnectionString	string	Alamat koneksi instans.	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	Nomor versi mesin minor.	mm.v6.3.10.1-202207141918
CpuCores	integer	Jumlah core CPU pada node komputasi, dalam satuan core.	2
CpuCoresPerNode	integer	Jumlah core CPU per node. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
CreationTime	string	Waktu pembuatan instans.	2022-08-11T09:16:26Z
DBInstanceCategory	string	Edisi instans. Nilai yang valid: Basic: Edisi Dasar. HighAvailability: Edisi Ketersediaan Tinggi.	HighAvailability
DBInstanceClass	string	Jenis instans. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	gpdb.group.segsdx1
DBInstanceClassType	string	Keluarga instans. Nilai yang valid: s: Jenis bersama. x: Jenis tujuan umum. d: Paket khusus. h: Mesin fisik khusus.	x
DBInstanceCpuCores	integer	Jumlah core CPU.	2
DBInstanceDescription	string	Deskripsi instans.	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	BPS maksimum (throughput disk) kelompok komputasi, dalam Mbps. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
DBInstanceGroupCount	string	Jumlah kelompok komputasi. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
DBInstanceId	string	ID instans.	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	Memori node komputasi. Catatan Unitnya adalah MB untuk mode penyimpanan reservasi, dan GB untuk mode Serverless serta mode penyimpanan elastis.	16
DBInstanceMode	string	Jenis resource instans. Nilai yang valid: Serverless: Mode Serverless. StorageElastic: Mode elastisitas penyimpanan. Classic: Mode penyimpanan reservasi.	StorageElastic
DBInstanceNetType	string	Parameter ini sudah tidak digunakan lagi dan tidak akan mengembalikan nilai.	null
DBInstanceStatus	string	Status instans. Untuk informasi lebih lanjut, lihat deskripsi tambahan parameter DBInstanceStatus.	Running
DBInstanceStorage	integer	Ruang penyimpanan maksimum per replika, dalam GB.	50
DeployMode	string	Mode penyebaran	single
EncryptionKey	string	Kunci enkripsi. Catatan Parameter ini hanya dikembalikan untuk instans yang telah mengaktifkan enkripsi disk.	0d2470df-da7b-4786-b981-************
EncryptionType	string	Jenis enkripsi. Nilai yang valid: CloudDisk: enkripsi disk. Catatan Parameter ini hanya dikembalikan untuk instans yang telah mengaktifkan enkripsi disk.	CloudDisk
Engine	string	Mesin database.	gpdb
EngineVersion	string	Versi database.	6.0
ExpireTime	string	Waktu kedaluwarsa instans (UTC). Catatan Waktu kedaluwarsa untuk instans pay-as-you-go adalah `2999-09-08T16:00:00Z`.	2999-09-08T16:00:00Z
HostType	string	Jenis mesin kelompok komputasi. Nilai yang valid: 0: SSD 1: HDD Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
IdleTime	integer	Durasi tunggu pelepasan saat idle. Satuannya adalah detik. Catatan Parameter ini hanya dikembalikan untuk instans dalam mode Serverless dengan penjadwalan otomatis.	600
InstanceNetworkType	string	Jenis jaringan instans. Nilai yang valid: Classic: jaringan klasik. VPC: jaringan VPC.	VPC
LockMode	string	Mode penguncian. Nilai yang valid: Unlock: Normal. ManualLock: Dikunci secara manual. LockByExpiration: Secara otomatis dikunci ketika instans kedaluwarsa. LockByRestoration: Secara otomatis dikunci sebelum rollback instans. LockByDiskQuota: Secara otomatis dikunci ketika ruang penyimpanan instans penuh.	Unlock
LockReason	string	Parameter ini sudah tidak digunakan lagi sehingga tidak ada nilai parameter yang dikembalikan.	null
MaintainEndTime	string	Waktu akhir maintenance.	22:00Z
MaintainStartTime	string	Waktu mulai jendela pemeliharaan.	18:00Z
MasterCU	integer	Resource master.	4
MasterNodeNum	integer	Jumlah node master.	1
MaxConnections	integer	Jumlah maksimum koneksi bersamaan untuk instans. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	500
MemoryPerNode	integer	Ukuran memori per replika. Untuk unitnya, lihat parameter MemoryUnit. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
MemorySize	integer	Ukuran memori node komputasi. Catatan Unitnya adalah MB untuk mode penyimpanan reservasi, dan GB untuk mode Serverless serta mode penyimpanan elastis.	16
MemoryUnit	string	Unit memori. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	GB
MinorVersion	string	Versi mesin minor.	6.3.10.1-202207141918
PayType	string	Jenis penagihan. Nilai yang valid: Postpaid: pay-as-you-go. Prepaid: subscription.	Postpaid
Port	string	Nomor port instans.	5432
ProdType	string	Jenis produk	standard
ReadDelayTime	string	Parameter ini sudah tidak digunakan lagi sehingga tidak ada nilai yang dikembalikan.	null
RegionId	string	ID wilayah.	cn-hangzhou
ResourceGroupId	string	ID kelompok sumber daya tempat instans berada.	rg-bp67acfmxazb4p****
RunningTime	string	Durasi instans berjalan.	4 days 22:58:55
SecurityIPList	string	Parameter ini sudah tidak digunakan lagi dan tidak akan mengembalikan nilai.	null
SegDiskPerformanceLevel	string	Tingkat performa (PL). Saat ini hanya mendukung PL1.	PL1
SegNodeNum	integer	Jumlah node segmen. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan elastis dan mode Serverless dengan penjadwalan manual.	4
SegmentCounts	integer	Jumlah kelompok komputasi. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
ServerlessMode	string	Mode instans Serverless. Nilai yang valid: Manual: penjadwalan manual. Auto: penjadwalan otomatis. Catatan Parameter ini hanya dikembalikan untuk instans Serverless. Mode penjadwalan otomatis untuk AnalyticDB for PostgreSQL Serverless saat ini dalam pratinjau undangan. Untuk menggunakan fitur ini, ajukan tiket untuk meminta akses.	Auto
ServerlessResource	integer	Ambang batas resource komputasi, diukur dalam ACU. Catatan Parameter ini hanya dikembalikan untuk instans dalam mode Serverless dengan penjadwalan otomatis.	32
StandbyZoneId	string	ID zona sekunder.	cn-hangzhou-i
StartTime	string	Waktu instans mulai berjalan.	2022-08-11T09:26:43Z
StoragePerNode	integer	Ukuran penyimpanan per replika. Untuk unitnya, lihat parameter StorageUnit. Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	0
StorageSize	integer	Ukuran bucket, dalam GB.	50
StorageType	string	Jenis penyimpanan. Nilai yang valid: cloud_essd: SSD Perusahaan (ESSD). cloud_efficiency: disk ultra. Catatan Parameter ini hanya berlaku untuk instans dalam mode elastisitas penyimpanan.	cloud_essd
StorageUnit	string	Unit penyimpanan. Nilai yang valid: GB SSD TB SSD GB HDD Catatan Parameter ini hanya berlaku untuk instans dalam mode penyimpanan reservasi.	GB SSD
SupportRestore	boolean	Menunjukkan apakah pemulihan backup didukung. Nilai yang valid: true: Pemulihan backup didukung. false: Pemulihan backup tidak didukung.	true
Tags	object
Tag	array<object>	Pasangan kunci-nilai tag.
	object	Detail tag adalah sebagai berikut.
Key	string	Kunci tag.	test-key
Value	string	Nilai tag.	test-value
VSwitchId	string	ID vSwitch.	vsw-bp1cpq8mr64paltkb****
VectorConfigurationStatus	string	Menunjukkan apakah optimisasi mesin vektor diaktifkan. Nilai yang valid: enabled: Optimisasi mesin vektor diaktifkan. disabled: Optimisasi mesin vektor dinonaktifkan.	enabled
VpcId	string	ID VPC.	vpc-bp19ame5m1r3oejns****
ZoneId	string	ID zona.	cn-hangzhou-j
SegmentAISpec	string	Spesifikasi node AI komputasi instans. Jika node komputasi bukan node AI, nilai kosong akan dikembalikan.	ADB.AIMedium.2
MasterAISpec	string	Mengembalikan spesifikasi node AI master instans. Jika node master bukan node AI, nilai kosong akan dikembalikan.	ADB.AIMedium.2
CacheStorageSize	string	Total ukuran disk cache, dalam GB.	64
InstanceSpec	string	Spesifikasi node komputasi.	2C16G
GraphEngineStatus	string	Menunjukkan apakah mesin graf diaktifkan. Nilai yang valid: enabled: Mesin graf diaktifkan. disabled: Mesin graf dinonaktifkan.	enabled
RequestId	string	ID permintaan.	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

Deskripsi Tambahan Parameter DBInstanceStatus

Parameter DBInstanceStatus dapat memiliki nilai-nilai berikut:

Creating: Sedang dalam proses pembuatan.
Running: Sedang digunakan.
Deleting: Sedang dalam proses penghapusan.
Rebooting: Sedang dalam proses restart.
DBInstanceClassChanging: Sedang dalam proses scaling up atau down.
Transfering: Sedang dalam proses migrasi.
EngineVersionUpgrading: Sedang dalam proses upgrade versi.
TransferingToOtherInstance: Sedang memigrasikan data ke instans AnalyticDB for PostgreSQL lainnya.
GuardDBInstanceCreating: Sedang membuat instans disaster recovery.
Restoring: Sedang dalam proses pemulihan backup.
Importing: Sedang dalam proses impor data.
ImportingFromOtherInstance: Sedang mengimpor data dari instans AnalyticDB for PostgreSQL lainnya.
DBInstanceNetTypeChangin: Sedang beralih antara jenis jaringan internal dan publik.
GuardSwitching: Sedang dalam proses switchover.

Contoh

Respons sukses

JSONformat

{
  "Items": {
    "DBInstanceAttribute": [
      {
        "AvailabilityValue": "100.0%",
        "ConnectionMode": "LVS",
        "ConnectionString": "gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com",
        "CoreVersion": "mm.v6.3.10.1-202207141918",
        "CpuCores": 2,
        "CpuCoresPerNode": 0,
        "CreationTime": "2022-08-11T09:16:26Z",
        "DBInstanceCategory": "HighAvailability",
        "DBInstanceClass": "gpdb.group.segsdx1",
        "DBInstanceClassType": "x",
        "DBInstanceCpuCores": 2,
        "DBInstanceDescription": "gp-bp13ue79qk8y1****",
        "DBInstanceDiskMBPS": 0,
        "DBInstanceGroupCount": "0",
        "DBInstanceId": "gp-bp13ue79qk8y1****",
        "DBInstanceMemory": 16,
        "DBInstanceMode": "StorageElastic",
        "DBInstanceNetType": "null",
        "DBInstanceStatus": "Running",
        "DBInstanceStorage": 50,
        "DeployMode": "single",
        "EncryptionKey": "0d2470df-da7b-4786-b981-************",
        "EncryptionType": "CloudDisk",
        "Engine": "gpdb",
        "EngineVersion": "6.0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "HostType": "0",
        "IdleTime": 600,
        "InstanceNetworkType": "VPC",
        "LockMode": "Unlock",
        "LockReason": "null",
        "MaintainEndTime": "22:00Z",
        "MaintainStartTime": "18:00Z",
        "MasterCU": 4,
        "MasterNodeNum": 1,
        "MaxConnections": 500,
        "MemoryPerNode": 0,
        "MemorySize": 16,
        "MemoryUnit": "GB",
        "MinorVersion": "6.3.10.1-202207141918",
        "PayType": "Postpaid",
        "Port": "5432",
        "ProdType": "standard",
        "ReadDelayTime": "null",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "RunningTime": "4 days 22:58:55",
        "SecurityIPList": "null",
        "SegDiskPerformanceLevel": "PL1",
        "SegNodeNum": 4,
        "SegmentCounts": 0,
        "ServerlessMode": "Auto",
        "ServerlessResource": 32,
        "StandbyZoneId": "cn-hangzhou-i",
        "StartTime": "2022-08-11T09:26:43Z",
        "StoragePerNode": 0,
        "StorageSize": 50,
        "StorageType": "cloud_essd",
        "StorageUnit": "GB SSD",
        "SupportRestore": true,
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "VectorConfigurationStatus": "enabled",
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "ZoneId": "cn-hangzhou-j",
        "SegmentAISpec": "ADB.AIMedium.2",
        "MasterAISpec": "ADB.AIMedium.2",
        "CacheStorageSize": "64",
        "InstanceSpec": "2C16G",
        "GraphEngineStatus": "enabled"
      }
    ]
  },
  "RequestId": "5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68"
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.