云数据库 SQL Server 版
云数据库 SQL Server 版
文档指南
请输入
- 文档首页
云数据库 SQL Server 版API 参考实例管理DescribeDBInstanceDetail - 查询实例详情信息
复制全文
下载 pdfDescribeDBInstanceDetail - 查询实例详情信息
文档反馈
问问助手调用 DescribeDBInstanceDetail 接口查询实例详情信息。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeDBInstanceDetail
要执行的操作，取值：DescribeDBInstanceDetail。
Version string 必选 示例值：2022-01-01
API的版本，取值：2022-01-01。
返回参数
BasicInfo object 示例值：BasicInfo
实例基本信息。
Tags object[] 示例值：{ "Key":"key", "Value":"value" }
Key string 示例值：aa
实例标签的标签键。
Value string 示例值：bb
实例标签的标签值。
ReadOnlyNumber integer 示例值：1
只读实例的个数。
PrimaryInstanceId string 示例值：mssql-e75beddc****
主实例 ID。
BackupUse float 示例值：1.42
实例已用备份空间。单位：GiB。
CreateTime string 示例值：2023-12-26T02:32:36.000Z
创建实例的实际时间。
DBEngineVersion string 示例值：SQLServer_2019_Std
兼容版本。取值如下：
- SQLServer_2019_Std：表示 SQL Server 2019 标准版。
- SQLServer_2019_Web：表示 SQL Server 2019 Web 版。
- SQLServer_2019_Ent：表示 SQL Server 2019 企业版。
- SQLServer_2022_Std：表示 SQL Server 2022 标准版。
- SQLServer_2022_Web：表示 SQL Server 2022 Web 版。
- SQLServer_2022_Ent：表示 SQL Server 2022 企业版。
InstanceId string 示例值：mssql-dab1be87****
实例 ID。
InstanceName string 示例值：实例样例
实例名称。
InstanceStatus string 示例值：Running
实例状态，取值：
- Running：运行中。
- Creating：创建中。
- Deleting：删除中。
- Restarting：重启中。
- Updating：变更中。
- MasterChanging：主节点切换中。
- Error：错误。
InstanceType string 示例值：HA
实例类型。取值如下：
- HA：表示高可用类型。
- Basic：表示基础版类型。
- Cluster：表示集群版类型。
- ReadOnly：表示实例的类型为只读实例。
说明
- 在 DBEngineVersion 设置为 SQLServer_2019_Std、SQLServer_2022_Std 时，InstanceType 支持返回 HA 或 Basic。
- 在 DBEngineVersion 设置为 SQLServer_2019_Ent 、SQLServer_2022_Ent时，InstanceType 支持返回 Cluster、Basic 或 ReadOnly。
- 在 DBEngineVersion 设置为 SQLServer_2019_Web、SQLServer_2022_Web 时，InstanceType 支持返回 Basic。
Memory integer 示例值：16
内存大小，单位为 GiB。
ProjectName string 示例值：Test
所属项目。
RegionId string 示例值：cn-beijing
地域 ID。
SlowQueryEnable boolean 示例值：false
表示是否开启慢日志，取值如下：
- true：表示开启慢日志。
- false：表示不开启慢日志。
SlowQueryTime string 示例值：1
慢日志的阈值，取值范围为 [1~10]，单位：秒（s）。
StorageSpace integer 示例值：200
实例总存储空间。单位：GiB。
StorageType string 示例值：ESSDPL1
实例存储类型。取值为 ESSDPL1，表示极速型 SSD PL1。
StorageUse float 示例值：1.85
实例已用储空间。单位：GiB。
SubnetId string 示例值：subnet-rroau2hdn1mov0x57f7****
子网 ID。
TimeZone string 示例值：China Standard Time
时区。
UpdateTime string 示例值：2024-01-03T07:15:08.000Z
实例的更新时间。
VCPU integer 示例值：4
CPU 大小。例如：1 表示 1核。
VpcId string 示例值：vpc-13g2qkkzntfy83n6nu4z1****
私有网络（VPC） ID。
ZoneId string 示例值：cn-beijing-a
可用区 ID。
InnerVersion string 示例值：15.0.4335.1
内核版本号。
ServerCollation string 示例值：Chinese_PRC_CI_AS
实例字符集排序规则，默认取值为 Chinese_PRC_CI_AS。目前已支持大多数原生字符集具体取值如下：
- Chinese_PRC_90_CI_AI
- Chinese_PRC_CI_AI
- Chinese_PRC_CI_AS
- Chinese_PRC_CS_AS
- Chinese_PRC_BIN
- Chinese_PRC_BIN2
- Cyrillic_General_CI_AS
- Latin1_General_CI_AS
- Latin1_General_CS_AS
- SQL_Latin1_General_CP1_CI_AS
- SQL_Latin1_General_CP1_CS_AS
- Japanese_CI_AS
- Japanese_CS_AS
- Latin1_General_100_CI_AS_SC_UTF8
- Chinese_Taiwan_Stroke_CI_AS
- Chinese_Taiwan_Stroke_CS_AS
- Thai_CI_AS
MaintenanceTime string 示例值：22:00Z-02:59Z
实例的可维护时间段。格式：HH:mmZ-HH:mmZ（UTC时间）。
ChargeDetail object 示例值：ChargeDetail
付费方式。
AutoRenew boolean 示例值：false
预付费场景下是否自动续费。
- true：自动续费（默认）。
- false：不自动续费。
ChargeStartTime string 示例值：2023-02-03T06:16:03.000Z
计费开始时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeEndTime string 示例值：2023-03-02T15:59:59.000Z
计费到期时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
ChargeStatus string 示例值：Normal
付费状态。取值：
- Normal：表示实例正常。
- Overdue：表示实例欠费。
- Unpaid：表示实例等待支付。
ChargeType string 示例值：PostPaid
付费类型。取值：
- PostPaid：表示按量付费。
- PrePaid：表示包年包月。
OverdueReclaimTime string 示例值：2023-03-09T15:59:59.000Z
欠费关停时预计释放时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
OverdueTime string 示例值：2023-03-03T04:00:00.000Z
欠费关停时间，格式为 yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。
Period integer 示例值：1
预付费场景下的购买时长。默认值：1。
PeriodUnit string 示例值：Month
预付费场景下的购买周期。
- Month：表示包月(默认值)。
- Year：表示包年。
ConnectionInfo object[] 示例值：ConnectionInfo
实例的连接信息。
Description string 示例值：无
描述信息。
EndpointId string 示例值：mssql-dab1be87****-primary
终端 ID。
EndpointName string 示例值：主连接终端
终端名称。
Address object[] 示例值：无
地址信息。
Domain string 示例值：mssqldab1be87****.rds-mssql.ivolces.com
连接域名。
EipId string 示例值：eip-5go6uulm687473inqk15****
EIP 的 ID，仅对公网地址有效。
IPAddress string 示例值：10.1.2.3
IP 地址。
Port string 示例值：1433
端口。
SubnetId string 示例值：subnet-2bzup883l93402dx0efe1****
子网 ID，仅对私网地址有效。
DNSVisibility boolean 示例值：false
表示是否开启私网到公网解析，取值如下：
- true：表示开启私网到公网解析。
- false：表示不开启私网到公网解析。
NetworkType string 示例值：Private
网络地址类型。取值：
- Private：私网类型。
- Public：公网类型。
EndpointType string 示例值：Primary
终端类型。取值如下
- Primary：表示主节点终端。
- ROCluster：表示只读集群终端。
- RO：表示只读节点终端。
NodeDetailInfo object[] 示例值：NodeDetailInfo
实例节点信息。
CreateTime string 示例值：2024-01-02T11:17:33.000Z
节点的创建时间。
InstanceId string 示例值：mssql-93420fe2****
实例 ID。
Memory integer 示例值：8
内存大小，单位为 GiB。
NodeId string 示例值：mssql-dab1be87****-0
节点 ID。
NodeSpec string 示例值：rds.mssql.se.ha.d4.4c16g
节点规格。
NodeStatus string 示例值：Running
节点状态，取值为：
- Running：运行中。
- Creating：创建中。
- Deleting：删除中。
- Restarting：重启中。
- Updating：变更中。
- MasterChanging：主备切换中。
- Error：错误。
NodeType string 示例值：Primary
节点类型。取值：
- Primary：表示主节点终端。
- ReadOnly：表示只读节点终端。
- Secondary：表示备节点终端。
RegionId string 示例值：cn-beijing
地域 ID。
UpdateTime string 示例值：2024-01-03T09:34:55.000Z
节点的更新时间。
VCPU integer 示例值：4
CPU 大小。例如：1 表示 1 核。
ZoneId string 示例值：cn-beijing-a
可用区 ID。
NodeIP string 示例值：192.168.xx.xxx
节点 IP。
HostName string 示例值：iv-xxx
节点主机名。
请求示例
POST /?Action=DescribeDBInstanceDetail&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mssql.cn-beijing.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": "202401081027172E3CCD0F346C0D******",
"Action": "DescribeDBInstanceDetail",
"Version": "2022-01-01",
"Service": "rds_mssql",
"Region": "cn-beijing"
},
"Result": {
"BasicInfo": {
"BackupUse": 1662.47,
"CreateTime": "2023-10-17T08:54:16.000Z",
"DBEngineVersion": "SQLServer_2019_Std",
"InnerVersion": "SQLServer_2019_Std",
"InstanceId": "mssql-6fca82fa****",
"InstanceName": "mssql-6fca82fa****",
"InstanceStatus": "Running",
"InstanceType": "HA",
"Memory": 8,
"NodeSpec": "rds.mssql.se.ha.d2.4c8g",
"PrimaryInstanceId": "",
"ProjectName": "default",
"ReadOnlyNumber": 0,
"RegionId": "cn-beijing",
"ServerCollation": "Chinese_PRC_CI_AS",
"SlowQueryEnable": false,
"SlowQueryTime": "1",
"StorageSpace": 1500,
"StorageType": "ESSDPL1",
"StorageUse": 634.66,
"SubnetId": "subnet-13f4n08ww1d6o3n6nu5g0****",
"Tags": [
{
"Key": "test",
"Value": "test"
}
],
"TimeZone": "China Standard Time",
"UpdateTime": "2023-12-04T06:26:49.000Z",
"VCPU": 4,
"VpcId": "vpc-13f4mzhagglj43n6nu500****",
"ZoneId": "cn-beijing-a"
},
"ChargeDetail": {
"AutoRenew": false,
"ChargeEndTime": "",
"ChargeStartTime": "2023-10-17T08:54:18.000Z",
"ChargeStatus": "Normal",
"ChargeType": "PostPaid",
"OverdueReclaimTime": "2200-01-15T16:00:00.000Z",
"OverdueTime": "",
"Period": 0,
"PeriodUnit": "Month"
},
"ConnectionInfo": [
{
"Address": [
{
"DNSVisibility": false,
"Domain": "mssql6fca82fa****.rds-mssql.ivolces.com",
"EipId": "",
"IPAddress": "192.168.0.17",
"NetworkType": "Private",
"Port": "1433",
"SubnetId": "subnet-13f4n08ww1d6o3n6nu5g0****"
}
],
"Description": "",
"EndpointId": "mssql-6fca82fa****-primary",
"EndpointName": "",
"EndpointType": "Primary"
}
],
"NodeDetailInfo": [
{
"CreateTime": "2023-10-17T08:54:16.000Z",
"InstanceId": "mssql-6fca82fa****",
"Memory": 8,
"NodeIP": "192.168.***.***",
"NodeId": "mssql-6fca82fa****-0",
"NodeSpec": "rds.mssql.se.ha.d2.4c8g",
"NodeStatus": "Running",
"NodeType": "Secondary",
"RegionId": "cn-beijing",
"UpdateTime": "2023-12-04T06:26:49.000Z",
"VCPU": 4,
"ZoneId": "cn-beijing-a"
},
{
"CreateTime": "2023-10-17T08:54:16.000Z",
"InstanceId": "mssql-6fca82fa****",
"Memory": 8,
"NodeIP": "192.168.***.***",
"NodeId": "mssql-6fca82fa****-1",
"NodeSpec": "rds.mssql.se.ha.d2.4c8g",
"NodeStatus": "Running",
"NodeType": "Primary",
"RegionId": "cn-beijing",
"UpdateTime": "2023-12-04T06:26:49.000Z",
"VCPU": 4,
"ZoneId": "cn-beijing-a"
}
]
}
}
错误码
最近更新时间：2026.05.19 18:20:31
这个页面对您有帮助吗？
有用
有用
无用
无用