You need to enable JavaScript to run this app.
导航
云数据库 SQL Server 版
  • 文档首页
    • /
  • 云数据库 SQL Server 版

DescribeDBInstanceDetail

最近更新时间：2024.01.05 13:55:41

首次发布时间：2023.04.24 11:01:04

我的收藏

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

请求类型

同步请求。

请求参数

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

InstanceId

String

是

mssql-dab1be87****

实例 ID

说明

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

返回参数

名称类型示例值描述
BasicInfoBasicInfoObjectBasicInfo实例基本信息。
ChargeDetailChargeDetailObjectChargeDetail付费方式。
ConnectionInfoArray of ConnectionInfoObjectConnectionInfo实例的连接信息。
NodeDetailInfoArray of NodeDetailInfoObjectNodeDetailInfo实例节点信息。

请求示例

POST /?Action=DescribeDBInstanceDetail&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.volcengineapi.com
X-Date: 20230131T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mssql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mssql-dab1be87****"
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240105115058D8CA3236610C422B396A",
        "Action": "DescribeDBInstanceDetail",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BasicInfo": {
            "BackupUse": 0.42,
            "CreateTime": "2023-11-28T08:01:29.000Z",
            "DBEngineVersion": "SQLServer_2019_Ent",
            "InnerVersion": "SQLServer_2019_Ent",
            "InstanceId": "mssql-6fb1c736****",
            "InstanceName": "mssql-6fb1c736****",
            "InstanceStatus": "Running",
            "InstanceType": "Cluster",
            "Memory": 32,
            "NodeSpec": "rds.mssql.ee.ha.x8.4c32g",
            "PrimaryInstanceId": "",
            "ProjectName": "default",
            "ReadOnlyNumber": 1,
            "RegionId": "cn-beijing",
            "ServerCollation": "Chinese_PRC_CI_AS",
            "SlowQueryEnable": false,
            "SlowQueryTime": "1",
            "StorageSpace": 100,
            "StorageType": "ESSDPL1",
            "StorageUse": 0.51,
            "SubnetId": "subnet-mjm6qdbzuio05smt1b****",
            "Tags": [
                {
                    "Key": "w",
                    "Value": "e"
                }
            ],
            "TimeZone": "China Standard Time",
            "UpdateTime": "2024-01-04T02:30:00.000Z",
            "VCPU": 4,
            "VpcId": "vpc-13fuw95qz5fk03n6nu45****",
            "ZoneId": "cn-beijing-a"
        },
        "ChargeDetail": {
            "AutoRenew": false,
            "ChargeEndTime": "",
            "ChargeStartTime": "2023-11-28T08:01:32.000Z",
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "OverdueReclaimTime": "2200-01-15T16:00:00.000Z",
            "OverdueTime": "",
            "Period": 0,
            "PeriodUnit": "Month"
        },
        "ConnectionInfo": [
            {
                "Address": [
                    {
                        "DNSVisibility": false,
                        "Domain": "mssql6fb1c736****-rocluster.rds-mssql.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.168.***.***",
                        "NetworkType": "Private",
                        "Port": "1433",
                        "SubnetId": "subnet-mjm6qdbzuio05smt1b****"
                    }
                ],
                "Description": "",
                "EndpointId": "mssql-6fb1c736****-rocluster",
                "EndpointName": "",
                "EndpointType": "ROCluster"
            },
            {
                "Address": [
                    {
                        "DNSVisibility": false,
                        "Domain": "mssql-6fb1c736****-public.rds-mssql.volces.com",
                        "EipId": "eip-rrabyx1znpq8v0x58****",
                        "IPAddress": "180.184.***.***",
                        "NetworkType": "Public",
                        "Port": "1433",
                        "SubnetId": ""
                    },
                    {
                        "DNSVisibility": false,
                        "Domain": "mssql6fb1c736****.rds-mssql.ivolces.com",
                        "EipId": "",
                        "IPAddress": "192.168.***.***",
                        "NetworkType": "Private",
                        "Port": "1433",
                        "SubnetId": "subnet-mjm6qdbzuio05smt1b****"
                    }
                ],
                "Description": "",
                "EndpointId": "mssql-6fb1c736****-primary",
                "EndpointName": "",
                "EndpointType": "Primary"
            }
        ],
        "NodeDetailInfo": [
            {
                "CreateTime": "2023-11-28T08:01:29.000Z",
                "InstanceId": "mssql-6fb1c736****",
                "Memory": 32,
                "NodeIP": "192.168.***.***",
                "NodeId": "mssql-6fb1c736****-0",
                "NodeSpec": "rds.mssql.ee.ha.x8.4c32g",
                "NodeStatus": "Running",
                "NodeType": "Primary",
                "RegionId": "cn-beijing",
                "UpdateTime": "2024-01-04T02:30:00.000Z",
                "VCPU": 4,
                "ZoneId": "cn-beijing-a"
            },
            {
                "CreateTime": "2023-11-28T08:01:29.000Z",
                "InstanceId": "mssql-6fb1c736****",
                "Memory": 32,
                "NodeIP": "192.168.***.***",
                "NodeId": "mssql-6fb1c736****-1",
                "NodeSpec": "rds.mssql.ee.ha.x8.4c32g",
                "NodeStatus": "Running",
                "NodeType": "Secondary",
                "RegionId": "cn-beijing",
                "UpdateTime": "2024-01-04T02:30:00.000Z",
                "VCPU": 4,
                "ZoneId": "cn-beijing-a"
            }
        ]
    }
}

错误码

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