文档中心

数据结构

最近更新时间：2024.04.16 17:08:39

首次发布时间：2022.11.23 11:57:59

本文汇总表格数据库 HBase 版的 API 接口中使用的数据结构定义详情。

AllowListObject

白名单信息。被 DescribeAllowLists 接口引用。

名称	类型	示例值	描述
AllowListDesc	String	test	白名单的备注。
AllowListId	String	acl-d1fd76693bd54e658912e7337d5b****	白名单 ID。
AllowListName	String	test	白名单名称。
AllowListIPNum	Integer	2	白名单内的 IP 地址（或地址段）总数。
AllowListType	String	IPv4	白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstanceNum	Integer	1	白名单下绑定的实例总数。

AssociatedInstanceObject

已绑定指定白名单的实例信息。被 DescribeAllowListDetail 接口引用。

名称	类型	示例值	描述
InstanceId	String	hb-cnglb4b26770****	已绑定当前白名单的实例 ID。
InstanceName	String	test	已绑定当前白名单的实例名称。
VPC	String	vpc-2743n1ihbxla87fap8tap****	实例所属的私有网络 ID。

DBInstnceEndpointObject

连接地址信息。被 DescribeDBInstanceDetail 接口引用。

名称	数据类型	示例值	说明
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`：私网访问地址。

InstanceObject

实例基本信息。被 DescribeDBInstances 接口引用。

名称	类型	示例值	描述
ChargeType	String	PostPaid	计费类型，取值： `PostPaid`：按量计费（后付费）。 `PrePaid`：包年包月（预付费）。
CreateTime	String	2022-05-25T04:19:39Z	实例创建时间（UTC 时间）。
ExpireTime	String	2022-05-25T04:19:39Z	包年包月实例的到期时间（UTC 时间）。
DBInstanceEndpoint	Array of DBInstanceEndpointObject	请参见返回示例。	连接地址信息列表。更多详情，请参见数据结构。
DeletionProtection	String	enabled	实例删除保护功能的开关状态。关于实例删除保护的更多信息，请参见实例删除保护。取值范围如下： `enabled`：已开启。 `disabled`：未开启。
EngineVersion	String	HBase_2.0	HBase 数据库版本。当前仅支持 HBase 2.0 版本。
InstanceId	String	hb-bbf19cb0****	实例 ID。
InstanceName	String	testInstance	实例名称。
InstanceType	String	Standard	实例类型，当前仅支持 `Standard` 标准版。
ProjectName	String	default	实例所属的项目 ID。若该参数为空，表示实例未加入任何项目。
RSCount	Integer	2	RegionServer 节点的数量。
RegionId	String	cn-beijing	实例所属的地域 ID。
Status	String	Running	实例当前状态。关于实例状态的更多说明，请参见实例状态说明。
StorageType	String	HdfsHdd	实例的存储类型，取值： `HdfsHdd`：HDD 文件存储。 `HdfsSsd`：SSD 文件存储。
StorageCapacity	Integer	500	实例总存储容量，单位：GiB。
UsedStorage	Float	0	实例已使用的存储容量，单位：GiB。
VpcId	String	vpc-rs5811nceqyov0x58x4****	实例所属的私有网络 ID。
SubnetId	String	subnet-2d6pl8bcpl2io58ozfd43****	实例所属的子网 ID。
VpcName	String	test_vpc	实例所属的私有网络名称。
ZoneId	String	cn-beijing-a	实例所属的可用区 ID。
ZoneName	String	华北2（北京）-可用区A	实例所属的可用区名称。
Tags	Array of TagObject	请参见返回示例。	实例绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见数据结构。

RegionInfo

地域信息。被 DescribeRegions 接口引用。

名称	类型	示例值	描述
RegionId	String	cn-beijing	地域 ID。
RegionName	String	华北2（北京）	地域名称。

TagObject

实例绑定的标签键和标签值数组对象。被以下接口引用：

名称	类型	是否必选	示例值	描述
Key	String	是	department	实例绑定的标签键。不同接口中该参数的含义不同，其中：在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回中表示当前实例所绑定标签的标签键。在 CreateDBInstance 和 AddTagsToResource 的请求参数中表示需要绑定标签所对应的标签键。在 DescribeDBInstances 的请求参数中表示用于查询筛选的标签键。
Value	String	否	game	实例绑定的标签值。不同接口中该参数的含义不同，其中：在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签值。在 CreateDBInstance 和 AddTagsToResource 请求参数中表示需要绑定标签所对应的标签值。在 DescribeDBInstances 的请求参数中表示用于查询筛选的标签值。说明若该参数留空，表示不对标签值作限制，会筛选所有绑定了指定标签键的实例。若传入空字符串，表示筛选对应标签键下，标签值为空的实例。

名称

类型

是否必选

示例值

描述

Key

String

是

department

实例绑定的标签键。不同接口中该参数的含义不同，其中：

在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回中表示当前实例所绑定标签的标签键。
在 CreateDBInstance 和 AddTagsToResource 的请求参数中表示需要绑定标签所对应的标签键。
在 DescribeDBInstances 的请求参数中表示用于查询筛选的标签键。

Value

String

否

game

实例绑定的标签值。不同接口中该参数的含义不同，其中：

在 DescribeDBInstances 和 DescribeDBInstanceDetail 的返回数据中表示当前实例所绑定标签的标签值。
在 CreateDBInstance 和 AddTagsToResource 请求参数中表示需要绑定标签所对应的标签值。
在 DescribeDBInstances 的请求参数中表示用于查询筛选的标签值。

说明

若该参数留空，表示不对标签值作限制，会筛选所有绑定了指定标签键的实例。
若传入空字符串，表示筛选对应标签键下，标签值为空的实例。

TagFilterObject

用于查询筛选的标签键值对数组。被 DescribeTagsByResource 接口引用。

名称	类型	是否必选	示例值	描述
Key	String	是	instancetype	用于查询筛选的标签键。说明如需使用标签对实例进行查询筛选，该参数必填。允许传入重复的标签键。单次最多支持同时传入 10 个标签进行查询筛选。
Value	String	否	cluster	用于查询筛选的标签键所对应的标签值。说明若该参数留空，表示不对标签值作限制，会筛选所有绑定了指定标签键的实例。若传入空字符串，表示筛选对应标签键下，标签值为空的实例。

TagResourceObject

实例绑定的标签信息。被 DescribeTagsByResource 接口引用。

名称	类型	示例值	描述
InstanceId	String	hb-cn019f341d51****	实例 ID。
Key	String	instancetype	实例所绑定的标签键。
Value	String	cluster	实例所绑定标签键对应的值。

ZoneInfo

可用区信息。被 DescribeZones 接口引用。

名称	类型	示例值	描述
ZoneId	String	cn-beijing-a	可用区 ID。
ZoneName	String	可用区A	可用区名称。