全部產品
Search

搜尋本產品

    ApsaraDB for HBase：DescribeInstance

    文件中心

    ApsaraDB for HBase：DescribeInstance

    更新時間：Mar 04, 2025

    調用DescribeInstance查詢HBase執行個體的詳細資料。

    請求參數

    名稱

    類型

    是否必選

    樣本值

    描述
    Action String 是 DescribeInstance

    系統規定參數，取值：DescribeInstance。
    ClusterId String 是 ld-bp150tns0sjxs****

    執行個體ID，可調用DescribeInstances介面擷取。

    返回資料

    名稱

    類型

    樣本值

    描述
    VpcId String vpc-bp15s22y1a7sff5gj****

    專用網路ID，當NetworkType為2時會返回此參數。
    Status String ACTIVATION

    執行個體狀態，傳回值：

    • CREATING：建立中。
    • ACTIVATION：運行中。
    • DELETING：刪除中。
    • RESTARTING：重啟中。
    • MINOR_VERSION_TRANSING：小版本升級中。
    EncryptionType String NoEncryption

    加密類型，傳回值：

    • NoEncryption：不啟用加密。
    • CloudDisk：雲端硬碟加密並返回。
    • EncryptionKey：參數指定加密的密鑰。
    說明 雲端硬碟加密開啟後無法關閉。
    ModuleId Integer 0

    模組ID。
    VswitchId String vsw-bp1foll427ze3d4ps****

    虛擬交換器ID，當NetworkType為2時會返回此參數。
    BackupStatus String open

    表示是否支援備份功能，傳回值：

    • open：支援備份功能。
    • close：不支援備份功能。
    PayType String Prepaid

    執行個體的計費類型，傳回值：

    • Prepaid：訂用帳戶。
    • Postpaid：隨用隨付。
    CoreDiskType String cloud_ssd

    Core節點磁碟類型，傳回值：

    • cloud_efficiency：高效雲端硬碟。
    • cloud_ssd：SSD雲端硬碟。
    • local_hdd：本地HDD盤。
    • local__ssd：本地SSD盤。
    MasterNodeCount Integer 2

    表示Master節點類型，傳回值：

    • 0表示Master節點為單節點。
    • 2表示Master節點為叢集版。
    NetworkType String VPC

    網路類型，傳回值：

    • VPC：專用網路類型，如果為專用網路，則返回VswitchId和VpcId參數。
    • CLASSIC：傳統網路類型。
    CreatedTimeUTC String 2021-07-19T03:23:22Z

    執行個體建立時間，UTC格式。
    ColdStorageSize Integer 800

    冷儲存空間大小，單位為GB。
    ParentId String ld-uf699153o1m2l****

    父執行個體ID。
    IsLatestVersion Boolean true

    執行個體是否為最新版本，傳回值：

    • true：最新版本。
    • false：不是最新版本。
    ExpireTimeUTC String 2022-02-23T16:00:00Z

    執行個體到期時間，UTC格式。
    RequestId String 3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66

    請求ID。
    InstanceName String testhbase

    執行個體名稱。
    MasterInstanceType String hbase.sn2.large

    Master節點規格。
    CoreInstanceType String hbase.sn2.2xlarge

    Core節點規格。
    EncryptionKey String 0d2470df-da7b-4786-b981-9a164dae****

    加密的密鑰。

    說明 加密類型為CloudDisk時返回此參數。
    CreatedTime String 2021-07-19T11:23:22

    執行個體建立時間。
    CoreDiskSize Integer 100

    Core節點磁碟容量，單位為GB。
    ClusterId String ld-bp150tns0sjxs****

    執行個體ID。
    ExpireTime String 2022-02-24T00:00:00

    執行個體到期時間。
    MaintainStartTime String 18:00Z

    執行個體營運開始時間。
    ConfirmMaintainTime String true

    是否首次確認執行個體的營運時間，傳回值：

    • true：已確認。
    • false：未確認。
    說明 僅首次進入執行個體的基本資料頁面會彈出首次確認執行個體的營運時間對話方塊。
    IsHa Boolean true

    執行個體是否配置為高可用，傳回值：

    • true：配置為高可用。
    • false：未配置為高可用。
    說明
    • 叢集版預設配置為高可用，使用2個Master節點。
    • 單節點配置為實際可用容量。
    MaintainEndTime String 22:00Z

    執行個體營運結束時間。
    InstanceId String ld-bp150tns0sjxs****

    執行個體ID。
    ColdStorageStatus String open

    是否支援冷儲存功能，傳回值：

    • open：支援冷儲存功能。
    • close：不支援冷儲存功能。
    IsDeletionProtection Boolean false

    是否開啟刪除保護，傳回值：

    • true：開啟。
    • false：未開啟。
    MinorVersion String 2.2.9.1

    執行個體的小版本號碼。
    RegionId String cn-hangzhou

    執行個體所屬地區的ID。
    MasterDiskSize Integer 0

    Master節點的磁碟容量，單位為GB。
    MasterDiskType String cloud_efficiency

    Master節點的磁碟類型，傳回值：

    • cloud_efficiency：高效雲端硬碟。
    • cloud_ssd：SSD雲端硬碟。
    說明 單節點執行個體會返回此參數。
    NeedUpgrade Boolean false

    表示是否需要升級執行個體的組件，傳回值：

    • true：升級。
    • false：不升級。
    IsMultiModel Boolean true

    執行個體是否為多模叢集版，傳回值：

    • true：是多模叢集版。
    • false：不是多模叢集版。
    AutoRenewal Boolean false

    執行個體是否自動續約，傳回值：

    • true：自動續約。
    • false：不自動續約。
    說明 僅當PayType取值為Prepaid（訂用帳戶）時，此參數有傳回值。
    ClusterType String cluster

    執行個體類型，傳回值：

    • cluster：叢集版。
    • single：單節點。
    ResourceGroupId String rg-acfmyiu4ekp****

    資源群組ID。
    ClusterName String testhbase

    執行個體名稱。
    ZoneId String cn-hangzhou-f

    可用性區域ID。
    Duration Integer 12

    自動續約周期。

    • 按月購買：自動續約周期為1個月。
    • 按年購買：自動續約周期為1年（12個月）。
    說明 僅當PayType取值為Prepaid（訂用帳戶）時，此參數有傳回值。
    ModuleStackVersion String phoenxi:4.0

    模組類型版本。
    Engine String hbaseue

    資料引擎類型。

    • hbase：HBase標準版或HBase單機版。
    • hbaseue：HBase增強版。
    • serverlesshbase：HBaseServerless版。
    • bds：BDS執行個體。
    MajorVersion String 2.0

    主要版本號。
    CoreDiskCount String 4

    Core磁碟數量。
    TaskProgress String 25.00

    執行個體的任務運行進度，單位為百分比（%）。通過ApsaraDB for HBase控制台發起的任務，包括變更規格、擴容節點、縮容節點、重啟執行個體，小版本升級等。
    CoreNodeCount Integer 2

    Core節點個數。
    EnableHbaseProxy Boolean false

    是否支援HBase開源用戶端訪問，傳回值：

    • true：支援訪問。
    • false：不支援訪問。
    LproxyMinorVersion String 2.3.2

    LPROXY服務的最小版本。
    NeedUpgradeComps Array of String [lindorm, hdfs]

    需要升級的組件名稱。

    說明 當NeedUpgrade參數返回true時，則返回此參數。
    Tags Array of Tag

    資源標籤。
    Tag
    Key String test_key

    標籤Key值。
    Value String test_value

    標籤Value值。

    樣本

    請求樣本

    http(s)://hbase.aliyuncs.com/?Action=DescribeInstance
&ClusterId=ld-bp150tns0sjxs****
&<公用請求參數>

    正常返回樣本

    XML格式

    HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeInstanceResponse>
<CreatedTime>2021-07-19T11:23:22</CreatedTime>
<ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
<NeedUpgrade>false</NeedUpgrade>
<ModuleId>0</ModuleId>
<Engine>hbaseue</Engine>
<NeedUpgradeComps>
</NeedUpgradeComps>
<Tags>
</Tags>
<Status>ACTIVATION</Status>
<ColdStorageSize>800</ColdStorageSize>
<EncryptionType>NoEncryption</EncryptionType>
<MasterDiskSize>0</MasterDiskSize>
<ExpireTimeUTC>2022-02-23T16:00:00Z</ExpireTimeUTC>
<RequestId>3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66</RequestId>
<InstanceId>ld-bp150tns0sjxs****</InstanceId>
<PayType>Prepaid</PayType>
<VswitchId>vsw-bp1foll427ze3d4ps****</VswitchId>
<InstanceName>testhbase</InstanceName>
<MasterNodeCount>2</MasterNodeCount>
<VpcId>vpc-bp15s22y1a7sff5gj****</VpcId>
<AutoRenewal>false</AutoRenewal>
<CoreDiskType>cloud_ssd</CoreDiskType>
<ExpireTime>2022-02-24T00:00:00</ExpireTime>
<BackupStatus>open</BackupStatus>
<IsHa>true</IsHa>
<TaskProgress>25.00</TaskProgress>
<MasterInstanceType>hbase.sn1.2xlarge</MasterInstanceType>
<IsDeletionProtection>false</IsDeletionProtection>
<IsLatestVersion>true</IsLatestVersion>
<MaintainEndTime>22:00Z</MaintainEndTime>
<NetworkType>VPC</NetworkType>
<CoreInstanceType>hbase.sn2.2xlarge</CoreInstanceType>
<ClusterName>testhbase</ClusterName>
<MasterDiskType/>
<MaintainStartTime>18:00Z</MaintainStartTime>
<MajorVersion>2.0</MajorVersion>
<CoreDiskCount>4</CoreDiskCount>
<ZoneId>cn-hangzhou-f</ZoneId>
<CoreNodeCount>2</CoreNodeCount>
<ClusterId>ld-bp150tns0sjxs****</ClusterId>
<ColdStorageStatus>open</ColdStorageStatus>
<MinorVersion>2.2.9.1</MinorVersion>
<CreatedTimeUTC>2021-07-19T03:23:22Z</CreatedTimeUTC>
<IsMultiModel>true</IsMultiModel>
<ClusterType>cluster</ClusterType>
<RegionId>cn-hangzhou</RegionId>
<CoreDiskSize>100</CoreDiskSize>
<ConfirmMaintainTime>true</ConfirmMaintainTime>
</DescribeInstanceResponse>

    JSON格式

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "CreatedTime" : "2021-07-19T11:23:22",
  "ResourceGroupId" : "rg-acfmyiu4ekp****",
  "NeedUpgrade" : false,
  "ModuleId" : 0,
  "Engine" : "hbaseue",
  "NeedUpgradeComps" : {
    "Comps" : [ ]
  },
  "Tags" : {
    "Tag" : [ ]
  },
  "Status" : "ACTIVATION",
  "ColdStorageSize" : 800,
  "EncryptionType" : "NoEncryption",
  "MasterDiskSize" : 0,
  "ExpireTimeUTC" : "2022-02-23T16:00:00Z",
  "RequestId" : "3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66",
  "InstanceId" : "ld-bp150tns0sjxs****",
  "PayType" : "Prepaid",
  "VswitchId" : "vsw-bp1foll427ze3d4ps****",
  "InstanceName" : "testhbase",
  "MasterNodeCount" : 2,
  "VpcId" : "vpc-bp15s22y1a7sff5gj****",
  "AutoRenewal" : false,
  "CoreDiskType" : "cloud_ssd",
  "ExpireTime" : "2022-02-24T00:00:00",
  "BackupStatus" : "open",
  "IsHa" : true,
  "TaskProgress" : "25.00",
  "MasterInstanceType" : "hbase.sn1.2xlarge",
  "IsDeletionProtection" : false,
  "IsLatestVersion" : true,
  "MaintainEndTime" : "22:00Z",
  "NetworkType" : "VPC",
  "CoreInstanceType" : "hbase.sn2.2xlarge",
  "ClusterName" : "testhbase",
  "MasterDiskType" : "",
  "MaintainStartTime" : "18:00Z",
  "MajorVersion" : "2.0",
  "CoreDiskCount" : 4,
  "ZoneId" : "cn-hangzhou-f",
  "CoreNodeCount" : 2,
  "ClusterId" : "ld-bp150tns0sjxs****",
  "ColdStorageStatus" : "open",
  "MinorVersion" : "2.2.9.1",
  "CreatedTimeUTC" : "2021-07-19T03:23:22Z",
  "IsMultiModel" : true,
  "ClusterType" : "cluster",
  "RegionId" : "cn-hangzhou",
  "ConfirmMaintainTime" : true,
  "CoreDiskSize" : 100
}

    錯誤碼

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