查询独享集群详情

最近更新时间：2024-03-12 01:24:54

我的收藏

本页目录：

1. 接口描述

接口请求域名： dbdc.tencentcloudapi.com 。

本接口用于查询独享集群详情

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstanceDetail。
Version	是	String	公共参数，本接口取值：2020-10-29。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceId	是	String	独享集群实例Id 示例值：dbdc-test

3. 输出参数

参数名称	类型	描述
InstanceId	String	独享集群实例Id 示例值：dbdc-test
InstanceName	String	独享集群实例名称示例值：dbdc-test
Region	String	地域示例值：ap-guangzhou
ProductId	Integer	产品ID, 0:CDB, 1:TDSQL 示例值：1
Type	Integer	集群类型, 0:公有云, 1:金融围笼示例值：0
HostType	Integer	主机类型, 0:物理机, 1:cvm本地盘, 2:cvm云盘示例值：0
AutoRenewFlag	Integer	自动续费标志, 0:未设置, 1:自动续费, 2:到期不续费示例值：0
Status	Integer	集群状态示例值：1
StatusDesc	String	集群状态描述示例值：运行中
CreateTime	String	创建时间示例值：2021-04-28 00:00:00
PeriodEndTime	String	到期时间示例值：2021-05-28 00:00:00
HostNum	Integer	主机数示例值：2
DbNum	Integer	Db实例数示例值：1
AssignStrategy	Integer	分配策略, 0:紧凑, 1:均匀示例值：0
CpuSpec	Integer	总主机CPU(单位:核) 示例值：100
CpuAssigned	Integer	总已分配CPU(单位:核) 示例值：100
CpuAssignable	Integer	总可分配CPU(单位:核) 示例值：100
MemorySpec	Integer	总主机内存(单位:GB) 示例值：1000
MemoryAssigned	Integer	总已分配内存(单位:GB) 示例值：1000
MemoryAssignable	Integer	总可分配内存(单位:GB) 示例值：1000
DiskSpec	Integer	总机器磁盘(单位:GB) 示例值：1000
DiskAssigned	Integer	总已分配磁盘(单位:GB) 示例值：1000
DiskAssignable	Integer	总可分配磁盘(单位:GB) 示例值：1000
Zone	String	可用区示例值：ap-guangzhou-3
FenceId	String	金融围笼ID 注意：此字段可能返回 null，表示取不到有效值。示例值：cage-x-x
ClusterId	String	所属集群ID(默认集群为空) 注意：此字段可能返回 null，表示取不到有效值。示例值：cluster-xxx
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询独享集群详情

输入示例

POST / HTTP/1.1
Host: dbdc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstanceDetail
<公共请求参数>

{
    "InstanceId": "dbdc-test"
}

输出示例

{
    "Response": {
        "RequestId": "22cb8292-b16d-11eb-8d13-525400542aa6",
        "DbNum": 0,
        "CpuAssignable": 64,
        "HostType": 0,
        "AutoRenewFlag": 0,
        "Type": 0,
        "Status": 1,
        "InstanceId": "dbdc-test",
        "AssignStrategy": 0,
        "PeriodEndTime": "2021-05-28 00:00:00",
        "HostNum": 2,
        "MemoryAssignable": 256,
        "CpuSpec": 64,
        "DiskSpec": 12000,
        "MemorySpec": 256,
        "MemoryAssigned": 0,
        "StatusDesc": "运行中",
        "InstanceName": "test",
        "CpuAssigned": 0,
        "ProductId": 1,
        "DiskAssignable": 6000,
        "DiskAssigned": 0,
        "Region": "ap-guangzhou",
        "Zone": "ap-guangzhou-3",
        "FenceId": "cage-x-x",
        "ClusterId": "",
        "CreateTime": "2021-04-28 00:00:00"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
DryRunOperation	DryRun 操作，代表请求将会是成功的，只是多传了 DryRun 参数。
FailedOperation.QueryResourceError	查询资源信息失败。
FailedOperation.QuerySpecInfoError	获取独享集群规格信息失败。
InvalidParameterValue.InvalidParameterValueError	参数值传入错误。

上一篇: 查询独享集群内的DB实例列表下一篇: 查询独享集群实例列表