1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.com。
获取HBase数据表分析中HBase Region列表操作列点击Regions之后的查询列表数据
默认接口请求频率限制:20次/秒。
接口更新时间:2024-12-04 03:04:05。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeHBaseRegionList |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 字符串实例id 示例值: tbds-1vzudj86 |
| RegionServer | 否 | 否 | String | regionserver的ip。该字段非必填,但regionserver和Table 要至少一个非空。 示例值: 1 |
| Table | 否 | 否 | String | HBase表名。该字段非必填,但regionserver和Table 要至少一个非空。 示例值: hbase_meta |
| Offset | 是 | 否 | Int64 | 页码,默认值为0,表示第一页 示例值: 0 |
| Limit | 是 | 否 | Int64 | 每页返回数,默认值为10,最大值为50 示例值: 10 |
| OrderField | 否 | 否 | String | Region列表的页面排序字段,默认为空: RegionName/RegionServer/StartKey/EndKey/ReadRequest/WriteRequest 示例值: 1 |
| OrderType | 否 | 否 | String | 排序类型:asc/desc,默认desc 示例值: 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Int64 | 总数 示例值: 1 |
| Tables | Array of RegionTableRow | region列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| SchemaList | Array of TableSchemaItem | 表Schema信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.OpenTSDBHttpReturnCodeNotOK | 请求OpenTSDB失败。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |