调用 DescribeDBInstances 接口查询 HBase 实例列表信息。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
RegionId	String	是	cn-beijing	地域 ID。说明您可以调用 DescribeRegions 接口查询 HBase 实例所有可用的地域资源信息，包括地域 ID。
PageNumber	Integer	是	1	实例信息列表的页码，取值为不超过 Integer 数据类型的最大值，起始值为1。
PageSize	Integer	是	10	每页记录数。取值为 1~100 间的整数。
InstanceId	String	否	hb-cn019f341d51****	指定需要查询的实例 ID。支持模糊查询。
InstanceName	String	否	hbase_test	指定需要查询的实例名称。支持模糊查询。
InstanceStatus	String	否	Running	指定需要查询的实例状态。
Tags	Array of Tag	否	请参见请求示例。	用于查询筛选的标签键值对数组。说明单次最多支持同时传入 10 组标签键值对进行查询筛选。
CreateTimeStart	String	否	2022-11-08T12:26:23Z	查询开始时间，系统会查询创建时间等于或晚于查询开始时间的所有实例。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。说明若同时传入了查询开始时间（CreateTimeStart）和查询结束时间（CreateTimeEnd），查询开始时间需早于结束时间。
CreateTimeEnd	String	否	2022-11-08T12:26:30Z	查询结束时间，系统会查询创建时间等于或早于查询结束时间的所有实例。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。说明若同时传入了查询开始时间（CreateTimeStart）和查询结束时间（CreateTimeEnd），查询开始时间需早于结束时间。
ProjectName	String	否	default	指定实例所属的项目名称，若该参数留空，则表示查询所有项目下符合筛选条件的实例。

Tag

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

返回参数

参数	类型	示例值	描述
TotalCount	Integer	1	实例数量。
Instances	Array of InstanceObject	请参见返回示例。	实例基本信息。

InstanceObject

参数	类型	示例值	描述
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	实例所属的项目名称。
RSCount	Integer	2	RegionServer 节点的数量。
RegionId	String	cn-beijing	实例所属的地域 ID。
Status	String	Running	实例当前状态。关于实例状态的更多说明，请参见实例状态说明。
StorageType	String	HdfsHdd	实例的存储类型，取值： HdfsHdd：HDD 文件存储。 HdfsSsd：SSD 文件存储。
StorageCapacity	Integer	500	实例总存储容量，单位：GiB。
UsedStorage	Double	50	实例已使用的存储容量，单位：MiB。
VpcId	String	vpc-rs5811nceqyov0x58x4****	实例所属的私有网络 ID。
SubnetId	String	subnet-2d6pl8bcpl2io58ozfd43****	实例所属的子网 ID。
VpcName	String	test_vpc	实例所属的私有网络名称。
ZoneId	String	cn-beijing-a	实例所属的可用区 ID。
ZoneName	String	可用区A	实例所属的可用区名称。
Tags	Array of Tag	请参见返回示例。	实例绑定的标签键和标签值数组对象。
RelationId	String	ha-cnglbbaaa1ba****	主备实例的关联 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	实例所绑定标签的标签键。

示例

请求示例

返回示例

表格数据库 HBase 版