You need to enable JavaScript to run this app.
导航

数据结构

最近更新时间2024.01.04 14:57:21

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

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

AllowListObject

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

名称类型示例值描述
AllowListDescStringtest白名单的备注。
AllowListIdStringacl-d1fd76693bd54e658912e7337d5b****白名单 ID。
AllowListNameStringtest白名单名称。
AllowListIPNumInteger2白名单内的 IP 地址(或地址段)总数。
AllowListTypeStringIPv4白名单内的 IP 地址类型。当前仅支持 IPv4 地址。
AssociatedInstanceNumInteger1白名单下绑定的实例总数。

AssociatedInstanceObject

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

名称类型示例值描述
InstanceIdStringhb-cnglb4b26770****已绑定当前白名单的实例 ID。
InstanceNameStringtest已绑定当前白名单的实例名称。
VPCStringvpc-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:包年包月(预付费)。
CreateTimeString2022-05-25T04:19:39Z实例创建时间(UTC 时间)。
ExpireTimeString2022-05-25T04:19:39Z包年包月实例的到期时间(UTC 时间)。
DBInstanceEndpointArray of DBInstanceEndpointObject请参见返回示例连接地址信息列表。更多详情,请参见数据结构

DeletionProtection

String

enabled

实例删除保护功能的开关状态。关于实例删除保护的更多信息,请参见实例删除保护。取值范围如下:

  • enabled:已开启。
  • disabled:未开启。
EngineVersionStringHBase_2.0HBase 数据库版本。当前仅支持 HBase 2.0 版本。
InstanceIdStringhb-bbf19cb0****实例 ID。
InstanceNameStringtestInstance实例名称。
InstanceTypeStringStandard实例类型,当前仅支持 Standard 标准版。
ProjectNameStringdefault实例所属的项目 ID。若该参数为空,表示实例未加入任何项目。
RSCountInteger 162RegionServer 节点的数量。
RegionIdStringcn-beijing实例所属的地域 ID。
StatusStringRunning实例当前状态。关于实例状态的更多说明,请参见实例状态说明
StorageCapacityInteger 16500实例总存储容量,单位:GiB。
UsedCapacity(UsedStorage)Float 640实例已使用的存储容量,单位:GiB。
VpcIdStringvpc-rs5811nceqyov0x58x4****实例所属的私有网络 ID。
SubnetIdStringsubnet-2d6pl8bcpl2io58ozfd43****实例所属的子网 ID。
VpcNameStringtest_vpc实例所属的私有网络名称。
ZoneIdStringcn-beijing-a实例所属的可用区 ID。
ZoneNameString华北2(北京)-可用区A实例所属的可用区名称。
TagsArray of TagObject请参见返回示例实例绑定的标签键和标签值数组对象。关于 Tags 的更多详情,请参见数据结构

RegionInfo

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

名称类型示例值描述
RegionIdStringcn-beijing地域 ID。
RegionNameString华北2(北京)地域名称。

TagObject

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

名称类型是否必选示例值描述

Key

String

department

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

Value

String

game

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

说明

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

TagFilterObject

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

名称类型是否必选示例值描述

Key

String

instancetype

用于查询筛选的标签键。

说明

  • 如需使用标签对实例进行查询筛选,该参数必填。
  • 允许传入重复的标签键。
  • 单次最多支持同时传入 10 个标签进行查询筛选。

Value

String

cluster

用于查询筛选的标签键所对应的标签值。

说明

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

TagResourceObject

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

名称类型示例值描述
InstanceIdStringhb-cn019f341d51****实例 ID。
KeyStringinstancetype实例所绑定的标签键。
ValueStringcluster实例所绑定标签键对应的值。

ZoneInfo

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

名称类型示例值描述
ZoneIdStringcn-beijing-a可用区 ID。
ZoneNameString可用区A可用区名称。