云数据库 veDB MySQL 版
云数据库 veDB MySQL 版
文档指南
请输入
- 文档首页
云数据库 veDB MySQL 版API 参考v1（2022-01-01）实例管理DescribeDBInstanceDetail - 获取实例详情
复制全文
下载 pdfDescribeDBInstanceDetail - 获取实例详情
文档反馈
问问助手调用 DescribeDBInstanceDetail 接口查询实例的详情信息。
请求类型
同步请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
InstanceId | String | 是 | vedbm-r3xq0zdl**** | 实例 ID。 说明 |
返回参数
参数 | 类型 | 示例值 | 描述 |
ChargeDetail | 请参见返回示例。 | 计费详细信息。 | |
Nodes | 请参见返回示例。 | 实例节点的详细信息。 | |
Endpoints | 请参见返回示例。 | 连接终端的详细信息。 | |
InstanceDetail | 请参见返回示例。 | 实例的基本信息。 | |
Tags | 请参见返回示例。 | 实例绑定的标签键和标签值数组对象。 |
ChargeDetailObject
参数 | 类型 | 示例值 | 描述 |
ChargeType | String | PostPaid | 计算计费类型，取值：
|
ChargeStatus | String | Normal | 付费状态：
|
OverdueReclaimTime | String | 2022-09-27T06:09:20Z | 欠费关停时预计释放时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
OverdueTime | String | 2022-10-04T07:50:22Z | 欠费关停时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
AutoRenew | Boolean | true | 预付费场景下是否自动续费。取值：
|
ChargeStartTime | String | 2023-09-22T08:08:35Z | 计费开始的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
ChargeEndTime | String | 2023-09-22T08:08:35Z | 预付费场景下计费到期的时间，格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 |
NodeObject
参数 | 类型 | 示例值 | 描述 |
NodeId | String | vedbm-h441603c68aaa****-** | 节点 ID。 |
ZoneId | String | cn-beijing-a | 可用区 ID。 |
NodeType | String | Primary | 节点类型。取值：
|
vCPU | Integer | 8 | CPU 大小，例如当取值为 1 时表示 CPU 大小为 1U。 |
Memory | Integer | 32 | 内存大小，单位为 GiB。 |
NodeSpec | String | vedb.mysql.x4.xlarge | 实例的节点规格。 说明 |
FailoverPriority | Integer | 5 | 节点切主的优先级，取值范围为 0~15。数值越大，优先级越高。 |
EndpointObject
AddressObject
参数 | 类型 | 示例值 | 描述 |
DNSVisibility | Boolean | false | 解析方式。当前返回值只能为 false（火山引擎私网解析）。 |
Domain | String | vedbm-fkfb7ag0****.master.mysql.vedb.ivolces.com | 实例内网访问域名。 |
IPAddress | String | 100...*** | IP 地址。 |
NetworkType | String | Private | 网络类型：
|
Port | String | 3306 | 实例内网访问端口。 |
SubnetId | String | subnet-3tfam28a**** | 子网 ID。子网必须属于所选的可用区。 |
EipId | String | eip-13g56dc5u2uio3n6nu4kb**** | 公网 ID。 |
InstanceDetailObject
InstanceStructureObject
参数 | 类型 | 示例值 | 描述 |
SubInstanceType | String | Primary | 实例类型，取固定值 Primary（主实例）。 |
ZoneIds | String | cn-beijing-b | 可用区 ID。 |
Nodes | 请参见返回示例。 | 实例节点的详细信息。 |
MaintenanceWindow
TagObject
参数 | 类型 | 示例值 | 描述 |
Key | String | department | 实例绑定的标签键。 |
Value | String | game | 实例绑定的标签值。 |
示例
请求示例
POST /?Action=DescribeDBInstanceDetail&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host:vedbm.cn-beijing.volcengineapi.com
X-Date: 20220101T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220101/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645****
{
"InstanceId": "vedbm-1ql2ff4u****"
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2023080110352963A9D3FB2611C013333C",
"Action": "DescribeDBInstanceDetail",
"Version": "2022-01-01",
"Service": "vedbm",
"Region": "cn-beijing"
},
"Result": {
"ChargeDetail": {
"ChargeStatus": "Normal",
"ChargeType": "PostPaid",
"OverdueReclaimTime": "",
"OverdueTime": ""
},
"Endpoints": [
{
"Addresses": [
{
"DNSVisibility": false,
"Domain": "vedbm-gzwdsf9b****.pri.mysql.vedb.ivolces.com",
"EipId": "",
"IPAddress": "192.***.***.3",
"NetworkType": "Private",
"Port": "3306",
"SubnetId": "subnet-13fz1bsbrsw743n6nu47c****"
}
],
"AutoAddNewNodes": false,
"ConsistLevel": "Global",
"ConsistTimeout": 0,
"ConsistTimeoutAction": "ReadMaster",
"ConnectionPool": "Off",
"Description": "主节点终端",
"DistributedTransaction": false,
"EndpointId": "vedbm-gzwdsf9b****-Primary",
"EndpointName": "主节点终端",
"EndpointType": "Primary",
"MasterAcceptReadRequests": true,
"NodeIds": [
"vedbm-gzwdsf9b****-1"
],
"ReadWriteMode": "ReadWrite"
},
{
"Addresses": [
{
"DNSVisibility": false,
"Domain": "vedbm-gzwdsf9b****.default.mysql.vedb.ivolces.com",
"EipId": "",
"IPAddress": "192.***.***.2",
"NetworkType": "Private",
"Port": "3306",
"SubnetId": "subnet-13fz1bsbrsw743n6nu47c****"
}
],
"AutoAddNewNodes": true,
"ConsistLevel": "Session",
"ConsistTimeout": 20000,
"ConsistTimeoutAction": "ReadMaster",
"ConnectionPool": "Off",
"Description": "默认终端",
"DistributedTransaction": true,
"EndpointId": "vedbm-gzwdsf9b****-ReadWriteSplit",
"EndpointName": "默认终端",
"EndpointType": "Cluster",
"MasterAcceptReadRequests": true,
"NodeIds": [
"vedbm-gzwdsf9b****-0",
"vedbm-gzwdsf9b****-1"
],
"ReadWriteMode": "ReadWrite"
}
],
"InstanceDetail": {
"CompressedStorageUsedGiB": 0,
"CreateTime": "2023-07-14T03:36:42Z",
"DBEngineVersion": "MySQL_8_0",
"DeletionProtection": "disabled",
"InstanceId": "vedbm-gzwdsf9b****",
"InstanceName": "yangrui_test1",
"InstanceStatus": "Running",
"InstanceStructures": [
{
"Nodes": [
{
"Memory": 16,
"NodeId": "vedbm-gzwdsf9b****-0",
"NodeSpec": "vedb.mysql.x4.large",
"NodeType": "ReadOnly",
"ZoneId": "cn-beijing-b",
"vCPU": 4
},
{
"Memory": 16,
"NodeId": "vedbm-gzwdsf9b****-1",
"NodeSpec": "vedb.mysql.x4.large",
"NodeType": "Primary",
"ZoneId": "cn-beijing-b",
"vCPU": 4
}
],
"SubInstanceType": "Primary",
"ZoneIds": "cn-beijing-b"
}
],
"LowerCaseTableNames": "1",
"PrePaidStorageInGB": 50,
"PrimaryDBAccount": "",
"ProjectName": "default",
"RegionId": "cn-beijing",
"SpecFamily": "General",
"StorageChargeType": "PostPaid",
"StorageType": "IOOptimizedStorage",
"StorageUsedGiB": 0.997,
"SubnetId": "subnet-13fz1bsbrsw743n6nu47c****",
"TimeZone": "UTC +08:00",
"VpcId": "vpc-13fz0iip9nlds3n6nu4fi****",
"ZoneIds": "cn-beijing-b"
},
"Nodes": [
{
"Memory": 16,
"NodeId": "vedbm-gzwdsf9b****-0",
"NodeSpec": "vedb.mysql.x4.large",
"NodeType": "ReadOnly",
"ZoneId": "cn-beijing-b",
"vCPU": 4
},
{
"Memory": 16,
"NodeId": "vedbm-gzwdsf9b****-1",
"NodeSpec": "vedb.mysql.x4.large",
"NodeType": "Primary",
"ZoneId": "cn-beijing-b",
"vCPU": 4
}
],
"Tags": [
{
"Key": "instancetype",
"Value": "cluster"
}
]
}
}
错误码
最近更新时间：2026.07.31 10:06:26
这个页面对您有帮助吗？
有用
有用
无用
无用