DescribeDBInstanceAttribute - PolarDB

呼叫 DescribeDBInstanceAttribute 介面取得執行個體屬性。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardbx:DescribeDBInstanceAttribute

get

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	執行個體所在地域。	cn-hangzhou
DBInstanceName	string	是	執行個體名稱。	pxc-********
ResourceGroupId	string	否	資源群組 ID。	rg-aekzaxhezhs5***

返回參數

名稱	類型	描述	樣本值
	object
RequestId	string	請求 ID。	9B2F3840-5C98-475C-B269-2D5C3A31797C
DBInstance	object	資料庫執行個體資訊。
Type	string	執行個體類型： ReadWrite：主執行個體； ReadOnly：唯讀執行個體。	ReadWrite
Status	string	執行個體狀態，詳情請參見執行個體狀態表。	Running
RightsSeparationStatus	string	三權分立狀態： disabled：未開啟； enabled：開啟； processing：處理中； unknown：未知，可能是執行個體無法連線導致。	disabled
DBNodeCount	integer	執行個體節點數量。	2
Expired	string	是否過期： true：過期； false：正常。	false
CreateTime	string	建立時間。	2021-08-31T08:56:25.000+0000
PayType	string	執行個體付費方式，取值： Postpaid：隨用隨付； Prepaid：包年包月。	Postpaid
Port	string	內網連線連接埠。	3306
LockMode	string	執行個體鎖定模式： Unlock：正常； ManualLock：手動觸發鎖定； LockByExpiration：執行個體過期自動鎖定； LockByRestoration：執行個體回復前的自動鎖定； LockByDiskQuota：執行個體空間滿自動鎖定； LockReadInstanceByDiskQuota：唯讀執行個體空間滿自動鎖定。	Unlock
Description	string	執行個體描述。	test instance
ConnectionString	string	內網連線資訊。	pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com
StorageUsed	integer	已經使用的儲存，單位為 B。	17042505728
ExpireDate	string	到期時間。格式為 yyyy-MM-ddTHH:mm:ss.sss+0000（UTC 時間）。	2022-08-31T16:00:00.000+0000
CommodityCode	string	執行個體商品種類，固定取值為 drds_polarxpost_public_cn。	drds_polarxpost_public_cn
MaintainStartTime	string	執行個體可維護開始時間，此處為 UTC 時間，加 8 小時才是主控台上顯示的可維護時間段。	06:00
DBInstanceType	string	執行個體類型： ReadWrite：主執行個體； ReadOnly：唯讀執行個體。	ReadWrite
DBNodeClass	string	執行個體節點規格。	polarx.x4.large.2e
LatestMinorVersion	string	目前執行個體支援的最新核心版本。	polarx-kernel_5.4.11-16301083_xcluster-20210805
MaintainEndTime	string	執行個體可維護結束時間，此處為 UTC 時間，加 8 小時為主控台上顯示的可維護時間段。	06:00
DBType	string	資料庫類型，固定取值為 polarx。	polarx
RightsSeparationEnabled	boolean	三權分立狀態： false：未開啟 true：開啟。	false
VPCId	string	VPC ID。	vpc-xxxxx
MinorVersion	string	目前核心版本。	polarx-kernel_5.4.11-16301083_xcluster-20210805
RegionId	string	執行個體所在地域。	cn-hangzhou
Network	string	執行個體的網路類型，僅支援取值 VPC，表示專有網路。	VPC
DBVersion	string	資料庫版本。	5.5
VSwitchId	string	交換器 ID。	vsw-********
ZoneId	string	執行個體所在可用區。	cn-hangzhou-a
Engine	string	資料庫類型，固定取值為 polarx。	polarx
KindCode	integer	執行個體引擎版本，內部參數。	18
Id	string	主執行個體的 ID，如果沒有返回此參數則表示該執行個體是主執行個體。	pxc-zkralxpc5d****
DBNodes	array<object>	資料庫節點資訊。
	object
ComputeNodeId	string	計算節點名稱。	pxc-i-********
NodeClass	string	節點規格。	polarx.x4.large.2e
DataNodeId	string	儲存節點名稱。	pxc-xdb-xxxxxx
ZoneId	string	節點所在可用區名稱。	cn-hangzhou-a
Id	string	邏輯節點 ID。	pxi-*********
RegionId	string	節點所在地域 ID。	cn-hangzhou
ConnAddrs	array<object>	連線位址資訊。
	object
Type	string	連線的種類，VPC 為內網連線，PUBLIC 為公網連線。	VPC
VSwitchId	string	交換器 ID。	vsw-*********
Port	integer	連線連接埠號。	3306
VPCId	string	VPC ID。	vpc-xxxxxx
ConnectionString	string	連線位址。	polardbx-xxx.aliyuncs.com
VpcInstanceId	string	VPC 內部 CloudInstanceId，可以忽略。	pxc-zkralxpc5d****
ReadDBInstances	array	唯讀執行個體名稱列表。
	string	唯讀執行個體名稱。	pxr-*********
ColumnarReadDBInstances	array	列存唯讀執行個體資訊。
	string	列存唯讀執行個體資訊。	xxx
ResourceGroupId	string	資源群組 ID。	rg-*********
TagSet	array<object>	標籤集合。
	object
Key	string	標籤名稱。	key2
Value	string	標籤值。	value2
CnNodeCount	integer	CN 節點數量。	2
DnNodeCount	integer	DN 節點數量。	2
CnNodeClassCode	string	CN 節點規格： polarx.x4.medium.2e：2 核 8G polarx.x4.large.2e：4 核 16G polarx.x8.large.2e：4 核 32G polarx.x4.xlarge.2e：8 核 32G polarx.x8.xlarge.2e：8 核 64G polarx.x4.2xlarge.2e：16 核 64G polarx.x8.2xlarge.2e：16 核 128G polarx.x4.4xlarge.2e：32 核 128G polarx.x8.4xlarge.2e：32 核 256G polarx.st.8xlarge.2e：60 核 470G polarx.st.12xlarge.2e：90 核 720G。	polarx.x4.xlarge.2e
DnNodeClassCode	string	DN 節點規格： mysql.n2.medium.25：2 核 4G mysql.n4.medium.25：2 核 8G mysql.x8.medium.25：2 核 16G mysql.n2.large.25：4 核 8G mysql.n4.large.25：4 核 16G mysql.x8.large.25：4 核 32G mysql.n2.xlarge.25：8 核 16G mysql.n4.xlarge.25：8 核 32G mysql.x8.xlarge.25：8 核 64G mysql.n4.2xlarge.25：16 核 64G mysql.x8.2xlarge.25：16 核 128G mysql.x4.4xlarge.25：32 核 128G mysql.x8.4xlarge.25：32 核 256G mysql.st.8xlarge.25：60 核 470G mysql.st.12xlarge.25：90 核 720G。	mysql.x8.large.25
Series	string	執行個體系列，取值如下： enterprise：企業版 standard：標準版。	enterprise
LTSVersions	array
	string	LTS 版本號。	X.X.X.X
TopologyType	string	拓撲類型： 3azones：三可用區； 1azone：單可用區。	3azones
PrimaryZone	string	主可用區。	cn-shenzhen-e
SecondaryZone	string	次可用區。	cn-shenzhen-a
TertiaryZone	string	第三可用區。	cn-shenzhen-e
DifferentDNSpec	boolean	執行個體的 DN 節點之間的規格是否相同，取值如下： true：規格不同 false：規格相同。	false
ColumnarInstanceName	string	列存引擎執行個體名稱。	xxxx
CanNotCreateColumnar	boolean	是否支援列存索引功能。	true
GdnInstanceName	string
GdnMemberList	array<object>
	object
Role	string
MemberName	string
Status	string
SpecCategory	string
GdnRole	string
PrimaryInstanceId	string
StorageType	string
CpuType	string
EngineVersion	string
DnStorageSpace	string	DN 資料節點磁碟空間大小，單位 GB。
AiGatewayEnabled	string

樣本

正常返回樣本

JSON格式

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "DBInstance": {
    "Type": "ReadWrite",
    "Status": "Running",
    "RightsSeparationStatus": "disabled",
    "DBNodeCount": 2,
    "Expired": "false",
    "CreateTime": "2021-08-31T08:56:25.000+0000",
    "PayType": "Postpaid",
    "Port": "3306",
    "LockMode": "Unlock",
    "Description": "test instance",
    "ConnectionString": "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
    "StorageUsed": 17042505728,
    "ExpireDate": "2022-08-31T16:00:00.000+0000",
    "CommodityCode": "drds_polarxpost_public_cn",
    "MaintainStartTime": "06:00",
    "DBInstanceType": "ReadWrite",
    "DBNodeClass": "polarx.x4.large.2e",
    "LatestMinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "MaintainEndTime": "06:00",
    "DBType": "polarx",
    "RightsSeparationEnabled": false,
    "VPCId": "vpc-xxxxx",
    "MinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
    "RegionId": "cn-hangzhou",
    "Network": "VPC",
    "DBVersion": "5.5",
    "VSwitchId": "vsw-********",
    "ZoneId": "cn-hangzhou-a",
    "Engine": "polarx",
    "KindCode": 18,
    "Id": "pxc-zkralxpc5d****",
    "DBNodes": [
      {
        "ComputeNodeId": "pxc-i-********",
        "NodeClass": "polarx.x4.large.2e",
        "DataNodeId": "pxc-xdb-xxxxxx",
        "ZoneId": "cn-hangzhou-a",
        "Id": "pxi-*********",
        "RegionId": "cn-hangzhou"
      }
    ],
    "ConnAddrs": [
      {
        "Type": "VPC",
        "VSwitchId": "vsw-*********",
        "Port": 3306,
        "VPCId": "vpc-xxxxxx",
        "ConnectionString": "polardbx-xxx.aliyuncs.com",
        "VpcInstanceId": "pxc-zkralxpc5d****"
      }
    ],
    "ReadDBInstances": [
      "pxr-*********"
    ],
    "ColumnarReadDBInstances": [
      "xxx"
    ],
    "ResourceGroupId": "rg-*********",
    "TagSet": [
      {
        "Key": "key2",
        "Value": "value2"
      }
    ],
    "CnNodeCount": 2,
    "DnNodeCount": 2,
    "CnNodeClassCode": "polarx.x4.xlarge.2e",
    "DnNodeClassCode": "mysql.x8.large.25",
    "Series": "enterprise",
    "LTSVersions": [
      "X.X.X.X"
    ],
    "TopologyType": "3azones",
    "PrimaryZone": "cn-shenzhen-e",
    "SecondaryZone": "cn-shenzhen-a",
    "TertiaryZone": "cn-shenzhen-e",
    "DifferentDNSpec": false,
    "ColumnarInstanceName": "xxxx",
    "CanNotCreateColumnar": true,
    "GdnInstanceName": "",
    "GdnMemberList": [
      {
        "Role": "",
        "MemberName": "",
        "Status": ""
      }
    ],
    "SpecCategory": "",
    "GdnRole": "",
    "PrimaryInstanceId": "",
    "StorageType": "",
    "CpuType": "",
    "EngineVersion": "",
    "DnStorageSpace": "",
    "AiGatewayEnabled": ""
  }
}

錯誤碼

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

變更歷史

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