文档中心

云数据库 SQL Server 版

API 参考

API 概览

API 概览

本文汇总云数据库 SQL Server 版提供的 API 接口。

全局

API	描述
DescribeRegions	调用 DescribeRegions 接口查看支持的地域列表。
DescribeAvailabilityZones	调用 DescribeAvailabilityZones 接口查询可用区列表。

实例管理

API	描述
CreateDBInstance	调用 CreateDBInstance 接口创建实例。
DescribeDBInstances	调用 DescribeDBInstances 接口查询实例列表。
DescribeDBInstanceDetail	调用 DescribeDBInstanceDetail 接口查询实例详情信息。
DeleteDBInstance	调用 DeleteDBInstance 接口删除实例。
DescribeDBInstanceSpecs	调用 DescribeDBInstanceSpecs 接口查询实例规格代码。
RestartDBInstance	调用 RestartDBInstance 接口重启实例。
ModifyDBInstanceName	调用 ModifyDBInstanceName 接口修改实例名称。
ModifyDBFailover	调用 ModifyDBFailover 接口手动切换主备节点。

账号管理

API	描述
CreateDBAccount	调用 CreateDBAccount 接口创建数据库账号。
ModifyDBAccountStatus	调用 ModifyDBAccountStatus 接口修改实例账号为启用或者禁用状态。
GrantDBAccountPrivilege	调用 GrantDBAccountPrivilege 接口对数据库账号授权。
DeleteDBAccount	调用 DeleteDBAccount 接口删除数据库账号。
RevokeDBAccountPrivilege	调用 RevokeDBAccountPrivilege 接口对数据库账号取消授权。
DescribeDBAccounts	调用 DescribeDBAccounts 接口查询数据库账号。
ResetDBAccount	调用 ResetDBAccount 接口重置数据库账号密码。

白名单管理

API	描述
CreateAllowList	调用 CreateAllowList 接口创建白名单。
DescribeInstanceAllowLists	调用 DescribeInstanceAllowLists 接口查询实例绑定的白名单列表。
ModifyAllowList	调用 ModifyAllowList 接口修改实例的白名单。
DisassociateAllowList	调用 DisassociateAllowList 接口解绑实例的白名单。
DescribeAllowLists	调用 DescribeAllowLists 接口查询白名单列表。
DescribeAllowListDetail	调用 DescribeAllowListDetail 接口查询白名单详情。
AssociateAllowList	调用 AssociateAllowList 接口绑定白名单到实例。
DeleteAllowList	调用 DeleteAllowList 接口删除白名单。

备份恢复

API	描述
CreateBackup	调用 CreateBackup 接口创建备份集。
DownloadBackup	调用 DownloadBackup 接口获取全量物理备份文件。
DescribeBackups	调用 DescribeBackups 接口查看备份集列表。
ModifyBackupPolicy	调用 ModifyBackupPolicy 接口修改实例的备份信息。
DeleteBackup	调用 DeleteBackup 接口删除实例的备份文件。
DescribeBackupDetail	调用 DescribeBackupDetail 接口查询备份文件的详细信息。
DescribeCrossBackupPolicy	调用 DescribeCrossBackupPolicy 接口查看跨地域备份策略。
DescribeAvailableCrossRegion	调用 DescribeAvailableCrossRegion 接口查看跨地域备份的目的地域。
RestoreToExistedInstance	调用 RestoreToExistedInstance 接口以数据库为单位，还原数据到已有实例。
ModifyCrossBackupPolicy	调用 ModifyCrossBackupPolicy 接口修改跨地域备份策略。

备份上云

API	描述
CreateTosRestore	调用 CreateTosRestore 接口将对象存储 TOS 上的备份文件还原到实例，实现数据上云。
DescribeTosRestoreTasks	调用 DescribeTosRestoreTasks 接口查询实例备份数据上云任务列表。
DescribeTosRestoreTaskDetail	调用 DescribeTosRestoreTaskDetail 接口查询实例备份数据上云的详细信息。

数据安全

API	描述
DescribeDBInstanceTDE	调用 DescribeDBInstanceTDE 接口查询实例 TDE 状态。
ModifyDBInstanceTDE	调用 ModifyDBInstanceTDE 接口修改实例的 TDE 配置。
DownloadSSLCertificate	调用 DownloadSSLCertificate 接口下载实例的 SSL CA 证书。
DescribeDBInstanceSSL	调用 DescribeDBInstanceSSL 接口查看实例的 SSL 信息。
ModifyDBInstanceSSL	调用 ModifyDBInstanceSSL 接口修改实例的 SSL 配置。

参数管理

API	描述
DescribeDBInstanceParameters	调用 DescribeDBInstanceParameters 接口查询实例参数。

最近更新时间：2026.05.29 15:06:02

这个页面对您有帮助吗？

有用

有用

无用

无用