DescribeInstance
調(diào)用DescribeInstance查詢HBase實(shí)例的詳細(xì)信息。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DescribeInstance | 系統(tǒng)規(guī)定參數(shù),取值:DescribeInstance。 |
ClusterId | String | 是 | ld-bp150tns0sjxs**** | 實(shí)例ID,可調(diào)用DescribeInstances接口獲取。 |
返回?cái)?shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
VpcId | String | vpc-bp15s22y1a7sff5gj**** | 專有網(wǎng)絡(luò)ID,當(dāng)NetworkType為2時(shí)會返回此參數(shù)。 |
Status | String | ACTIVATION | 實(shí)例狀態(tài),返回值:
|
EncryptionType | String | NoEncryption | 加密類型,返回值:
說明 云盤加密開啟后無法關(guān)閉。 |
ModuleId | Integer | 0 | 模塊ID。 |
VswitchId | String | vsw-bp1foll427ze3d4ps**** | 虛擬交換機(jī)ID,當(dāng)NetworkType為2時(shí)會返回此參數(shù)。 |
BackupStatus | String | open | 表示是否支持備份功能,返回值:
|
PayType | String | Prepaid | 實(shí)例的計(jì)費(fèi)類型,返回值:
|
CoreDiskType | String | cloud_ssd | Core節(jié)點(diǎn)磁盤類型,返回值:
|
MasterNodeCount | Integer | 2 | 表示Master節(jié)點(diǎn)類型,返回值:
|
NetworkType | String | VPC | 網(wǎng)絡(luò)類型,返回值:
|
CreatedTimeUTC | String | 2021-07-19T03:23:22Z | 實(shí)例創(chuàng)建時(shí)間,UTC格式。 |
ColdStorageSize | Integer | 800 | 冷存儲空間大小,單位為GB。 |
ParentId | String | ld-uf699153o1m2l**** | 父實(shí)例ID。 |
IsLatestVersion | Boolean | true | 實(shí)例是否為最新版本,返回值:
|
ExpireTimeUTC | String | 2022-02-23T16:00:00Z | 實(shí)例到期時(shí)間,UTC格式。 |
RequestId | String | 3F429923-B6F6-52C5-9C2A-5B8A8C6BBA66 | 請求ID。 |
InstanceName | String | testhbase | 實(shí)例名稱。 |
MasterInstanceType | String | hbase.sn2.large | Master節(jié)點(diǎn)規(guī)格。 |
CoreInstanceType | String | hbase.sn2.2xlarge | Core節(jié)點(diǎn)規(guī)格。 |
EncryptionKey | String | 0d2470df-da7b-4786-b981-9a164dae**** | 加密的密鑰。 說明 加密類型為CloudDisk時(shí)返回此參數(shù)。 |
CreatedTime | String | 2021-07-19T11:23:22 | 實(shí)例創(chuàng)建時(shí)間。 |
CoreDiskSize | Integer | 100 | Core節(jié)點(diǎn)磁盤容量,單位為GB。 |
ClusterId | String | ld-bp150tns0sjxs**** | 實(shí)例ID。 |
ExpireTime | String | 2022-02-24T00:00:00 | 實(shí)例到期時(shí)間。 |
MaintainStartTime | String | 18:00Z | 實(shí)例運(yùn)維開始時(shí)間。 |
ConfirmMaintainTime | String | true | 是否首次確認(rèn)實(shí)例的運(yùn)維時(shí)間,返回值:
說明 僅首次進(jìn)入實(shí)例的基本信息頁面會彈出首次確認(rèn)實(shí)例的運(yùn)維時(shí)間對話框。 |
IsHa | Boolean | true | 實(shí)例是否配置為高可用,返回值:
說明
|
MaintainEndTime | String | 22:00Z | 實(shí)例運(yùn)維結(jié)束時(shí)間。 |
InstanceId | String | ld-bp150tns0sjxs**** | 實(shí)例ID。 |
ColdStorageStatus | String | open | 是否支持冷存儲功能,返回值:
|
IsDeletionProtection | Boolean | false | 是否開啟刪除保護(hù),返回值:
|
MinorVersion | String | 2.2.9.1 | 實(shí)例的小版本號。 |
RegionId | String | cn-hangzhou | 實(shí)例所屬地域的ID。 |
MasterDiskSize | Integer | 0 | Master節(jié)點(diǎn)的磁盤容量,單位為GB。 |
MasterDiskType | String | cloud_efficiency | Master節(jié)點(diǎn)的磁盤類型,返回值:
說明 單節(jié)點(diǎn)實(shí)例會返回此參數(shù)。 |
NeedUpgrade | Boolean | false | 表示是否需要升級實(shí)例的組件,返回值:
|
IsMultiModel | Boolean | true | 實(shí)例是否為多模集群版,返回值:
|
AutoRenewal | Boolean | false | 實(shí)例是否自動續(xù)費(fèi),返回值:
說明 僅當(dāng)PayType取值為Prepaid(包年包月)時(shí),此參數(shù)有返回值。 |
ClusterType | String | cluster | 實(shí)例類型,返回值:
|
ResourceGroupId | String | rg-acfmyiu4ekp**** | 資源組ID。 |
ClusterName | String | testhbase | 實(shí)例名稱。 |
ZoneId | String | cn-hangzhou-f | 可用區(qū)ID。 |
Duration | Integer | 12 | 自動續(xù)費(fèi)周期。
說明 僅當(dāng)PayType取值為Prepaid(包年包月)時(shí),此參數(shù)有返回值。 |
ModuleStackVersion | String | phoenxi:4.0 | 模塊類型版本。 |
Engine | String | hbaseue | 數(shù)據(jù)引擎類型。
|
MajorVersion | String | 2.0 | 主版本號。 |
CoreDiskCount | String | 4 | Core磁盤數(shù)量。 |
TaskProgress | String | 25.00 | 實(shí)例的任務(wù)運(yùn)行進(jìn)度,單位為百分比(%)。通過云數(shù)據(jù)庫HBase控制臺發(fā)起的任務(wù),包括變更規(guī)格、擴(kuò)容節(jié)點(diǎn)、縮容節(jié)點(diǎn)、重啟實(shí)例,小版本升級等。 |
CoreNodeCount | Integer | 2 | Core節(jié)點(diǎn)個(gè)數(shù)。 |
EnableHbaseProxy | Boolean | false | 是否支持HBase開源客戶端訪問,返回值:
|
LproxyMinorVersion | String | 2.3.2 | LPROXY服務(wù)的最小版本。 |
NeedUpgradeComps | Array of String | [lindorm, hdfs] | 需要升級的組件名稱。 說明 當(dāng)NeedUpgrade參數(shù)返回true時(shí),則返回此參數(shù)。 |
Tags | Array of Tag | 資源標(biāo)簽。 |
|
Tag | |||
Key | String | test_key | 標(biāo)簽Key值。 |
Value | String | test_value | 標(biāo)簽Value值。 |
示例
請求示例
http(s)://hbase.aliyuncs.com/?Action=DescribeInstance
&ClusterId=ld-bp150tns0sjxs****
&<公共請求參數(shù)>
正常返回示例
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
}
錯(cuò)誤碼
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。