DescribeDBInstanceDetail--表格数据库 HBase 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceDetail

最近更新时间：2025.06.09 17:22:39首次发布时间：2022.11.23 11:57:58

调用 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	Array of DBInstanceEndpointObject	请参见返回示例。	连接地址信息列表。
DeletionProtection	String	enabled	实例删除保护功能开关状态。取值范围： `enabled`：已开启。 `disabled`：未开启。说明关于实例删除保护的更多信息，请参见实例删除保护。
EngineVersion	String	HBase_2.0	HBase 数据库版本。当前仅支持 HBase 2.0 版本。
EnableAuth	Boolean	false	是否开启登录认证。取值： `true`：已开启登录认证。 `false`：未开启登录认证。
InstanceId	String	hb-cnglbbb73ea0****	实例 ID。
InstanceName	String	test_api	实例名称。
InstanceType	String	Standard	实例类型，当前仅支持 `Standard` 标准版。
MasterCount	Integer	2	Master 节点个数。单可用区部署，默认包含 2 个 Master 节点。多可用区部署，默认包含 4 个 Master 节点，并平均分配至主/备可用区。
MasterSpec	String	hbase.x1.medium	Master 节点的规格码。
ProjectName	String	default	实例所属的项目名称。
RSCount	Integer	2	RegionServer 节点的数量。说明多可用区实例，节点数量平均配置至主/备可用区。
RSSpec	String	hbase.x1.large	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。单可用区实例，仅包含一个可用区的子网 ID。多可用区实例，包含主/备两个子网 ID。
UsedColdStorage	Long	500	实例已使用的容量型存储空间大小，单位 GiB。
UsedStorage	Double	0	主实例已使用的存储容量，单位：GiB。
VpcId	String	vpc-rs5811nceqyov0x58x4****	实例所属的私有网络 ID。
VpcName	String	test_vpc	实例所属的私有网络名称。
ZoneId	String	cn-beijing-a	实例所属的可用区 ID。
ZoneName	String	华北2（北京）-可用区A	实例所属的可用区名称。
Tags	Array of Tag	请参见返回示例。	实例绑定的标签键和标签值数组对象。
ChargeStatus	String	Normal	计费状态。取值： `Normal`：正常。 `Overdue`：欠费。 `Shutdown`：关停。
AutoRenew	Boolean	false	预付费场景下是否自动续费。取值： `true`：自动续费。 `false`：不自动续费。
MultiAZ	Boolean	false	实例的部署方式，取值： `true`：多可用区部署。 `false`：单可用区部署。
StandbyUsedStorage	Double	0	备实例已使用的存储容量，单位：GiB。
PrimaryZoneID	String	cn-beijing-a	实时主可用区 ID。
StandbyZoneID	String	cn-beijing-b	实时备可用区 ID。
PrimarySubnetID	String	subnet-3jhhy08zsuakg3pncmfwx****	实时主可用区子网 ID。
StandbySubnetID	String	subnet-2gd0b9x8hfeo050ztz08a****	实时备可用区子网 ID。

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。

Tag

参数	类型	示例值	描述
TagKey	String	chargetype	实例所绑定标签的标签键。
TagValue	String	postpaid	实例所绑定标签的标签键。

示例

请求示例 1

单可用区实例

POST https://hbase.cn-beijing.volcengineapi.com?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****"
}

返回示例 1

单可用区实例

{
    "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",
        "EnableAuth": false,
        "InstanceId": "hb-cn019f341d51****",
        "InstanceName": "test_api",
        "InstanceType": "Standard",
        "MasterCount": 2,
        "MasterSpec": "hbase.x1.medium",
        "ProjectName": "",
        "RSCount": 3,
        "RSSpec": "hbase.x1.large",
        "RegionId": "cn-beijing",
        "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"
    }
}

请求示例 2

多可用区实例

POST https://hbase.cn-beijing.volcengineapi.com?Action=DescribeDBInstanceDetail&Version=2018-01-01 HTTP/1.1
Host: hbase.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": "hbha-cncq6c69fae8****"
}

返回示例 2

多可用区实例

{
    "ResponseMetadata": {
        "RequestId": "2024080917242101022508219902CF****",
        "Action": "DescribeDBInstanceDetail",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": {
        "ChargeStatus": "Normal",
        "ChargeType": "PostPaid",
        "CreateTime": "2024-08-07T07:17:55Z",
        "DBInstanceEndpoint": [
            {
                "AddressType": "Zk",
                "EndpointId": "hbha-cn019f341d51****-zk-Private",
                "EndpointStr": "hbha-cn019f341d51****-zk.config.ivolces.com:2181",
                "NetworkType": "Private"
            }
        ],
        "DeletionProtection": "enabled",
        "EngineVersion": "HBase_2.0",
        "EnableAuth": false,
        "InstanceId": "hbha-cn019f341d51****",
        "InstanceName": "test_api",
        "InstanceType": "Standard",
        "MasterCount": 4,
        "MasterSpec": "hbase.x1.medium",
        "MultiAZ": true,
        "PrimarySubnetID": "subnet-3jhhy08zsuakg3pncmfwx****",
        "PrimaryZoneID": "cn-beijing-a",
        "ProjectName": "default",
        "RSCount": 4,
        "RSSpec": "hbase.x1.large",
        "RegionId": "cn-beijing",
        "StandbySubnetID": "subnet-2gd0b9x8hfeo050ztz08a****",
        "StandbyUsedStorage": 0,
        "StandbyZoneID": "cn-beijing-b",
        "Status": "Running",
        "StorageCapacity": 500,
        "StorageType": "HdfsSsd",
        "SubnetId": "subnet-3jhhy08zsuakg3pncmfwx****,subnet-2gd0b9x8hfeo050ztz08a****",
        "Tags": [
            {
                "Key": "chargetype",
                "Value": "postpaid"
            },
            {
                "Key": "instancetype",
                "Value": "cluster"
            }
        ],
        "UsedStorage": 0,
        "VpcId": "vpc-3redy6326y7ls5zsk2iko****",
        "VpcName": "test_vpc",
        "ZoneId": "cn-beijing-a,cn-beijing-b"
    }
}