You need to enable JavaScript to run this app.
导航
表格数据库 HBase 版
  • 文档首页
    • /
  • 表格数据库 HBase 版

DescribeDBInstanceDetail

最近更新时间：2024.04.16 17:09:36

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

我的收藏

调用 DescribeDBInstanceDetail 接口查询指定实例的详细信息。

请求类型

同步请求。

请求参数

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

InstanceId

String

是

hb-cn019f341d51****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询目标地域下所有 HBase 实例的基本信息，包括实例 ID。

返回数据

名称类型示例值描述

ChargeType

String

PostPaid

计费类型，取值：

  • PostPaid：按量计费（后付费）。
  • PrePaid：包年包月（预付费）。
ColdStorageInteger800实例总容量型存储空间大小，单位 GiB。
CreateTimeString2022-11-07T07:17:55Z实例创建时间（UTC 时间）。
DBInstanceEndpointArray of DBInstanceEndpointObject请参见返回示例。连接地址信息列表。更多详情，请参见数据结构。

DeletionProtection

String

enabled

实例删除保护功能开关状态。取值范围：

  • enabled：已开启。
  • disabled：未开启。

说明

关于实例删除保护的更多信息，请参见实例删除保护。

EngineVersionStringHBase_2.0HBase 数据库版本。当前仅支持 HBase 2.0 版本。
InstanceIdStringhb-cnglbbb73ea0****实例 ID。
InstanceNameStringtest_api实例名称。
InstanceTypeStringStandard实例类型，当前仅支持 Standard 标准版。
MasterCountInteger2Master 节点个数，每个 HBase 实例默认包含 2 个 Master 节点。
MasterSpecStringhbase.x1.mediumMaster 节点的规格码。
ProjectNameStringdefault实例所属的项目名称。若该参数为空，表示实例未加入任何项目。
RSCountInteger2RegionServer 节点的数量。
RSSpecStringhbase.x1.largeRegionServer 节点的规格码。
RegionIdStringcn-beijing实例所属的地域 ID。
StatusStringRunning实例当前状态。关于实例状态的更多说明，请参见实例状态说明。

StorageType

String

HdfsHdd

实例的存储类型，取值：

  • HdfsHdd：HDD 文件存储。
  • HdfsSsd：SSD 文件存储。
StorageCapacityInteger500实例总存储容量，单位：GiB。
SubnetIdStringsubnet-2d6pl8bcpl2io58ozfd43****实例所属的子网 ID。
UsedColdStorageInteger500实例已使用的容量型存储空间大小，单位 GiB。
UsedStorageFloat0实例已使用的存储容量，单位：GiB。
VpcIdStringvpc-rs5811nceqyov0x58x4****实例所属的私有网络 ID。
VpcNameStringtest_vpc实例所属的私有网络名称。
ZoneIdStringcn-beijing-a实例所属的可用区 ID。
ZoneNameString华北2（北京）-可用区A实例所属的可用区名称。
TagsArray of TagObject请参见返回示例。实例绑定的标签键和标签值数组对象。关于 Tags 的更多详情，请参见数据结构。

请求示例

POST https://hbase.volcengineapi.com/?Action=DescribeDBInstanceDetail&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=****
{
    "InstanceId":"hb-cn019f341d51****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022110917242101022508219902CF****",
        "Action": "DescribeDBInstanceDetail",
        "Version": "2018-01-01",
        "Service": "hbase",
        "Region": "cn-beijing"
    },
    "Result": {
        "ChargeType": "PostPaid",
        "CreateTime": "2022-11-07T07:17:55Z",
        "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": "test_api",
        "InstanceType": "Standard",
        "MasterCount": 2,
        "MasterSpec": "hbase.x1.medium",
        "ProjectName": "",
        "RSCount": 3,
        "RSSpec": "hbase.x1.large",
        "RegionId": "cn-beijing",
        "Status": "Running",
        "StorageCapacity": 500,
        "StorageType": "HdfsSsd",
        "SubnetId": "subnet-2d6pl8bcpl2io58ozfd43****",
        "Tags": [
            {
                "Key": "chargetype",
                "Value": "postpaid"
            },
            {
                "Key": "instancetype",
                "Value": "cluster"
            }
        ],
        "UsedStorage": 0,
        "VpcId": "vpc-3redy6326y7ls5zsk2iko****",
        "VpcName": "test_vpc",
        "ZoneId": "cn-beijing",
        "ZoneName": "华北2（北京）-可用区A"
    }
}