DescribeDBInstanceDetail--云数据库 SQL Server 版-火山引擎

文档中心

立即注册

导航

DescribeDBInstanceDetail

最近更新时间：2024.10.11 10:02:03首次发布时间：2023.04.24 11:01:04

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

请求类型

同步请求。

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	mssql-299eec0******	实例 ID 说明您可以调用 DescribeDBInstances 接口查询实例 ID。

返回参数

名称	类型	示例值	描述
BasicInfo	BasicInfoObject	BasicInfo	实例基本信息。
ChargeDetail	ChargeDetailObject	ChargeDetail	付费方式。
ConnectionInfo	Array of ConnectionInfoObject	ConnectionInfo	实例的连接信息。
NodeDetailInfo	Array of NodeDetailInfoObject	NodeDetailInfo	实例节点信息。

请求示例

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-299eec0******",
    "ServerCollation": "Chinese\_PRC\_CS\_AS"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024091219422786A6D2226B59B7122D9B-2417f0",
        "Action": "DescribeDBInstanceDetail",
        "Version": "2022-01-01",
        "Service": "rds_mssql",
        "Region": "cn-beijing"
    },
    "Result": {
        "BasicInfo": {
            "BackupUse": 0,
            "CreateTime": "2024-09-12T05:01:50.000Z",
            "DBEngineVersion": "SQLServer_2019_Ent",
            "InnerVersion": "15.0.4385.2",
            "InstanceId": "mssql-299eec0******",
            "InstanceName": "自动化测试-修改名称-jzxafm",
            "InstanceStatus": "Recycled",
            "InstanceType": "Basic",
            "Memory": 4,
            "NodeSpec": "rds.mssql.ee.std.d2.2c4g",
            "PrimaryInstanceId": "",
            "ProjectName": "",
            "ReadOnlyNumber": 0,
            "RegionId": "cn-beijing",
            "ServerCollation": "Chinese\_PRC\_CS\_AS",
            "SlowQueryEnable": false,
            "SlowQueryTime": "1",
            "StorageSpace": 60,
            "StorageType": "ESSDPL1",
            "StorageUse": 0,
            "SubnetId": "subnet-2byyde83esm4g2dx0eec2b5rc",
            "TimeZone": "Belarus Standard Time",
            "UpdateTime": "2024-09-12T08:59:50.000Z",
            "VCPU": 2,
            "VpcId": "vpc-2d5xeur6hiscg58ozfcuq1bix",
            "ZoneId": "cn-beijing-b"
        },
        "ChargeDetail": {
            "AutoRenew": false,
            "ChargeEndTime": "",
            "ChargeStartTime": "2024-09-12T05:01:51.000Z",
            "ChargeStatus": "Normal",
            "ChargeType": "PostPaid",
            "OverdueReclaimTime": "2024-09-27T08:58:00.000Z",
            "OverdueTime": "",
            "Period": 0,
            "PeriodUnit": "Month",
            "TempModifyEndTime": "",
            "TempModifyStartTime": ""
        },
        "ConnectionInfo": null,
        "NodeDetailInfo": [
            {
                "CreateTime": "2024-09-12T05:01:50.000Z",
                "InstanceId": "mssql-299eec0******",
                "Memory": 4,
                "NodeIP": "",
                "NodeId": "mssql-299eec0******-0",
                "NodeSpec": "rds.mssql.ee.std.d2.2c4g",
                "NodeStatus": "Recycled",
                "NodeType": "Primary",
                "RegionId": "cn-beijing",
                "UpdateTime": "2024-09-12T08:59:50.000Z",
                "VCPU": 2,
                "ZoneId": "cn-beijing-b"
            }
        ]
    }
}

错误码

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