Gunakan DescribeDBInstanceAttribute untuk mengkueri detail instans - AnalyticDB - Alibaba Cloud - AnalyticDB

Mengkueri detail instans Database Analitik for PostgreSQL.

Deskripsi operasi

Catatan penggunaan

Operasi ini umumnya digunakan untuk Tampilan informasi seperti spesifikasi, jenis jaringan, dan status instans dari instans Database Analitik for PostgreSQL.

Batas QPS

Batas QPS default per pengguna untuk operasi ini adalah 1.000 panggilan per detik. Jika batas terlampaui, panggilan API akan dibatasi (throttled), yang dapat memengaruhi bisnis Anda. Panggil operasi ini pada laju yang wajar.

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 tidak digunakan lagi. Anda tidak perlu menentukan parameter ini.	null
DBInstanceId	string	Yes	ID instans. Catatan Anda dapat memanggil operasi DescribeDBInstances untuk mengkueri ID semua instans Database Analitik for PostgreSQL dalam suatu wilayah.	gp-bp13ue79qk8y1****

Elemen respons

Element	Type	Description	Example
	object
Items	object
DBInstanceAttribute	array<object>	Instans yang dikueri.
	array<object>	Detail instans.
AvailabilityValue	string	Queries the current instance availability status, in percentage (%). Catatan This parameter is only applicable to instances in the storage reserved mode.	100.0%
ConnectionMode	string	Access mode, with the following values: Performance: Standard access mode. Safty: High-security access mode. LVS: LVS link mode.	LVS
ConnectionString	string	Instance connection address.	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	Minor version number of the kernel.	mm.v6.3.10.1-202207141918
CpuCores	integer	Number of CPU cores for the compute node, unit: Core.	2
CpuCoresPerNode	integer	Number of CPU cores per node. Catatan This parameter is only applicable to instances in the storage reserved mode.	0
CreationTime	string	Instance creation time.	2022-08-11T09:16:26Z
DBInstanceCategory	string	Instance series, with the following values: Basic: Basic Edition. HighAvailability: High Availability Edition.	HighAvailability
DBInstanceClass	string	Instance specification. Catatan This parameter is only applicable to reserved storage mode instances.	gpdb.group.segsdx1
DBInstanceClassType	string	Instance family, with the following values: s: Shared type. x: General type. d: Dedicated package. h: Dedicated physical machine.	x
DBInstanceCpuCores	integer	Number of CPU cores.	2
DBInstanceDescription	string	Instance description.	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	Maximum BPS (disk throughput) of the compute group, in Mbps. Catatan This parameter is only applicable to reserved storage mode instances.	0
DBInstanceGroupCount	string	Number of compute groups. Catatan This parameter is only applicable to reserved storage mode instances.	0
DBInstanceId	string	Instance ID.	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	Memory of the compute node. Catatan The unit for storage-reserved mode is MB; for Serverless and storage-elastic modes, it is GB.	16
DBInstanceMode	string	Instance resource type, with the following values: Serverless: Serverless mode. StorageElastic: Storage elastic mode. Classic: Storage reserved mode.	StorageElastic
DBInstanceNetType	string	This parameter is deprecated and will not return any value.	null
DBInstanceStatus	string	Instance status. For more details, see the supplementary explanation of the DBInstanceStatus parameter.	Running
DBInstanceStorage	integer	Maximum storage space of a single replica, in GB.	50
DeployMode	string	The deployment mode.	single
EncryptionKey	string	Encryption key. Catatan This parameter is returned only for instances with disk encryption enabled.	0d2470df-da7b-4786-b981-************
EncryptionType	string	Encryption type, with the following value: CloudDisk: Cloud disk encryption. Catatan This parameter is returned only for instances with cloud disk encryption.	CloudDisk
Engine	string	Database engine.	gpdb
EngineVersion	string	Database version.	6.0
ExpireTime	string	Instance expiration time (in UTC). Catatan The expiration time for pay-as-you-go instances is `2999-09-08T16:00:00Z`.	2999-09-08T16:00:00Z
HostType	string	Compute group machine type, with the following values: 0: SSD 1: HDD Catatan This parameter applies only to storage-reserved mode instances.	0
IdleTime	integer	Idle release waiting time. Unit: seconds. Catatan This parameter is returned only for instances in the Serverless automatic scheduling mode.	600
InstanceNetworkType	string	Instance network type, with the following values: Classic: Classic network. VPC: VPC network.	VPC
LockMode	string	Lock mode, with the following values: Unlock: Normal. ManualLock: Manually triggered lock. LockByExpiration: Automatically locked when the instance expires. LockByRestoration: Automatically locked before the instance rolls back. LockByDiskQuota: Automatically locked when the instance space is full.	Unlock
LockReason	string	This parameter is deprecated and will not return any value.	null
MaintainEndTime	string	Maintenance end time.	22:00Z
MaintainStartTime	string	Maintenance start time.	18:00Z
MasterCU	integer	Master resources.	4
MasterNodeNum	integer	Number of Master nodes.	1
MaxConnections	integer	Maximum number of concurrent connections for the instance. Catatan This parameter is only applicable to reserved storage mode instances.	500
MemoryPerNode	integer	Memory size per replica, see the MemoryUnit parameter for the unit. Catatan This parameter is only applicable to instances in the storage reserved mode.	0
MemorySize	integer	Memory size of the compute node. Catatan The unit is MB for the storage reserved mode; GB for Serverless and storage elastic modes.	16
MemoryUnit	string	Memory unit. Catatan This parameter is only applicable to reserved storage mode instances.	GB
MinorVersion	string	Minor version of the kernel.	6.3.10.1-202207141918
PayType	string	Billing type, with the following values: Postpaid: Pay-as-you-go. Prepaid: Subscription.	Postpaid
Port	string	Instance port number.	5432
ProdType	string	The service type.	standard
ReadDelayTime	string	This parameter has been deprecated and will not return a value.	null
RegionId	string	Region ID.	cn-hangzhou
ResourceGroupId	string	ID of the resource group where the instance is located.	rg-bp67acfmxazb4p****
RunningTime	string	Instance running time.	4 days 22:58:55
SecurityIPList	string	This parameter is deprecated and will not return any value.	null
SegDiskPerformanceLevel	string	Performance Level (PL), currently only PL1 is supported.	PL1
SegNodeNum	integer	Number of Segment nodes. Catatan This parameter applies only to instances in the storage elastic mode and Serverless manual scheduling mode.	4
SegmentCounts	integer	Number of compute groups. Catatan This parameter applies only to storage-reserved mode instances.	0
ServerlessMode	string	The mode of the Serverless instance, with the following values: Manual: Manual scheduling. Auto: Automatic scheduling. Catatan This parameter is returned only for Serverless mode instances.	Auto
ServerlessResource	integer	Compute resource threshold. Unit: ACU. Catatan This parameter is returned only for instances in the Serverless automatic scheduling mode.	32
StandbyZoneId	string	The secondary zone ID.	cn-hangzhou-i
StartTime	string	The time when the instance started running.	2022-08-11T09:26:43Z
StoragePerNode	integer	Storage size per replica, see the StorageUnit parameter for units. Catatan This parameter applies only to storage-reserved mode instances.	0
StorageSize	integer	Storage space size, unit: GB.	50
StorageType	string	Storage type, with the following values: cloud_essd: ESSD cloud disk. cloud_efficiency: Efficient cloud disk. Catatan This parameter is only applicable to instances in the storage elastic mode.	cloud_essd
StorageUnit	string	Storage unit, with the following values: GB SSD TB SSD GB HDD Catatan This parameter is only applicable to instances in the storage reserved mode.	GB SSD
SupportRestore	boolean	Indicates whether backup recovery is supported, with the following values: true: Backup recovery is supported. false: Backup recovery is not supported.	true
Tags	object
Tag	array<object>	Tag key-value pairs.
	object	The details of the tags are as follows.
Key	string	Tag key.	test-key
Value	string	Tag value.	test-value
VSwitchId	string	vSwitch ID.	vsw-bp1cpq8mr64paltkb****
VectorConfigurationStatus	string	Indicates whether vector engine optimization is enabled. The values are as follows: enabled: Indicates that vector engine optimization is enabled. disabled: Indicates that vector engine optimization is disabled.	enabled
VpcId	string	VPC ID.	vpc-bp19ame5m1r3oejns****
ZoneId	string	Zone ID.	cn-hangzhou-j
SegmentAISpec	string	The specifications of AI compute node resources of the instance. If the compute nodes of the instance are not AI nodes, null is returned.	ADB.AIMedium.2
MasterAISpec	string	The specifications of AI coordinator node resources of the instance. If the coordinator nodes of the instance are not AI nodes, null is returned.	ADB.AIMedium.2
CacheStorageSize	string		64
InstanceSpec	string		2C16G
GraphEngineStatus	string		enabled
RequestId	string	ID permintaan.	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

Deskripsi tambahan parameter DBInstanceStatus

Nilai parameter DBInstanceStatus adalah sebagai berikut:

Creating: Instans sedang dibuat.
Running: Instans sedang berjalan.
Deleting: Instans sedang dihapus.
Rebooting: Instans sedang dimulai ulang.
DBInstanceClassChanging: Konfigurasi instans sedang diubah.
Transfering: Instans sedang dimigrasi.
EngineVersionUpgrading: Versi mesin instans sedang ditingkatkan.
TransferingToOtherInstance: Data instans sedang dimigrasi ke instans Database Analitik for PostgreSQL lain.
GuardDBInstanceCreating: Instans pemulihan bencana sedang dibuat.
Restoring: Cadangan instans sedang dipulihkan.
Importing: Data sedang diimpor ke instans.
ImportingFromOtherInstance: Data sedang diimpor dari instans Database Analitik for PostgreSQL lain.
DBInstanceNetTypeChangin: Jenis jaringan instans sedang diubah.
GuardSwitching: Pengalihan pemulihan bencana sedang dilakukan.

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.