使用DescribeDBInstanceAttribute API查詢執行個體詳情-雲原生資料倉儲AnalyticDB-阿里雲

查詢AnalyticDB PostgreSQL版執行個體詳情。

介面說明

使用說明

本介面一般用於查看 AnalyticDB PostgreSQL 版執行個體的規格、網路類型、執行個體狀態等資訊。

QPS 限制

本介面的單使用者 QPS 限制預設為 1000 次/秒。超過限制，API 呼叫會被限流，這可能會影響您的業務，請合理調用。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

gpdb:DescribeDBInstanceAttribute

get

*DBInstance

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

無

請求參數

名稱	類型	必填	描述	樣本值
ResourceGroupId	string	否	該參數已廢棄，無需傳入該參數。	null
DBInstanceId	string	是	執行個體 ID。說明您可以調用 DescribeDBInstances 介面查看目標地區下所有的 AnalyticDB PostgreSQL 執行個體的執行個體 ID。	gp-bp13ue79qk8y1****

返回參數

名稱	類型	描述	樣本值
	object
Items	object
DBInstanceAttribute	array<object>	執行個體詳情列表。
	array<object>	詳情。
AvailabilityValue	string	查詢當前執行個體可用性狀態，單位：百分比（%）。說明該參數僅適用儲存預留模式的執行個體。	100.0%
ConnectionMode	string	訪問模式，取值說明： Performance：標準訪問模式。 Safty：高安全訪問模式。 LVS：LVS 鏈路模式。	LVS
ConnectionString	string	執行個體串連地址。	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	核心小版本號碼。	mm.v6.3.10.1-202207141918
CpuCores	integer	計算節點 CPU 核心數，單位 Core。	2
CpuCoresPerNode	integer	單節點的 CPU 核心數。說明該參數僅適用儲存預留模式的執行個體。	0
CreationTime	string	執行個體建立時間。	2022-08-11T09:16:26Z
DBInstanceCategory	string	執行個體系列，取值說明： Basic：基礎版。 HighAvailability：高可用版。	HighAvailability
DBInstanceClass	string	執行個體規格。說明該參數僅適用儲存預留模式的執行個體。	gpdb.group.segsdx1
DBInstanceClassType	string	執行個體規格類型系列，取值說明： s：共用型。 x：通用型。 d：獨享套餐。 h：獨佔物理機。	x
DBInstanceCpuCores	integer	CPU 核心數。	2
DBInstanceDescription	string	執行個體描述。	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	計算群組最大的 BPS（磁碟輸送量），單位：Mbps。說明該參數僅適用儲存預留模式的執行個體。	0
DBInstanceGroupCount	string	計算群組數量。說明該參數僅適用儲存預留模式的執行個體。	0
DBInstanceId	string	執行個體 ID。	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	計算節點的記憶體。說明儲存預留模式的單位為 MB；Serverless 和儲存彈性模式單位為 GB。	16
DBInstanceMode	string	執行個體資源類型，取值說明： Serverless：Serverless 模式。 StorageElastic：儲存彈性模式。 Classic：儲存預留模式。	StorageElastic
DBInstanceNetType	string	該參數已廢棄，不會返回參數值。	null
DBInstanceStatus	string	執行個體狀態，詳細說明請參見 DBInstanceStatus 參數補充說明。	Running
DBInstanceStorage	integer	單個副本的最大儲存空間，單位：GB。	50
DeployMode	string	部署模式	single
EncryptionKey	string	加密金鑰。說明僅開啟雲端硬碟加密的執行個體會返回該參數。	0d2470df-da7b-4786-b981-************
EncryptionType	string	加密類型，取值說明： CloudDisk：雲端硬碟加密。說明僅雲端硬碟加密的執行個體會返回該參數。	CloudDisk
Engine	string	資料庫引擎。	gpdb
EngineVersion	string	資料庫版本。	6.0
ExpireTime	string	執行個體到期時間（UTC 時間）。說明隨用隨付執行個體的到期時間為`2999-09-08T16:00:00Z`。	2999-09-08T16:00:00Z
HostType	string	計算群組機器類型，取值說明： 0：SSD 1：HDD 說明該參數僅適用儲存預留模式的執行個體。	0
IdleTime	integer	空閑釋放等待時間長度。單位為秒。說明僅 Serverless 自動調度模式執行個體返回該參數。	600
InstanceNetworkType	string	執行個體網路類型，取值說明： Classic：傳統網路。 VPC：VPC 網路。	VPC
LockMode	string	鎖定方式，取值說明： Unlock：正常。 ManualLock：手動觸發鎖定。 LockByExpiration：執行個體到期自動鎖定。 LockByRestoration：執行個體復原前的自動鎖定。 LockByDiskQuota：執行個體空間滿自動鎖定。	Unlock
LockReason	string	該參數已廢棄，故不會返回參數值。	null
MaintainEndTime	string	可維護結束時間。	22:00Z
MaintainStartTime	string	可維護開始時間。	18:00Z
MasterCU	integer	Master 資源。	4
MasterNodeNum	integer	Master 節點數量。	1
MaxConnections	integer	執行個體的最大並發串連數。說明該參數僅適用儲存預留模式的執行個體。	500
MemoryPerNode	integer	單副本的記憶體大小，單位請參見 MemoryUnit 參數。說明該參數僅適用儲存預留模式的執行個體。	0
MemorySize	integer	計算節點記憶體大小。說明儲存預留模式的單位為 MB；Serverless 和儲存彈性模式單位為 GB。	16
MemoryUnit	string	記憶體單位。說明該參數僅適用儲存預留模式的執行個體。	GB
MinorVersion	string	核心小版本。	6.3.10.1-202207141918
PayType	string	計費類型，取值說明： Postpaid：隨用隨付。 Prepaid：訂用帳戶。	Postpaid
Port	string	執行個體的連接埠號碼。	5432
ProdType	string	產品類型	standard
ReadDelayTime	string	該參數已廢棄，故不會返回參數值。	null
RegionId	string	地區 ID。	cn-hangzhou
ResourceGroupId	string	執行個體所在的資源群組 ID。	rg-bp67acfmxazb4p****
RunningTime	string	執行個體運行時間長度。	4 days 22:58:55
SecurityIPList	string	該參數已廢棄，不會返回參數值。	null
SegDiskPerformanceLevel	string	效能層級 PL（Performance Level），目前僅支援 PL1。	PL1
SegNodeNum	integer	Segment 節點數量。說明該參數僅適用儲存彈性模式和 Serverless 手動調度模式的執行個體。	4
SegmentCounts	integer	計算群組個數。說明該參數僅適用儲存預留模式的執行個體。	0
ServerlessMode	string	Serverless 執行個體的模式，取值如下： Manual：手動調度。 Auto：自動調度。說明僅 Serverless 模式執行個體返回該參數。雲原生資料倉儲 AnalyticDB PostgreSQL 版 Serverless 自動調度模式正在邀測中。如需使用，請您提交工單申請邀測資格。	Auto
ServerlessResource	integer	計算資源閾值。單位為 ACU。說明僅 Serverless 自動調度模式執行個體返回該參數。	32
StandbyZoneId	string	備可用性區域 ID	cn-hangzhou-i
StartTime	string	執行個體開始啟動並執行時間。	2022-08-11T09:26:43Z
StoragePerNode	integer	單副本的儲存大小，單位請參見 StorageUnit 參數。說明該參數僅適用儲存預留模式的執行個體。	0
StorageSize	integer	儲存空間大小，單位 GB。	50
StorageType	string	儲存類型，取值說明： cloud_essd：ESSD 雲端硬碟。 cloud_efficiency：高效雲端硬碟。說明該參數僅適用儲存彈性模式的執行個體。	cloud_essd
StorageUnit	string	儲存單位，取值說明： GB SSD TB SSD GB HDD 說明該參數僅適用儲存預留模式的執行個體。	GB SSD
SupportRestore	boolean	是否支援備份恢複，取值說明： true：支援備份恢複。 false：不支援備份恢複。	true
Tags	object
Tag	array<object>	標記索引值對。
	object	標籤詳情如下。
Key	string	標籤鍵。	test-key
Value	string	標籤值。	test-value
VSwitchId	string	vSwitch ID。	vsw-bp1cpq8mr64paltkb****
VectorConfigurationStatus	string	是否開啟向量引擎最佳化，取值說明： enabled：表示開啟向量引擎最佳化。 disabled：表示已關閉向量引擎最佳化。	enabled
VpcId	string	VPC ID。	vpc-bp19ame5m1r3oejns****
ZoneId	string	可用性區域 ID。	cn-hangzhou-j
SegmentAISpec	string	返回執行個體的計算 AI 節點規格。如果計算節點非 AI 節點，則返回空值。	ADB.AIMedium.2
MasterAISpec	string	返回執行個體的 Master AI 節點規格。如果 Master 節點非 AI 節點，則返回空值。	ADB.AIMedium.2
CacheStorageSize	string	緩衝盤總大小，單位為 GB。	64
InstanceSpec	string	計算節點規格。	2C16G
GraphEngineStatus	string	是否開啟圖引擎。取值說明： enabled：表示開啟圖引擎。 disabled：表示已關閉圖引擎。	enabled
RequestId	string	請求 ID。	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

DBInstanceStatus 參數補充說明

DBInstanceStatus 取值如下：

Creating：建立中。
Running：使用中。
Deleting：刪除中。
Rebooting：重啟中。
DBInstanceClassChanging：升降級中。
Transfering：遷移中。
EngineVersionUpgrading：遷移版本中。
TransferingToOtherInstance：遷移資料到其他 AnalyticDB for PostgreSQL 中。
GuardDBInstanceCreating：建立災備執行個體中。
Restoring：備份恢複中。
Importing：資料匯入中。
ImportingFromOtherInstance：從其他 AnalyticDB for PostgreSQL 執行個體匯入資料中。
DBInstanceNetTypeChangin：內外網切換中。
GuardSwitching：容災切換中。

樣本

正常返回樣本

JSON格式

{
  "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"
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。