You need to enable JavaScript to run this app.
文档中心
表格数据库 HBase 版

表格数据库 HBase 版

复制全文
下载 pdf
实例管理
DescribeDBInstanceDetail
复制全文
下载 pdf
DescribeDBInstanceDetail
调用 DescribeDBInstanceDetail 接口查询指定实例的详细信息。​
请求类型​
同步请求。​
请求参数​
​
参数​
类型​
是否必选​
示例值​
描述​
InstanceId​
String​
是​
hb-cn019f341d51****​
实例 ID。​
说明​
您可以调用 DescribeDBInstances 接口查询目标地域下所有 HBase 实例的基本信息,包括实例 ID。​
​
返回参数​
​
参数​
类型​
示例值​
描述​
ChargeType​
String​
PostPaid​
计费类型,取值:​
  • PostPaid:按量计费(后付费)。​
  • PrePaid:包年包月(预付费)。​
ColdStorage​
Long​
800​
实例总容量型存储空间大小,单位 GiB。​
CreateTime​
String​
2022-11-07T07:17:55Z​
实例创建时间(UTC 时间)。​
DBInstanceEndpoint​
请参见返回示例。​
连接地址信息列表。​
DeletionProtection​
String​
enabled​
实例删除保护功能开关状态。取值范围:​
  • enabled:已开启。​
  • disabled:未开启。​
说明​
关于实例删除保护的更多信息,请参见实例删除保护。​
EngineVersion​
String​
HBase_2.0​
HBase 数据库版本。当前仅支持 HBase 2.0 版本。​
InstanceId​
String​
hb-cnglbbb73ea0****​
实例 ID。​
InstanceName​
String​
test_api​
实例名称。​
InstanceType​
String​
Standard​
实例类型,当前仅支持 Standard标准版。​
MasterCount​
Integer​
2​
Master 节点个数。​
MasterSpec​
String​
hbase.x1.4xlarge​
Master 节点的规格码。​
ProjectName​
String​
default​
实例所属的项目名称。​
RSCount​
Integer​
2​
RegionServer 节点的数量。​
RSSpec​
String​
hbase.x1.4xlarge​
RegionServer 节点的规格码。​
RegionId​
String​
cn-beijing​
实例所属的地域 ID。​
Status​
String​
Running​
实例当前状态。关于实例状态的更多说明,请参见实例状态说明。​
StorageType​
String​
HdfsHdd​
实例的存储类型,取值:​
  • HdfsHdd:HDD 文件存储。​
  • HdfsSsd:SSD 文件存储。​
StorageCapacity​
Integer​
500​
实例总存储容量,单位:GiB。​
SubnetId​
String​
subnet-2d6pl8bcpl2io58ozfd43****​
实例所属的子网 ID。​
UsedColdStorage​
Long​
500​
实例已使用的容量型存储空间大小,单位 MiB。​
UsedStorage​
Double​
0​
实例已使用的存储容量,单位:MiB。​
VpcId​
String​
vpc-rs5811nceqyov0x58x4****​
实例所属的私有网络 ID。​
VpcName​
String​
test_vpc​
实例所属的私有网络名称。​
ZoneId​
String​
cn-beijing-a​
实例所属的可用区 ID。​
ZoneName​
String​
可用区A​
实例所属的可用区名称。​
Tags​
Array of Tag​
请参见返回示例。​
实例绑定的标签键和标签值数组对象。​
ChargeStatus​
String​
Normal​
计费状态。取值:​
  • Normal:正常。​
  • Overdue:欠费。​
  • Shutdown:关停。​
AutoRenew​
Boolean​
false​
预付费场景下是否自动续费。取值:​
  • true:自动续费。​
  • false:不自动续费。​
PrivateDNSVisibility​
Boolean​
false​
私网域名是否开启公网解析。​
EnableSearchIndex​
Boolean​
false​
实例是否开通多元索引功能。取值:​
  • true:已开通。​
  • false:未开通。​
EsInstanceId​
String​
o-00g0sqic****​
已开通多元索引功能所关联的 ES 实例 ID。​
RelationId​
String​
ha-cnglbbaaa1ba****​
主备实例的关联 ID。​
DDLDisabled​
Boolean​
false​
DDL禁止状态。取值:​
  • true:已开启。​
  • false:未开启。​
MaintenanceWindow​
Object of MaintenanceWindow​
请参见返回示例。​
实例的可维护时间窗口信息。​
​
DBInstanceEndpointObject​
​
参数​
类型​
示例值​
描述​
AddressType​
String​
Zk​
连接地址类型,关于连接地址的更多信息,请参见连接地址类型。取值范围如下:​
  • Zk:ZK 地址。​
  • Thrift:Thrift2 地址。​
  • HBaseReUsedEipId:当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示实例中其他组件(如 RS 节点、Master 节点等)共享绑定使用的 EIP ID 信息。​
EndpointId​
String​
hb-cngla853d1ba****-zk-Private​
连接地址 ID。​
说明​
  • 默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的 ID。​
  • 当连接地址类型为 HBaseReUsedEipId 时,连接地址 ID 也固定为 HBaseReUsedEipId。​
EndpointStr​
String​
hb-cnglbbb73ea0****-zk.config.ivolces.com:2181​
连接地址的连接串。​
说明​
  • 默认仅返回 ZK 私网连接地址。若您申请了 Thrift2 连接地址,或者为 ZK 或 Thrift2 连接地址开启了公网访问,那么还会同时对应连接地址的连接串。​
  • 当连接地址类型为 HBaseReUsedEipId 时,连接地址的连接串也固定为 HBaseReUsedEipId。​
NetworkType​
String​
Private​
连接地址网络类型。取值范围如下:​
  • Public:公网访问地址。​
  • Private:私网访问地址。​
EipId​
String​
eip-3qe8rudt1yiv47prml165****​
当 ZK 连接地址或 Thrift2 连接地址开启了公网访问时,会返回该参数,表示 EIP ID。​
PrivateDNSVisibility​
Boolean​
false​
私网域名是否开启公网解析。​
​
Tag​
​
参数​
类型​
示例值​
描述​
TagKey​
String​
chargetype​
实例所绑定标签的标签键。​
TagValue​
String​
postpaid​
实例所绑定标签的标签键。​
​
MaintenanceWindow​
​
参数​
类型​
示例值​
描述​
Period​
Long​
4​
可维护时间段维护持续时长。​
DayKind​
String​
Week​
可维护周期粒度,默认取值为:Week(周)。​
StartTime​
String​
18:00Z​
可维护时间段的开始时间。​
DayOfWeeks​
Array of String​
["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]​
每周的哪一天为可维护时间段,默认取值为每一天。​
​
示例​
请求示例​
​
POST /?Action=DescribeDBInstanceDetail&Version=2018-01-01 HTTP/1.1​
Host: hbase.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=utf-8​
X-Date: 20201103T104027Z​
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/hbase/request,SignedHeaders=content-type;host;x-date, Signature=****​
{​
"InstanceId": "hb-cn019f341d51****"​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "2022110917242101022508219902CF****",​
"Action": "DescribeDBInstanceDetail",​
"Version": "2018-01-01",​
"Service": "hbase",​
"Region": "cn-beijing"​
},​
"Result": {​
"ChargeStatus": "Normal",​
"ChargeType": "PostPaid",​
"CreateTime": "2022-11-07T07:17:55Z",​
"DBInstanceEndpoint": [​
{​
"AddressType": "Zk",​
"EndpointId": "hb-cn019f341d51****-zk-Private",​
"EndpointStr": "hb-cn019f341d51****-zk.config.ivolces.com:2181",​
"NetworkType": "Private"​
}​
],​
"DeletionProtection": "enabled",​
"EngineVersion": "HBase_2.0",​
"InstanceId": "hb-cn019f341d51****",​
"InstanceName": "test_api",​
"InstanceType": "Standard",​
"MaintenanceWindow": {​
"DayKind": "Week",​
"DayOfWeeks": [​
"Sunday",​
"Monday",​
"Tuesday",​
"Wednesday",​
"Thursday",​
"Friday",​
"Saturday"​
],​
"Period": 4,​
"StartTime": "18:00Z"​
},​
"MasterCount": 2,​
"MasterSpec": "hbase.x1.4xlarge",​
"ProjectName": "",​
"RSCount": 3,​
"RSSpec": "hbase.x1.4xlarge",​
"RegionId": "cn-beijing",​
"RelationId": "ha-cnglbbaaa1ba****",​
"Status": "Running",​
"StorageCapacity": 500,​
"StorageType": "HdfsSsd",​
"SubnetId": "subnet-2d6pl8bcpl2io58ozfd43****",​
"Tags": [​
{​
"Key": "chargetype",​
"Value": "postpaid"​
},​
{​
"Key": "instancetype",​
"Value": "cluster"​
}​
],​
"UsedStorage": 0,​
"VpcId": "vpc-3redy6326y7ls5zsk2iko****",​
"VpcName": "test_vpc",​
"ZoneId": "cn-beijing",​
"ZoneName": "华北2(北京)-可用区A"​
}​
}​
​
​
最近更新时间:2026.06.05 14:34:00
这个页面对您有帮助吗?
有用
有用
无用
无用