最近更新时间：2024.03.11 15:49:42
首次发布时间：2023.01.18 14:20:42
调用 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 TagObject | 否 | 请参见请求示例。 | 用于查询筛选的标签键值对数组。关于 Tags 的更多说明，请参见数据结构。 说明 单次最多支持同时传入 10 组标签键值对进行查询筛选。 |
CreateTimeStart | String | 否 | 2022-11-08T12:26:23Z | 查询开始时间，系统会查询创建时间等于或晚于查询开始时间的所有实例。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。 说明 若同时传入了查询开始时间（ |
CreateTimeEnd | String | 否 | 2022-11-08T12:26:30Z | 查询结束时间，系统会查询创建时间等于或早于查询结束时间的所有实例。格式为 yyyy-MM-ddTHH:mmZ（UTC 时间）。 说明 若同时传入了查询开始时间（ |
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| TotalCount | Integer | 1 | 实例数量。 |
| Instances | Array of InstanceObject | 请参见返回示例。 | 实例基本信息。关于 Instances 的详细说明，请参见数据结构。 |
POST https://hbase.volcengineapi.com/?Action=DescribeDBInstances&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=**** { "PageSize":10, "PageNumber":1, "RegionId":"cn-beijing", "Tags": [ { "Key": "chargetype", "Value": "postpaid" } ] }
正常返回示例
{ "ResponseMetadata":{ "RequestId":"20230828142506841D7D5EA6A6F344****", "Action":"DescribeDBInstances", "Version":"2018-01-01", "Service":"hbase", "Region":"cn-beijing" }, "Result":{ "Instances":[ { "ChargeType":"PostPaid", "CreateTime":"2023-08-25T08:19:50Z", "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":"api_test", "InstanceType":"Standard", "ProjectName":"", "RSCount":2, "RegionId":"cn-beijing", "Status":"Running", "StorageCapacity":500, "StorageType": "HdfsHdd", "UsedStorage":0, "SubnetId":"subnet-1g15j13jtzgu88ibuxwqp****", "Tags":[ { "Key":"chargetype", "Value":"postpaid" }, { "Key":"instancetype", "Value":"cluster" } ], "VpcId":"vpc-2bznmyi2p7ojk2dx0eedi****", "VpcName":"test_vpc", "ZoneId":"cn-beijing-a", "ZoneName":"华北2（北京）-可用区A" } ], "TotalCount":1 } }