DescribeInstances - ApsaraDB for HBase

請求參數

名稱	類型	是否必選	樣本值	描述
Action	String	是	DescribeInstances	系統規定參數，取值：DescribeInstances。
RegionId	String	否	cn-hangzhou	執行個體所屬的地區ID，可調用DescribeRegions介面擷取。說明調用本介面時，如果傳入了Tag.N.Key和Tag.N.Value參數，則本參數必須傳入。
PageNumber	Integer	否	1	執行個體列表的頁碼，起始值為1，預設值為1。
PageSize	Integer	否	10	每頁最多可顯示的行數，最大值為100，預設值為10。
DbType	String	否	hbase	服務類型，取值： hbase：HBase標準版或HBase單機版。 hbaseue：HBase增強版。 bds：表示BDS資料同步服務。
ClusterName	String	否	test	HBase執行個體名稱。
ClusterId	String	否	hb-bp1u0639js2h7****	目標執行個體ID，可調用DescribeInstances介面擷取。
ResourceGroupId	String	否	rg-4f51d54g5****	資源群組ID，可通過資源群組控制台查詢。
Tag.N.Key	String	否	key	標籤的鍵，與Tag Value組成標籤的索引值對，格式為{"key1":"value1","key2":"value2"}。
Tag.N.Value	String	否	value	標籤鍵的值，與Tag Key組成標籤的索引值對。

返回資料

名稱	類型	樣本值	描述
PageSize	Integer	10	每頁最多可顯示的行數。
RequestId	String	EBECBF12-2E34-41BE-8DE9-FC3700D4****	請求ID。
PageNumber	Integer	1	執行個體列表的頁碼。
TotalCount	Long	18	執行個體總個數。
Instances	Array of Instance		HBase執行個體列表資訊。
Instance
VpcId	String	vpc-bp120k6ixs4eoghz*****	專用網路ID，當NetworkType為2時會返回此參數。
Status	String	ACTIVATION	執行個體狀態，傳回值： CREATING：建立中。 ACTIVATION：運行中。 DELETING：刪除中。 RESTARTING：重啟中。 MINOR_VERSION_TRANSING：小版本升級中。
ModuleId	Integer	0	模組ID。
VswitchId	String	vsw-bp191ipotq****dbqf	虛擬交換器ID，當NetworkType為2時會返回此參數。
BackupStatus	String	open	表示是否支援備份功能，傳回值： open：支援備份功能。 close：不支援備份功能。
PayType	String	Prepaid	執行個體的計費類型，傳回值： Prepaid：訂用帳戶。 Postpaid：隨用隨付。
CoreDiskType	String	cloud_efficiency	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	2019-09-12T14:40:46Z	執行個體建立時間，UTC格式。
ParentId	String	2980****2123	父執行個體ID。
ExpireTimeUTC	String	2019-10-12T14:40:46Z	執行個體到期時間，UTC格式。
InstanceName	String	test	執行個體名稱。
MasterInstanceType	String	hbase.sn1.large	Master節點規格。
CoreInstanceType	String	hbase.sn1.large	Core節點規格。
CreatedTime	String	2019-09-12T14:40:46	執行個體建立時間。
CoreDiskSize	Integer	100	Core節點磁碟容量，預設單位G。
ClusterId	String	hb-bp1u0639js2h7****	執行個體ID。
ExpireTime	String	2019-10-12T14:40:46	執行個體到期時間。
IsHa	Boolean	true	執行個體是否配置為高可用，傳回值： true：配置為高可用。 false：未配置為高可用。說明叢集版預設配置為高可用，使用2個Master節點。單節點配置為實際可用容量。
InstanceId	String	hb-bp1u0639js2h7****	執行個體ID。
ColdStorageStatus	String	open	是否支援冷儲存功能，傳回值： open：支援冷儲存功能。 close：不支援冷儲存功能。
IsDeletionProtection	Boolean	true	是否開啟刪除保護，傳回值： true：已開啟。 false：未開啟。
RegionId	String	cn-hangzhou	執行個體所屬地區ID。
MasterDiskSize	Integer	100	Master節點的磁碟容量，預設單位G。
MasterDiskType	String	cloud_efficiency	Master節點的磁碟類型，傳回值： cloud_efficiency：高效雲端硬碟。 cloud_ssd：SSD雲端硬碟。說明單節點執行個體會返回此參數。
AutoRenewal	Boolean	false	執行個體是否自動續約，傳回值： true：自動續約。 false：手動續約。說明僅當執行個體的付費類型為訂用帳戶才會返回本參數。
ClusterType	String	cluster	執行個體類型，傳回值： cluster：叢集版。 single：單節點。
ResourceGroupId	String	rg-4f51d54g5****	資源群組ID。
ClusterName	String	test	執行個體名稱。
ZoneId	String	cn-hangzhou-f	可用性區域ID。
Duration	Integer	12	自動續約周期，傳回值：按月購買：則自動續約周期為1個月。按年購買：則自動續約周期為1年（12個月）。說明僅當執行個體的付費類型為訂用帳戶才會返回本參數。
ModuleStackVersion	String	1.0	模組類型版本。
Engine	String	hbase	資料引擎類型，傳回值： hbase：HBase標準版或HBase單機版。 hbaseue：HBase增強版。 serverlesshbase：HBaseServerless版。 bds：表示BDS執行個體。
MajorVersion	String	2.0	主要版本號。
CoreDiskCount	String	2	Core磁碟數量。
CoreNodeCount	Integer	2	Core節點個數。
Tags	Array of Tag		資源標籤。
Tag
Key	String	test-key	標籤鍵。
Value	String	test-value	標籤值。

樣本

請求樣本

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

正常返回樣本

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
}

錯誤碼

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