調(diào)用DescribeInstances查詢指定地域的HBase實例列表信息。

調(diào)試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求參數(shù)

名稱 類型 是否必選 示例值 描述
Action String 是 DescribeInstances

系統(tǒng)規(guī)定參數(shù)，取值：DescribeInstances。

RegionId String 否 cn-hangzhou

實例所屬的地域ID，可調(diào)用DescribeRegions接口獲取。

說明 調(diào)用本接口時，如果傳入了Tag.N.Key和Tag.N.Value參數(shù)，則本參數(shù)必須傳入。
PageNumber Integer 否 1

實例列表的頁碼，起始值為1，默認值為1。

PageSize Integer 否 10

每頁最多可顯示的行數(shù)，最大值為100，默認值為10。

DbType String 否 hbase

服務(wù)類型，取值：

  • hbase：HBase標(biāo)準(zhǔn)版或HBase單機版。
  • hbaseue：HBase增強版。
  • bds：表示BDS數(shù)據(jù)同步服務(wù)。
ClusterName String 否 test

HBase實例名稱。
ClusterId String 否 hb-bp1u0639js2h7****

目標(biāo)實例ID，可調(diào)用DescribeInstances接口獲取。

ResourceGroupId String 否 rg-4f51d54g5****

資源組ID，可通過資源組控制臺查詢。
Tag.N.Key String 否 key

標(biāo)簽的鍵，與Tag Value組成標(biāo)簽的鍵值對，格式為{"key1":"value1","key2":"value2"}。
Tag.N.Value String 否 value

標(biāo)簽鍵的值，與Tag Key組成標(biāo)簽的鍵值對。

返回數(shù)據(jù)

名稱 類型 示例值 描述
PageSize Integer 10

每頁最多可顯示的行數(shù)。
RequestId String EBECBF12-2E34-41BE-8DE9-FC3700D4****

請求ID。
PageNumber Integer 1

實例列表的頁碼。
TotalCount Long 18

實例總個數(shù)。
Instances Array of Instance

HBase實例列表信息。
Instance
VpcId String vpc-bp120k6ixs4eoghz*****

專有網(wǎng)絡(luò)ID，當(dāng)NetworkType為2時會返回此參數(shù)。

Status String ACTIVATION

實例狀態(tài)，返回值：

  • CREATING：創(chuàng)建中。
  • ACTIVATION：運行中。
  • DELETING：刪除中。
  • RESTARTING：重啟中。
  • MINOR_VERSION_TRANSING：小版本升級中。
ModuleId Integer 0

模塊ID。
VswitchId String vsw-bp191ipotq****dbqf

虛擬交換機ID，當(dāng)NetworkType為2時會返回此參數(shù)。

BackupStatus String open

表示是否支持備份功能，返回值：

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

實例的計費類型，返回值：

  • Prepaid：包年包月。
  • Postpaid：按量付費。
CoreDiskType String cloud_efficiency

Core節(jié)點磁盤類型，返回值：

  • cloud_efficiency：高效云盤。
  • cloud_ssd：SSD云盤。
  • local_hdd：本地HDD盤。
  • local__ssd：本地SSD盤。
MasterNodeCount Integer 2

表示Master節(jié)點類型，返回值：

  • 0表示Master節(jié)點為單節(jié)點。
  • 2表示Master節(jié)點為集群版。
NetworkType String VPC

網(wǎng)絡(luò)類型，返回值：

  • VPC：專有網(wǎng)絡(luò)類型，如果為專有網(wǎng)絡(luò)，就會返回VswitchId和VpcId參數(shù)。
  • CLASSIC：經(jīng)典網(wǎng)絡(luò)類型。
CreatedTimeUTC String 2019-09-12T14:40:46Z

實例創(chuàng)建時間，UTC格式。
ParentId String 2980****2123

父實例ID。
ExpireTimeUTC String 2019-10-12T14:40:46Z

實例到期時間，UTC格式。
InstanceName String test

實例名稱。
MasterInstanceType String hbase.sn1.large

Master節(jié)點規(guī)格。
CoreInstanceType String hbase.sn1.large

Core節(jié)點規(guī)格。
CreatedTime String 2019-09-12T14:40:46

實例創(chuàng)建時間。
CoreDiskSize Integer 100

Core節(jié)點磁盤容量，默認單位G。
ClusterId String hb-bp1u0639js2h7****

實例ID。
ExpireTime String 2019-10-12T14:40:46

實例到期時間。
IsHa Boolean true

實例是否配置為高可用，返回值：

  • true：配置為高可用。
  • false：未配置為高可用。
說明 集群版默認配置為高可用，使用2個Master節(jié)點。單節(jié)點配置為實際可用容量。
InstanceId String hb-bp1u0639js2h7****

實例ID。
ColdStorageStatus String open

是否支持冷存儲功能，返回值：

  • open：支持冷存儲功能。
  • close：不支持冷存儲功能。
IsDeletionProtection Boolean true

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

  • true：已開啟。
  • false：未開啟。
RegionId String cn-hangzhou

實例所屬地域ID。
MasterDiskSize Integer 100

Master節(jié)點的磁盤容量，默認單位G。
MasterDiskType String cloud_efficiency

Master節(jié)點的磁盤類型，返回值：

  • cloud_efficiency：高效云盤。
  • cloud_ssd：SSD云盤。
說明 單節(jié)點實例會返回此參數(shù)。
AutoRenewal Boolean false

實例是否自動續(xù)費，返回值：

  • true：自動續(xù)費。
  • false：手動續(xù)費。
說明 僅當(dāng)實例的付費類型為包年包月才會返回本參數(shù)。
ClusterType String cluster

實例類型，返回值：

  • cluster：集群版。
  • single：單節(jié)點。
ResourceGroupId String rg-4f51d54g5****

資源組ID。
ClusterName String test

實例名稱。
ZoneId String cn-hangzhou-f

可用區(qū)ID。
Duration Integer 12

自動續(xù)費周期，返回值：

  • 按月購買：則自動續(xù)費周期為1個月。
  • 按年購買：則自動續(xù)費周期為1年（12個月）。
說明 僅當(dāng)實例的付費類型為包年包月才會返回本參數(shù)。
ModuleStackVersion String 1.0

模塊類型版本。
Engine String hbase

數(shù)據(jù)引擎類型，返回值：

  • hbase：HBase標(biāo)準(zhǔn)版或HBase單機版。
  • hbaseue：HBase增強版。
  • serverlesshbase：HBaseServerless版。
  • bds：表示BDS實例。
MajorVersion String 2.0

主版本號。
CoreDiskCount String 2

Core磁盤數(shù)量。
CoreNodeCount Integer 2

Core節(jié)點個數(shù)。
Tags Array of Tag

資源標(biāo)簽。
Tag
Key String test-key

標(biāo)簽鍵。
Value String test-value

標(biāo)簽值。

示例

請求示例

http(s)://hbase.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&ClusterId=hb-bp1u0639js2h7****
&<公共請求參數(shù)>

正常返回示例

XML格式 

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

<DescribeInstancesResponse>
<Instances>
    <Instance>
        <ModuleStackVersion>1.0</ModuleStackVersion>
        <IsHa>true</IsHa>
        <CreatedTime>2019-09-12T14:40:46</CreatedTime>
        <ResourceGroupId>rg-4f51d54g5****</ResourceGroupId>
        <MasterInstanceType>hbase.sn1.large</MasterInstanceType>
        <IsDeletionProtection>true</IsDeletionProtection>
        <ModuleId>0</ModuleId>
        <NetworkType>VPC</NetworkType>
        <CoreInstanceType>hbase.sn1.large</CoreInstanceType>
        <ClusterName>test</ClusterName>
        <MasterDiskType>cloud_efficiency</MasterDiskType>
        <Engine>hbase</Engine>
        <CoreDiskCount>2</CoreDiskCount>
        <ParentId>2980****2123</ParentId>
        <MajorVersion>2.0</MajorVersion>
        <Status>ACTIVATION</Status>
        <ExpireTimeUTC>2019-10-12T14:40:46Z</ExpireTimeUTC>
        <MasterDiskSize>100</MasterDiskSize>
        <ZoneId>cn-hangzhou-f</ZoneId>
        <ClusterId>hb-bp1u0639js2h7****</ClusterId>
        <CoreNodeCount>2</CoreNodeCount>
        <InstanceId>hb-bp1u0639js2h7****</InstanceId>
        <ColdStorageStatus>open</ColdStorageStatus>
        <CreatedTimeUTC>2019-09-12T14:40:46Z</CreatedTimeUTC>
        <Duration>12</Duration>
        <ClusterType>cluster</ClusterType>
        <PayType>Prepaid</PayType>
        <VswitchId>vsw-bp191ipotq****dbqf</VswitchId>
        <MasterNodeCount>2</MasterNodeCount>
        <InstanceName>test</InstanceName>
        <AutoRenewal>false</AutoRenewal>
        <VpcId>vpc-bp120k6ixs4eoghz****</VpcId>
        <CoreDiskType>cloud_efficiency</CoreDiskType>
        <RegionId>cn-hangzhou</RegionId>
        <ExpireTime>2019-10-12T14:40:46</ExpireTime>
        <BackupStatus>open</BackupStatus>
        <CoreDiskSize>100</CoreDiskSize>
    </Instance>
    <Instance>
        <Tags>
            <Tag>
                <Value>test-value</Value>
                <Key>test-key</Key>
            </Tag>
        </Tags>
    </Instance>
</Instances>
<TotalCount>18</TotalCount>
<PageSize>10</PageSize>
<RequestId>EBECBF12-2E34-41BE-8DE9-FC3700D4****</RequestId>
<PageNumber>1</PageNumber>
</DescribeInstancesResponse>

JSON格式 

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

{
  "Instances" : {
    "Instance" : [ {
      "ModuleStackVersion" : 1,
      "IsHa" : true,
      "CreatedTime" : "2019-09-12T14:40:46",
      "ResourceGroupId" : "rg-4f51d54g5****",
      "MasterInstanceType" : "hbase.sn1.large",
      "IsDeletionProtection" : true,
      "ModuleId" : 0,
      "NetworkType" : "VPC",
      "CoreInstanceType" : "hbase.sn1.large",
      "ClusterName" : "test",
      "MasterDiskType" : "cloud_efficiency",
      "Engine" : "hbase",
      "CoreDiskCount" : 2,
      "ParentId" : "2980****2123",
      "MajorVersion" : 2,
      "Status" : "ACTIVATION",
      "ExpireTimeUTC" : "2019-10-12T14:40:46Z",
      "MasterDiskSize" : 100,
      "ZoneId" : "cn-hangzhou-f",
      "ClusterId" : "hb-bp1u0639js2h7****",
      "CoreNodeCount" : 2,
      "InstanceId" : "hb-bp1u0639js2h7****",
      "ColdStorageStatus" : "open",
      "CreatedTimeUTC" : "2019-09-12T14:40:46Z",
      "Duration" : 12,
      "ClusterType" : "cluster",
      "PayType" : "Prepaid",
      "VswitchId" : "vsw-bp191ipotq****dbqf",
      "MasterNodeCount" : 2,
      "InstanceName" : "test",
      "AutoRenewal" : false,
      "VpcId" : "vpc-bp120k6ixs4eoghz****",
      "CoreDiskType" : "cloud_efficiency",
      "RegionId" : "cn-hangzhou",
      "ExpireTime" : "2019-10-12T14:40:46",
      "BackupStatus" : "open",
      "CoreDiskSize" : 100
    }, {
      "Tags" : {
        "Tag" : {
          "Value" : "test-value",
          "Key" : "test-key"
        }
      }
    } ]
  },
  "TotalCount" : 18,
  "PageSize" : 10,
  "RequestId" : "EBECBF12-2E34-41BE-8DE9-FC3700D4****",
  "PageNumber" : 1
}

錯誤碼

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