You need to enable JavaScript to run this app.
导航
云数据库 veDB MySQL 版
  • 文档首页
    • /云数据库 veDB MySQL 版/API 参考/v1（2022-01-01）/实例管理/DescribeDBInstanceDetail
DescribeDBInstanceDetail
最近更新时间：2024.11.08 10:14:35首次发布时间：2022.04.12 19:05:15
我的收藏

调用 DescribeDBInstanceDetail 接口查询 veDB MySQL 实例的详情信息。

请求类型

同步请求。

调试

API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

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

InstanceId

String

是

vedbm-r3xq0zdl****

实例 ID。

说明

您可以调用 DescribeDBInstances 接口查询实例 ID。

返回参数

名称类型示例值描述
ChargeDetailChargeDetailObject请参见返回示例。计费详细信息。详细信息，请参见 ChargeDetailObject。
NodesArray of NodeObject实例节点的详细信息。详细信息，请参见 NodeObject。
EndpointsArray of EndpointObject连接终端的详细信息。详细信息，请参见 EndpointObject。
InstanceDetailInstanceDetailObject实例的基本信息。详细信息，请参见 InstanceDetailObject。
TagsArray of TagObject实例绑定的标签键和标签值数组对象。详细信息，请参见 TagObject。

请求示例

POST /?Action=DescribeDBInstanceDetail&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20220410T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20220410/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c8701d16****

{
    "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",
                "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",
                "Description": "默认终端",
                "DistributedTransaction": true,
                "EndpointId": "vedbm-gzwdsf9b****-ReadWriteSplit",
                "EndpointName": "默认终端",
                "EndpointType": "Cluster",
                "MasterAcceptReadRequests": true,
                "NodeIds": [
                    "vedbm-gzwdsf9b****-0",
                    "vedbm-gzwdsf9b****-1"
                ],
                "ReadWriteMode": "ReadWrite"
            },
            {
                "Addresses": [
                    {
                        "DNSVisibility": false,
                        "Domain": "vedbm-gzwdsf9b****.custom-t5ly.mysql.vedb.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.***.***.10",
                        "NetworkType": "Private",
                        "Port": "3306",
                        "SubnetId": "subnet-13fz1bsbrsw743n6nu47c****"
                    }
                ],
                "AutoAddNewNodes": false,
                "Description": "",
                "DistributedTransaction": true,
                "EndpointId": "vedbm-gzwdsf9b****-Custom-t5ly",
                "EndpointName": "自定义终端",
                "EndpointType": "Custom",
                "MasterAcceptReadRequests": true,
                "NodeIds": [
                    "vedbm-gzwdsf9b****-0",
                    "vedbm-gzwdsf9b****-1"
                ],
                "ReadWriteMode": "ReadWrite"
            }
        ],
        "InstanceDetail": {
            "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",
            "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"
            }
        ]
    }
}

错误码

更多详情，请参见错误码。