{ "name": "sqlserver", "display_name": "云数据库 SQL Server", "description": "介绍如何使用 API 对云数据库 SQL Server 进行操作，包括实例管理、备份与恢复等。", "domain": "database", "api_version": "2018-03-28", "endpoint": "sqlserver.tencentcloudapi.com", "actions": [ { "name": "AssociateSecurityGroups", "description": "本接口(AssociateSecurityGroups)用于安全组批量绑定实例。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组ID。", "example": "sg-igw86yth" }, { "name": "InstanceIdSet", "type": "array", "required": true, "description": "实例ID 列表，一个或者多个实例ID组成的数组。多个实例必须是同一个地域，同一个可用区，同一个项目下的。", "example": "[\"mssql-6f4ddx2f\\r\\n\"]", "item_type": "string" } ], "required": [ "SecurityGroupId", "InstanceIdSet" ] }, { "name": "BalanceReadOnlyGroup", "description": "本接口（BalanceReadOnlyGroup）用于根据预定义的权重平衡每个只读实例的路由权重。预定义权重可根据接口DescribeReadOnlyGroupAutoWeight查询。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-dj5i29c5n" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID，格式如：mssqlrg-dj5i29c5n", "example": "mssqlrg-dj5i29c5n" } ], "required": [ "InstanceId", "ReadOnlyGroupId" ] }, { "name": "CloneDB", "description": "本接口（CloneDB）用于克隆数据库，只支持克隆到本实例，克隆时必须指定新库名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-j8kv137v" }, { "name": "RenameRestore", "type": "array", "required": true, "description": "按照ReNameRestoreDatabase中的库进行克隆，并重命名，新库名称必须指定", "example": "RenameRestore.0.OldName=db1\u0026RenameRestore.0.NewName=clone_db1", "item_type": "object", "children": [ { "name": "OldName", "type": "string", "required": false, "description": "库的名字，如果oldName不存在则返回失败。 在用于离线迁移任务时可不填。", "example": "db1" }, { "name": "NewName", "type": "string", "required": false, "description": "库的新名字，在用于离线迁移时，不填则按照OldName命名，OldName和NewName不能同时不填。在用于克隆数据库时，OldName和NewName都必须填写，且不能重复", "example": "db2" } ] } ], "required": [ "InstanceId", "RenameRestore" ] }, { "name": "CloseInterCommunication", "description": "本接口（CloseInterCommunication）用于关闭实例互通。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "关闭互通的实例ID集合", "example": " [\"mssql-hlh6yka1\",\"mssql-gfh54fg2\"]", "item_type": "string" } ], "required": [ "InstanceIdSet" ] }, { "name": "CompleteExpansion", "description": "本接口（CompleteExpansion）在实例发起扩容后，实例状态处于“升级待切换”时，可立即完成实例升级切换操作，无需等待可维护时间窗。本接口需要在实例低峰时调用，在完全切换成功前，存在部分库不可访问的风险。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-2pohwxbf" } ], "required": [ "InstanceId" ] }, { "name": "CompleteMigration", "description": "本接口（CompleteMigration）作用是完成一个迁移任务", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "2729" } ], "required": [ "MigrateId" ] }, { "name": "CreateAccount", "description": "本接口（CreateAccount）用于创建实例账号", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "Accounts", "type": "array", "required": true, "description": "数据库实例账户信息", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "实例用户名", "example": "ac1" }, { "name": "Password", "type": "string", "required": false, "description": "实例密码", "example": "Zh22448899" }, { "name": "DBPrivileges", "type": "array", "required": false, "description": "DB权限列表", "example": "[{\"DBName\": \"db1\",\"Privilege\": \"ReadOnly\"}]", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": true, "description": "数据库名", "example": "db_test" }, { "name": "Privilege", "type": "string", "required": true, "description": "数据库权限，ReadWrite表示可读写，ReadOnly表示只读，DBOwner所有者", "example": "ReadOnly" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "账号备注信息", "example": "andy" }, { "name": "IsAdmin", "type": "boolean", "required": false, "description": "是否为管理员账户，当值为true 等价于单节点AccountType=L0，双节点AccountType=L1，当值为false，等价于AccountType=L3", "example": "false" }, { "name": "Authentication", "type": "string", "required": false, "description": "win-windows鉴权,sql-sqlserver鉴权，不填默认值为sql-sqlserver鉴权", "example": "sql" }, { "name": "AccountType", "type": "string", "required": false, "description": "账号类型，IsAdmin的扩展字段。 L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限，默认L3", "example": "L0" }, { "name": "IsCam", "type": "boolean", "required": false, "description": "是否开启CAM验证", "example": "false" }, { "name": "EncryptedVersion", "type": "integer", "required": false, "description": "加密密钥版本号，0表示不使用加密", "example": "0" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "CreateBackup", "description": "本接口(CreateBackup)用于创建备份。", "status": "online", "parameters": [ { "name": "Strategy", "type": "integer", "required": false, "description": "备份策略(0-实例备份 1-多库备份)", "example": "1" }, { "name": "DBNames", "type": "array", "required": false, "description": "需要备份库名的列表(多库备份才填写)", "example": "[\"db1\\r\\n\",\"db2\\r\\n\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例ID，形如mssql-i1z41iwd", "example": "mssql-njj2mtpl" }, { "name": "BackupName", "type": "string", "required": false, "description": "备份名称，若不填则自动生成“实例ID_备份开始时间戳”", "example": "BackupName" }, { "name": "StorageStrategy", "type": "integer", "required": false, "description": "备份存储策略 0-跟随自定义备份保留策略 1-跟随实例生命周期直到实例下线，默认取值0", "example": "0" } ], "required": [] }, { "name": "CreateBackupMigration", "description": "本接口（CreateBackupMigration）用于创建备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "RecoveryType", "type": "string", "required": true, "description": "迁移任务恢复类型，FULL-全量备份恢复，FULL_LOG-全量备份+事务日志恢复，FULL_DIFF-全量备份+差异备份恢复", "example": "FULL" }, { "name": "UploadType", "type": "string", "required": true, "description": "备份上传类型，COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，需要用户上传。", "example": "COS_UPLOAD" }, { "name": "MigrationName", "type": "string", "required": true, "description": "任务名称", "example": "字符串" }, { "name": "BackupFiles", "type": "array", "required": false, "description": "UploadType是COS_URL时这里填URL，COS_UPLOAD这里填备份文件的名字。只支持1个备份文件，但1个备份文件内可包含多个库", "example": "[\"db1.bak\\n\"]", "item_type": "string" } ], "required": [ "InstanceId", "RecoveryType", "UploadType", "MigrationName" ] }, { "name": "CreateBasicDBInstances", "description": "本接口（CreateBasicDBInstances）用于创建基础版实例 (云盘)。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-3" }, { "name": "Cpu", "type": "integer", "required": true, "description": "实例的CPU核心数", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "20" }, { "name": "SubnetId", "type": "string", "required": true, "description": "VPC子网ID，形如subnet-bdoe83fa", "example": "subnet-pudyecyk" }, { "name": "VpcId", "type": "string", "required": true, "description": "VPC网络ID，形如vpc-dsp338hz", "example": "vpc-huew581t" }, { "name": "MachineType", "type": "string", "required": true, "description": "购买实例的宿主机类型，CLOUD_PREMIUM-虚拟机高性能云硬盘，CLOUD_SSD-虚拟机SSD云硬盘,CLOUD_HSSD-虚拟机增强型SSD云硬盘，CLOUD_BSSD-虚拟机通用型SSD云盘", "example": "CLOUD_PREMIUM" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。", "example": "PREPAID" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "0" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次购买几个实例，默认值为1。取值不超过10", "example": "1" }, { "name": "DBVersion", "type": "string", "required": false, "description": "sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同...", "example": "2008R2" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例周期，默认取值为1，表示一个月。取值不超过48", "example": "1" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxx", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志：0-正常续费 1-自动续费，默认为1自动续费。只在购买预付费实例时有效。", "example": "0" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券；1 - 是，0 - 否，默认不使用", "example": "2" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID数组，目前单个订单只能使用一张", "example": "VoucherIds", "item_type": "string" }, { "name": "Weekly", "type": "array", "required": false, "description": "可维护时间窗配置，以周为单位，表示周几允许维护，1-7分别代表周一到周末", "example": "[\"1\\n\"]", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "可维护时间窗配置，每天可维护的开始时间", "example": "00:00" }, { "name": "Span", "type": "integer", "required": false, "description": "可维护时间窗配置，持续时间，单位：小时", "example": "6" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] }, { "name": "Collation", "type": "string", "required": false, "description": "系统字符集排序规则，默认：Chinese_PRC_CI_AS", "example": "Chinese_PRC_CI_AS" }, { "name": "TimeZone", "type": "string", "required": false, "description": "系统时区，默认：China Standard Time", "example": "China Standard Time" }, { "name": "DiskEncryptFlag", "type": "integer", "required": false, "description": "磁盘加密标识，0-不加密，1-加密", "example": "0" } ], "required": [ "Zone", "Cpu", "Memory", "Storage", "SubnetId", "VpcId", "MachineType" ] }, { "name": "CreateBusinessDBInstances", "description": "本接口（CreateBusinessDBInstances）用于创建商业智能服务实例 (云盘)。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "100" }, { "name": "Cpu", "type": "integer", "required": true, "description": "预购买实例的CPU核心数", "example": "1" }, { "name": "MachineType", "type": "string", "required": true, "description": "购买实例的宿主机类型，CLOUD_PREMIUM-虚拟机高性能云盘，CLOUD_SSD-虚拟机SSD云盘", "example": "CLOUD_PREMIUM" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "1003" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次购买几个实例，默认值为1", "example": "1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置", "example": "subnet-bdoe83fa" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置", "example": "vpc-dsp338hz" }, { "name": "DBVersion", "type": "string", "required": false, "description": "商业智能服务器版本，目前只支持：201603（SQL Server 2016 Integration Services），201703（SQL Server 2017 Integration Services），201903（SQL Server 2019 Integration Services）版本。每个地域支持售卖的版本不同，可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息。不填，默认为版本201903。", "example": "2008R2" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxxx", "item_type": "string" }, { "name": "Weekly", "type": "array", "required": false, "description": "可维护时间窗配置，以周为单位，表示周几允许维护，1-7分别代表周一到周末", "example": "1", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "可维护时间窗配置，每天可维护的开始时间", "example": "2020-04-09 00:00:00" }, { "name": "Span", "type": "integer", "required": false, "description": "可维护时间窗配置，持续时间，单位：小时", "example": "2" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "无", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] } ], "required": [ "Zone", "Memory", "Storage", "Cpu", "MachineType" ] }, { "name": "CreateBusinessIntelligenceFile", "description": "本接口（CreateBusinessIntelligenceFile）用于添加商业智能服务文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-dj5i29c5n" }, { "name": "FileURL", "type": "string", "required": true, "description": "COS_URL", "example": "http://bucket/file.txt" }, { "name": "FileType", "type": "string", "required": true, "description": "文件类型 FLAT-作为数据源的平面文件， SSIS-ssis项目包", "example": "FLAT" }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "Remark" } ], "required": [ "InstanceId", "FileURL", "FileType" ] }, { "name": "CreateCloudDBInstances", "description": "本接口（CreateCloudDBInstances）用于创建高可用实例 (云盘)。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "100" }, { "name": "Cpu", "type": "integer", "required": true, "description": "实例核心数", "example": "2" }, { "name": "MachineType", "type": "string", "required": true, "description": "购买实例的宿主机磁盘类型,CLOUD_HSSD-虚拟机加强型SSD云盘，CLOUD_TSSD-虚拟机极速型SSD云盘，CLOUD_BSSD-虚拟机通用型SSD云盘", "example": "CLOUD_BSSD" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。", "example": "PREPAID" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "1003" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次购买几个实例，默认值为1。取值不超过10", "example": "1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置", "example": "subnet-bdoe83fa" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置", "example": "vpc-dsp338hz" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例周期，默认取值为1，表示一个月。取值不超过48", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券；1 - 是，0 - 否，默认不使用", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID数组，目前单个订单只能使用一张", "example": "VoucherIds", "item_type": "string" }, { "name": "DBVersion", "type": "string", "required": false, "description": "sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同...", "example": "2008R2" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志：0-正常续费 1-自动续费，默认为1自动续费。只在购买预付费实例时有效。", "example": "0" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxxx", "item_type": "string" }, { "name": "Weekly", "type": "array", "required": false, "description": "可维护时间窗配置，以周为单位，表示周几允许维护，1-7分别代表周一到周末", "example": "1", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "可维护时间窗配置，每天可维护的开始时间", "example": "2020-04-09 00:00:00" }, { "name": "Span", "type": "integer", "required": false, "description": "可维护时间窗配置，持续时间，单位：小时", "example": "2" }, { "name": "MultiZones", "type": "boolean", "required": false, "description": "是否跨可用区部署，默认值为false", "example": "ture" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] }, { "name": "Collation", "type": "string", "required": false, "description": "系统字符集排序规则，默认：Chinese_PRC_CI_AS", "example": "Chinese_PRC_CI_AS" }, { "name": "TimeZone", "type": "string", "required": false, "description": "系统时区，默认：China Standard Time", "example": "China Standard Time" }, { "name": "MultiNodes", "type": "boolean", "required": false, "description": "是否多节点架构实例，默认值为false。当MultiNodes = true时，参数MultiZones必须取值为true。", "example": "false" }, { "name": "DrZones", "type": "array", "required": false, "description": "备节点可用区，默认为空。当MultiNodes = true时，主节点和备节点可用区不能全部相同。备机可用区集合最小为2个，最大不超过5个。", "example": "[\"ap-guangzhou-1\"]", "item_type": "string" }, { "name": "DiskEncryptFlag", "type": "integer", "required": false, "description": "磁盘加密标识，0-不加密，1-加密", "example": "0" } ], "required": [ "Zone", "Memory", "Storage", "Cpu", "MachineType" ] }, { "name": "CreateCloudReadOnlyDBInstances", "description": "本接口（CreateCloudReadOnlyDBInstances）用于创建只读实例 (云盘)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6upluvd5" }, { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-2" }, { "name": "ReadOnlyGroupType", "type": "integer", "required": true, "description": "只读组类型选项，1-按照一个实例一个只读组的方式发货，2-新建只读组后发货，所有实例都在这个只读组下面， 3-发货的所有实例都在已有的只读组下面", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "10" }, { "name": "Cpu", "type": "integer", "required": true, "description": "实例核心数", "example": "2" }, { "name": "MachineType", "type": "string", "required": true, "description": "购买实例的宿主机磁盘类型,CLOUD_HSSD-虚拟机加强型SSD云盘，CLOUD_TSSD-虚拟机极速型SSD云盘，CLOUD_BSSD-虚拟机通用型SSD云盘", "example": "CLOUD_BSSD" }, { "name": "ReadOnlyGroupForcedUpgrade", "type": "integer", "required": false, "description": "0-默认不升级主实例，1-强制升级主实例完成ro部署；主实例为非集群版时需要填1，强制升级为集群版。填1 说明您已同意将主实例升级到集群版实例。", "example": "1" }, { "name": "ReadOnlyGroupId", "type": "string", "required": false, "description": "ReadOnlyGroupType=3时必填,已存在的只读组ID", "example": "mssqlrg-dj5i29c5n" }, { "name": "ReadOnlyGroupName", "type": "string", "required": false, "description": "ReadOnlyGroupType=2时必填，新建的只读组名称", "example": "default_name" }, { "name": "ReadOnlyGroupIsOfflineDelay", "type": "integer", "required": false, "description": "ReadOnlyGroupType=2时必填，新建的只读组是否开启延迟剔除功能，1-开启，0-关闭。当只读副本与主实例延迟大于阈值后，自动剔除。", "example": "1" }, { "name": "ReadOnlyGroupMaxDelayTime", "type": "integer", "required": false, "description": "ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除的阈值。", "example": "10" }, { "name": "ReadOnlyGroupMinInGroup", "type": "integer", "required": false, "description": "ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除后至少保留只读副本的个数。", "example": "1" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。", "example": "POSTPAID" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次即将购买的实例数量，默认取值2。", "example": "2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置", "example": "subnet-gdy95gfs" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置", "example": "vpc-3xq2t5al" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例周期，默认取值为1，表示一个月。取值不超过48", "example": "1" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxx", "item_type": "string" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券；1 - 是，0 - 否，默认不使用", "example": "1" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID数组，目前单个订单只能使用一张", "example": "VoucherIds", "item_type": "string" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] }, { "name": "Collation", "type": "string", "required": false, "description": "系统字符集排序规则，默认：Chinese_PRC_CI_AS", "example": "Chinese_PRC_CI_AS" }, { "name": "TimeZone", "type": "string", "required": false, "description": "系统时区，默认：China Standard Time", "example": "China Standard Time" }, { "name": "DiskEncryptFlag", "type": "integer", "required": false, "description": "磁盘加密标识，0-不加密，1-加密", "example": "0" } ], "required": [ "InstanceId", "Zone", "ReadOnlyGroupType", "Memory", "Storage", "Cpu", "MachineType" ] }, { "name": "CreateDB", "description": "本接口（CreateDB）用于创建数据库。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-i1z41iwd" }, { "name": "DBs", "type": "array", "required": true, "description": "数据库创建信息", "example": "无", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": true, "description": "数据库名", "example": "DBName" }, { "name": "Charset", "type": "string", "required": false, "description": "字符集。可通过接口DescribeDBCharsets查到支持的字符集，不填默认为Chinese_PRC_CI_AS。", "example": "Chinese_PRC_CI_AS" }, { "name": "Accounts", "type": "array", "required": false, "description": "数据库账号权限信息", "example": "Accounts", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "数据库用户名", "example": "db_test" }, { "name": "Privilege", "type": "string", "required": true, "description": "数据库权限。ReadWrite表示可读写，ReadOnly表示只读,Delete表示删除DB对该账户的权限，DBOwner所有者", "example": "ReadOnly" }, { "name": "AccountType", "type": "string", "required": false, "description": "账户名称，L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限", "example": "L0" } ] }, { "name": "Remark", "type": "string", "required": false, "description": "备注", "example": "Remark" } ] } ], "required": [ "InstanceId", "DBs" ] }, { "name": "CreateDBInstances", "description": "本接口（CreateDBInstances）用于创建高可用实例 (本地盘)", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-1" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "100" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。", "example": "PREPAID" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "1003" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次购买几个实例，默认值为1。取值不超过10", "example": "1" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置", "example": "subnet-bdoe83fa" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置", "example": "vpc-dsp338hz" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例周期，默认取值为1，表示一个月。取值不超过48", "example": "1" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券；1 - 是，0 - 否，默认不使用", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID数组，目前单个订单只能使用一张", "example": "VoucherIds", "item_type": "string" }, { "name": "DBVersion", "type": "string", "required": false, "description": "sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同...", "example": "2008R2" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志：0-正常续费 1-自动续费，默认为1自动续费。只在购买预付费实例时有效。", "example": "0" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxxx", "item_type": "string" }, { "name": "Weekly", "type": "array", "required": false, "description": "可维护时间窗配置，以周为单位，表示周几允许维护，1-7分别代表周一到周末", "example": "1", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "可维护时间窗配置，每天可维护的开始时间", "example": "2020-04-09 00:00:00" }, { "name": "Span", "type": "integer", "required": false, "description": "可维护时间窗配置，持续时间，单位：小时", "example": "2" }, { "name": "HAType", "type": "string", "required": false, "description": "购买高可用实例的类型：DUAL-双机高可用 CLUSTER-集群，默认值为DUAL", "example": "DUAL" }, { "name": "MultiZones", "type": "boolean", "required": false, "description": "是否跨可用区部署，默认值为false", "example": "ture" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] }, { "name": "Collation", "type": "string", "required": false, "description": "系统字符集排序规则，默认：Chinese_PRC_CI_AS", "example": "Chinese_PRC_CI_AS" }, { "name": "TimeZone", "type": "string", "required": false, "description": "系统时区，默认：China Standard Time", "example": "China Standard Time" }, { "name": "MultiNodes", "type": "boolean", "required": false, "description": "是否多节点架构实例，默认值为false。当MultiNodes = true时，参数MultiZones必须取值为true。", "example": "false" }, { "name": "DrZones", "type": "array", "required": false, "description": "备节点可用区，默认为空。当MultiNodes = true时，主节点和备节点可用区不能全部相同。备机可用区集合最小为2个，最大不超过5个。", "example": "[\"ap-guangzhou-1\"]", "item_type": "string" } ], "required": [ "Zone", "Memory", "Storage" ] }, { "name": "CreateIncrementalMigration", "description": "本接口（CreateIncrementalMigration）用于创建增量备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" }, { "name": "BackupFiles", "type": "array", "required": false, "description": "增量备份文件，全量备份任务UploadType是COS_URL时这里填URL，是COS_UPLOAD这里填备份文件的名字；只支持1个备份文件，但1个备份文件内可包含多个库", "example": "[\"db_cvm_1_20200927204209_2log2_2noreconvery2.bak\\n\"]", "item_type": "string" }, { "name": "IsRecovery", "type": "string", "required": false, "description": "是否需要恢复，NO-不需要，YES-需要，默认不需要", "example": "NO" } ], "required": [ "InstanceId", "BackupMigrationId" ] }, { "name": "CreateMigration", "description": "本接口（CreateMigration）作用是创建一个迁移任务", "status": "online", "parameters": [ { "name": "MigrateName", "type": "string", "required": true, "description": "迁移任务的名称", "example": "测试接口" }, { "name": "MigrateType", "type": "integer", "required": true, "description": "迁移类型（1:结构迁移 2:数据迁移 3:增量同步）", "example": "2" }, { "name": "SourceType", "type": "integer", "required": true, "description": "迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式）", "example": "5" }, { "name": "Source", "type": "object", "required": true, "description": "迁移源", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "迁移源实例的ID，MigrateType=1(TencentDB for SQLServers)时使用，格式如：mssql-si2823jyl", "example": "mssql-si2823jyl" }, { "name": "CvmId", "type": "string", "required": false, "description": "迁移源Cvm的ID，MigrateType=2(云服务器自建SQLServer数据库)时使用", "example": "ins-62dhd3d1" }, { "name": "VpcId", "type": "string", "required": false, "description": "迁移源Cvm的Vpc网络标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：vpc-6ys9ont9", "example": "vpc-6ys9ont9" }, { "name": "SubnetId", "type": "string", "required": false, "description": "迁移源Cvm的Vpc下的子网标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：subnet-h9extioi", "example": "subnet-h9extioi" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名，MigrateType=1或MigrateType=2使用", "example": "andy" }, { "name": "Password", "type": "string", "required": false, "description": "密码，MigrateType=1或MigrateType=2使用", "example": "Zh22448899" }, { "name": "Ip", "type": "string", "required": false, "description": "迁移源Cvm自建库的内网IP，MigrateType=2(云服务器自建SQLServer数据库)时使用", "example": "172.1.1.5" }, { "name": "Port", "type": "integer", "required": false, "description": "迁移源Cvm自建库的端口号，MigrateType=2(云服务器自建SQLServer数据库)时使用", "example": "22" }, { "name": "Url", "type": "array", "required": false, "description": "离线迁移的源备份地址，MigrateType=4或MigrateType=5使用", "example": "http://gz-oncvm-1254065710.cosgz.myqcloud.com/test4_20180724021516.bak", "item_type": "string" }, { "name": "UrlPassword", "type": "string", "required": false, "description": "离线迁移的源备份密码，MigrateType=4或MigrateType=5使用", "example": "Ps55336622" } ] }, { "name": "Target", "type": "object", "required": true, "description": "迁移目标", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "迁移目标实例的ID，格式如：mssql-si2823jyl", "example": "mssql-si2823jyl" }, { "name": "UserName", "type": "string", "required": false, "description": "迁移目标实例的用户名", "example": "andy" }, { "name": "Password", "type": "string", "required": false, "description": "迁移目标实例的密码", "example": "Zh22446688" } ] }, { "name": "MigrateDBSet", "type": "array", "required": false, "description": "迁移DB对象 ，离线迁移不使用（SourceType=4或SourceType=5）。", "example": "无", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": false, "description": "迁移数据库的名称", "example": "db1" } ] }, { "name": "RenameRestore", "type": "array", "required": false, "description": "按照ReNameRestoreDatabase中的库进行恢复，并重命名，不填则按照默认方式命名恢复的库，且恢复所有的库。SourceType=5的情况下有效。", "example": "无", "item_type": "object", "children": [ { "name": "OldName", "type": "string", "required": false, "description": "库的名字，如果oldName不存在则返回失败。 在用于离线迁移任务时可不填。", "example": "db1" }, { "name": "NewName", "type": "string", "required": false, "description": "库的新名字，在用于离线迁移时，不填则按照OldName命名，OldName和NewName不能同时不填。在用于克隆数据库时，OldName和NewName都必须填写，且不能重复", "example": "db2" } ] } ], "required": [ "MigrateName", "MigrateType", "SourceType", "Source", "Target" ] }, { "name": "CreatePublishSubscribe", "description": "本接口（CreatePublishSubscribe）用于创建两个数据库之间的发布订阅关系。作为订阅者，不能再充当发布者，作为发布者可以有多个订阅者实例。", "status": "online", "parameters": [ { "name": "PublishInstanceId", "type": "string", "required": true, "description": "发布实例ID，形如mssql-j8kv137v", "example": "mssql-2cwisu23" }, { "name": "SubscribeInstanceId", "type": "string", "required": true, "description": "订阅实例ID，形如mssql-j8kv137v", "example": "mssql-hlh6yka1" }, { "name": "DatabaseTupleSet", "type": "array", "required": true, "description": "数据库的订阅发布关系集合", "example": "无", "item_type": "object", "children": [ { "name": "PublishDatabase", "type": "string", "required": true, "description": "发布数据库名称", "example": "db1" }, { "name": "SubscribeDatabase", "type": "string", "required": true, "description": "订阅数据库名称", "example": "db2" } ] }, { "name": "PublishSubscribeName", "type": "string", "required": false, "description": "发布订阅的名称，默认值为：default_name", "example": "Create_name" } ], "required": [ "PublishInstanceId", "SubscribeInstanceId", "DatabaseTupleSet" ] }, { "name": "CreateReadOnlyDBInstances", "description": "本接口（CreateReadOnlyDBInstances）用于创建只读实例 (本地盘)。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6upluvd5" }, { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-2" }, { "name": "ReadOnlyGroupType", "type": "integer", "required": true, "description": "只读组类型选项，1-按照一个实例一个只读组的方式发货，2-新建只读组后发货，所有实例都在这个只读组下面， 3-发货的所有实例都在已有的只读组下面", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "10" }, { "name": "ReadOnlyGroupForcedUpgrade", "type": "integer", "required": false, "description": "0-默认不升级主实例，1-强制升级主实例完成ro部署；主实例为非集群版时需要填1，强制升级为集群版。填1 说明您已同意将主实例升级到集群版实例。", "example": "1" }, { "name": "ReadOnlyGroupId", "type": "string", "required": false, "description": "ReadOnlyGroupType=3时必填,已存在的只读组ID", "example": "mssqlrg-dj5i29c5n" }, { "name": "ReadOnlyGroupName", "type": "string", "required": false, "description": "ReadOnlyGroupType=2时必填，新建的只读组名称", "example": "default_name" }, { "name": "ReadOnlyGroupIsOfflineDelay", "type": "integer", "required": false, "description": "ReadOnlyGroupType=2时必填，新建的只读组是否开启延迟剔除功能，1-开启，0-关闭。当只读副本与主实例延迟大于阈值后，自动剔除。", "example": "1" }, { "name": "ReadOnlyGroupMaxDelayTime", "type": "integer", "required": false, "description": "ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除的阈值。", "example": "10" }, { "name": "ReadOnlyGroupMinInGroup", "type": "integer", "required": false, "description": "ReadOnlyGroupType=2 且 ReadOnlyGroupIsOfflineDelay=1时必填，新建的只读组延迟剔除后至少保留只读副本的个数。", "example": "1" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。", "example": "POSTPAID" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次购买几个只读实例，默认值为2。", "example": "2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置", "example": "subnet-gdy95gfs" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置", "example": "vpc-3xq2t5al" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例周期，默认取值为1，表示一个月。取值不超过48", "example": "1" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxx", "item_type": "string" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券；1 - 是，0 - 否，默认不使用", "example": "1" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID数组，目前单个订单只能使用一张", "example": "VoucherIds", "item_type": "string" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "[{\"TagKey\": \"created-by\",\"TagValue\": \"andy\"}]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] }, { "name": "Collation", "type": "string", "required": false, "description": "系统字符集排序规则，默认：Chinese_PRC_CI_AS", "example": "Chinese_PRC_CI_AS" }, { "name": "TimeZone", "type": "string", "required": false, "description": "系统时区，默认：China Standard Time", "example": "China Standard Time" } ], "required": [ "InstanceId", "Zone", "ReadOnlyGroupType", "Memory", "Storage" ] }, { "name": "CutXEvents", "description": "本接口（CutXEvents）用于手动切割阻塞日志和死锁日志。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-8ua7ah" } ], "required": [ "InstanceId" ] }, { "name": "DeleteAccount", "description": "本接口（DeleteAccount）用于删除实例账号。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "UserNames", "type": "array", "required": true, "description": "实例用户名数组", "example": "[\"testusername\\r\\n\"]", "item_type": "string" } ], "required": [ "InstanceId", "UserNames" ] }, { "name": "DeleteBackupMigration", "description": "本接口（DeleteBackupMigration）用于删除备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "目标实例ID，由DescribeBackupMigration接口返回", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由DescribeBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" } ], "required": [ "InstanceId", "BackupMigrationId" ] }, { "name": "DeleteBusinessIntelligenceFile", "description": "本接口（DeleteBusinessIntelligenceFile）用于删除商业智能文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-dj5i29c5n" }, { "name": "FileNameSet", "type": "array", "required": true, "description": "文件名称集合", "example": "[\"andy.xlsx\"]", "item_type": "string" } ], "required": [ "InstanceId", "FileNameSet" ] }, { "name": "DeleteDB", "description": "本接口(DeleteDB)用于删除数据库。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-rljoi3bf", "example": "mssql-rljoi3bf" }, { "name": "Names", "type": "array", "required": true, "description": "数据库名数组", "example": "[\"test_db\\r\\n\"]", "item_type": "string" } ], "required": [ "InstanceId", "Names" ] }, { "name": "DeleteDBInstance", "description": "本接口（DeleteDBInstance）用于释放回收站中的SQL server实例(立即下线)。释放后的实例将保存一段时间后物理销毁。其发布订阅将自动解除，其ro副本将自动释放。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssql-3l3fgqn7 或 mssqlro-3l3fgqn7", "example": "mssql-ms2m7vut" } ], "required": [ "InstanceId" ] }, { "name": "DeleteIncrementalMigration", "description": "本接口（DeleteIncrementalMigration）用于删除增量备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" }, { "name": "IncrementalMigrationId", "type": "string", "required": true, "description": "增量备份导入任务ID，由CreateIncrementalMigration接口返回", "example": "mssql-incremental-migration-67q4wy87" } ], "required": [ "InstanceId", "BackupMigrationId", "IncrementalMigrationId" ] }, { "name": "DeleteMigration", "description": "本接口（DeleteMigration）用于删除迁移任务", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "2729" } ], "required": [ "MigrateId" ] }, { "name": "DeletePublishSubscribe", "description": "本接口（DeletePublishSubscribe）用于删除两个数据库间的发布订阅关系。", "status": "online", "parameters": [ { "name": "PublishSubscribeId", "type": "integer", "required": true, "description": "发布订阅ID，可通过DescribePublishSubscribe接口获得", "example": "5" }, { "name": "DatabaseTupleSet", "type": "array", "required": true, "description": "待删除的数据库的订阅发布关系集合", "example": "无", "item_type": "object", "children": [ { "name": "PublishDatabase", "type": "string", "required": true, "description": "发布数据库名称", "example": "db1" }, { "name": "SubscribeDatabase", "type": "string", "required": true, "description": "订阅数据库名称", "example": "db2" } ] } ], "required": [ "PublishSubscribeId", "DatabaseTupleSet" ] }, { "name": "DeleteRestoreTask", "description": "本接口(DeleteRestoreTask)用于删除回档任务记录。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-8u99wqu1" }, { "name": "RestoreIds", "type": "array", "required": true, "description": "回档任务记录ID集合，一次最多删除10条", "example": "[10001]", "item_type": "integer" } ], "required": [ "InstanceId", "RestoreIds" ] }, { "name": "DescribeAccountPrivilegeByDB", "description": "本接口(DescribeAccountPrivilegeByDB)用于查询数据库关联的账号和权限信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "DBName", "type": "string", "required": true, "description": "数据库名称", "example": "db_name" }, { "name": "AccountName", "type": "string", "required": false, "description": "数据库属于账号名称", "example": "acc_test" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" } ], "required": [ "InstanceId", "DBName" ] }, { "name": "DescribeAccounts", "description": "本接口（DescribeAccounts）用于拉取实例账户列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "账号名称", "example": "andy_sa" }, { "name": "OrderBy", "type": "string", "required": false, "description": "createTime,updateTime,passTime\" note:\"排序字段，默认按照账号创建时间倒序", "example": "createTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序规则（desc-降序，asc-升序），默认desc", "example": "desc" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupByFlowId", "description": "本接口(DescribeBackupByFlowId)用于通过备份创建流程的ID查询创建的备份详情，流程ID可从接口CreateBackup中获得。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6upluvd5" }, { "name": "FlowId", "type": "string", "required": true, "description": "创建备份流程ID，可通过 [CreateBackup](https://cloud.tencent.com/document/product/238/19946) 接口获取", "example": "1000797" } ], "required": [ "InstanceId", "FlowId" ] }, { "name": "DescribeBackupCommand", "description": "本接口（DescribeBackupCommand）用于查询以规范的格式创建备份的命令。", "status": "online", "parameters": [ { "name": "BackupFileType", "type": "string", "required": true, "description": "备份文件类型，FULL-全量备份，FULL_LOG-全量备份需要日志增量，FULL_DIFF-全量备份需要差异增量，LOG-日志备份，DIFF-差异备份", "example": "FULL" }, { "name": "DataBaseName", "type": "string", "required": true, "description": "数据库名称", "example": "db1" }, { "name": "IsRecovery", "type": "string", "required": true, "description": "是否需要恢复，NO-不需要，YES-需要", "example": "YES" }, { "name": "LocalPath", "type": "string", "required": false, "description": "备份文件保存的路径；如果不填则默认在D:\\\\", "example": "E:/" } ], "required": [ "BackupFileType", "DataBaseName", "IsRecovery" ] }, { "name": "DescribeBackupFiles", "description": "本接口（DescribeBackupFiles）用于查询单库备份明细。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "GroupId", "type": "string", "required": true, "description": "单库备份的聚合ID, 可通过接口DescribeBackups获取（不支持查询打包备份记录）", "example": "241259" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "按照备份的库名称筛选，不填则不筛选此项", "example": "db1" }, { "name": "OrderBy", "type": "string", "required": false, "description": "列表项排序，desc-降序、asc-升序，按size排序默认desc，按database排序默认asc", "example": "desc" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序字段（Size-按备份大小排序，DBs-按数据库名称排序），默认size", "example": "Size" } ], "required": [ "InstanceId", "GroupId" ] }, { "name": "DescribeBackupMigration", "description": "本接口（DescribeBackupMigration）用于创建增量备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": false, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-kpl74n9l" }, { "name": "MigrationName", "type": "string", "required": false, "description": "导入任务名称", "example": "字符串" }, { "name": "BackupFileName", "type": "string", "required": false, "description": "备份文件名称", "example": "db1" }, { "name": "StatusSet", "type": "array", "required": false, "description": "导入任务状态集合", "example": "[\"2\\n\"]", "item_type": "integer" }, { "name": "RecoveryType", "type": "string", "required": false, "description": "导入任务恢复类型，FULL,FULL_LOG,FULL_DIFF", "example": "FULL" }, { "name": "UploadType", "type": "string", "required": false, "description": "COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，用户上传", "example": "COS_UPLOAD" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，页大小，默认值：100", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页，页数，默认值：0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，name；createTime；startTime；endTime，默认按照createTime递增排序。", "example": "createTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，desc-递减排序，asc-递增排序。默认按照asc排序，且在OrderBy为有效值时，本参数有效", "example": "desc" } ], "required": [ "InstanceId" ] }, { "name": "DescribeBackupMonitor", "description": "本接口(DescribeBackupMonitor)用于查询备份空间使用详情。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "备份空间使用详情开始时间", "example": "2022-05-05 22:12:27" }, { "name": "EndTime", "type": "string", "required": true, "description": "备份空间使用详情结束时间", "example": "2022-05-05 22:12:27" }, { "name": "Type", "type": "string", "required": false, "description": "备份趋势查询类型，local-本地备份，cross-跨地域备份", "example": "local" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeBackupStatistical", "description": "本接口(DescribeBackupStatistical)用于查询备份实时统计列表。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页返回，每页返回的数目，取值为1-100，默认值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页返回，页编号，默认值为第0页。", "example": "0" }, { "name": "InstanceIdSet", "type": "array", "required": false, "description": "一个或者多个实例ID。实例ID，格式如：mssql-si2823jyl。", "example": "[\"mssql-7vfv3rk3\"]", "item_type": "string" }, { "name": "InstanceNameSet", "type": "array", "required": false, "description": "实例名称列表，模糊查询。", "example": "[\"name\"]", "item_type": "string" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，默认default，则按照备份空间降序。 default 按照备份空间排序 data 数据备份排序 log 日志备份排序 auto 自动备份排序 manual 手动备份排序", "example": "order" }, { "name": "OrderByType", "type": "string", "required": false, "description": "默认降序，[desc-降序，asc-升序]。", "example": "desc" } ], "required": [ "Limit", "Offset" ] }, { "name": "DescribeBackupSummary", "description": "本接口(DescribeBackupSummary)用于查询数据库备份概览信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeBackupUploadSize", "description": "本接口（DescribeBackupUploadSize）用于查询上传的备份文件大小。在备份上传类型是COS_UPLOAD(备份放在业务的对象存储上)时有效。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-kpl74n9l" }, { "name": "IncrementalMigrationId", "type": "string", "required": false, "description": "增量导入任务ID", "example": "mssql-incremental-migration-kp7bgv8p" } ], "required": [ "InstanceId", "BackupMigrationId" ] }, { "name": "DescribeBackups", "description": "本接口(DescribeBackups)用于查询备份列表。", "status": "online", "parameters": [ { "name": "StartTime", "type": "string", "required": true, "description": "开始时间(yyyy-MM-dd HH:mm:ss)", "example": "2018-03-28 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间(yyyy-MM-dd HH:mm:ss)", "example": "2018-04-20 00:00:00" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "BackupName", "type": "string", "required": false, "description": "按照备份名称筛选，不填则不筛选此项", "example": "DBName" }, { "name": "Strategy", "type": "integer", "required": false, "description": "按照备份策略筛选，0-实例备份，1-多库备份，不填则不筛选此项", "example": "0" }, { "name": "BackupWay", "type": "integer", "required": false, "description": "按照备份方式筛选，0-后台自动定时备份，1-用户手动临时备份，2-定期备份，不填则不筛选此项", "example": "0" }, { "name": "BackupId", "type": "integer", "required": false, "description": "按照备份ID筛选，不填则不筛选此项", "example": "558800" }, { "name": "DatabaseName", "type": "string", "required": false, "description": "按照备份的库名称筛选，不填则不筛选此项", "example": "db1" }, { "name": "Group", "type": "integer", "required": false, "description": "是否分组查询，默认是0，单库备份情况下 0-兼容老方式不分组，1-单库备份分组后展示", "example": "0" }, { "name": "Type", "type": "integer", "required": false, "description": "备份类型，1-数据备份，2-日志备份，默认值为1", "example": "1" }, { "name": "BackupFormat", "type": "string", "required": false, "description": "按照备份文件形式筛选，pkg-打包备份文件，single-单库备份文件", "example": "pkg" }, { "name": "StorageStrategy", "type": "integer", "required": false, "description": "备份存储策略 0-跟随自定义备份保留策略 1-跟随实例生命周期直到实例下线，默认取值0", "example": "0" } ], "required": [ "StartTime", "EndTime", "InstanceId" ] }, { "name": "DescribeBusinessIntelligenceFile", "description": "本接口（DescribeBusinessIntelligenceFile）用于查询商业智能服务需要的文件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-dj5i29c5n" }, { "name": "FileName", "type": "string", "required": false, "description": "文件名称", "example": "file.txt" }, { "name": "StatusSet", "type": "array", "required": false, "description": "迁移任务状态集合,1-初始化待部署 2-部署中 3-部署成功 4-部署失败", "example": "1", "item_type": "integer" }, { "name": "FileType", "type": "string", "required": false, "description": "文件类型 FLAT-平面文件，SSIS商业智能服务项目文件", "example": "FLAT" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，页大小，范围1-100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页,页数，默认0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，可选值file_name,create_time,start_time", "example": "file_name" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，desc,asc", "example": "desc" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCollationTimeZone", "description": "本接口(DescribeCollationTimeZone)用于查询实例支持的字符集和时区。", "status": "online", "parameters": [ { "name": "MachineType", "type": "string", "required": false, "description": "购买实例的宿主机类型，PM-物理机, CLOUD_PREMIUM-云服务器高性能云盘， CLOUD_SSD-云服务器SSD云盘,CLOUD_HSSD-云服务器加强型SSD云盘，CLOUD_TSSD-云服务器极速型SSD云盘，CLOUD_BSSD-云服务器通用型SSD云盘,CLOUD_BASIC-云服务器云硬盘，默认取值PM", "example": "CLOUD_PREMIUM" }, { "name": "DBVersion", "type": "string", "required": false, "description": "购买实例版本号", "example": "2008R2" } ], "required": [] }, { "name": "DescribeCrossBackupStatistical", "description": "本接口(DescribeCrossBackupStatistical)用于查询跨地域备份实时统计列表。", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "分页,页数", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页，页大小", "example": "10" }, { "name": "InstanceIdSet", "type": "array", "required": false, "description": "实例ID列表", "example": "[\"mssql-6upluvd5\"]", "item_type": "string" }, { "name": "InstanceNameSet", "type": "array", "required": false, "description": "实例名称列表", "example": "[\"name\"]", "item_type": "string" }, { "name": "CrossBackupStatus", "type": "string", "required": false, "description": "跨地域备份状态，enable-开启，disable-关闭", "example": "enable" }, { "name": "CrossRegion", "type": "string", "required": false, "description": "跨地域备份目标地域", "example": "ap-guangzhou" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，默认default-按照备份空间降序排序，data-按照数据备份排序，log-按照日志备份", "example": "instanceId" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序规则（desc-降序，asc-升序），默认desc", "example": "desc" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeCrossRegionZone", "description": "本接口(DescribeCrossRegionZone)根据主实例查询备机的容灾地域和可用区。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6upluvd5" } ], "required": [ "InstanceId" ] }, { "name": "DescribeCrossRegions", "description": "本接口(DescribeCrossRegions)用于查询跨地域备份的目标地域。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDBCharsets", "description": "本接口（DescribeDBCharsets）用于查询实例支持的数据库字符集。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-j8kv137v" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBInstanceInter", "description": "本接口（DescribeDBInstanceInter）用于查询互通实例的信息。", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "分页，页大小，范围是1-100", "example": "10" }, { "name": "InstanceId", "type": "string", "required": false, "description": "按照实例ID筛选", "example": "mssql-dj5i29c5n" }, { "name": "Status", "type": "integer", "required": false, "description": "按照状态筛选 1-互通IP打开中；2-互通IP已经打开；3-加入到互通组中；4-已加入到互通组；5-互通IP回收中；6-互通IP已回收；7-从互通组移除中；8-已从互通组中移除", "example": "1" }, { "name": "VersionSet", "type": "array", "required": false, "description": "实例版本代号列表", "example": "[\"2008R2\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "实例所在可用区，格式如：ap-guangzhou-2", "example": "ap-guangzhou-2" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页，页数，默认是0", "example": "0" } ], "required": [ "Limit" ] }, { "name": "DescribeDBInstances", "description": "本接口（DescribeDBInstances）用于查询实例列表。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "0" }, { "name": "Status", "type": "integer", "required": false, "description": "实例状态。取值范围： 1：申请中 2：运行中 3：受限运行中 (主备切换中) 4：已隔离 5：回收中 6：已回收 7：任务执行中 (实例做备份、回档等操作) 8：已下线 9：实例扩容中 10：实例迁移中 11：只读 12：重启中", "example": "2" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为100", "example": "3" }, { "name": "InstanceIdSet", "type": "array", "required": false, "description": "一个或者多个实例ID。实例ID，格式如：mssql-si2823jyl", "example": "[\"mssql-3l3fgqn7\\n\"]", "item_type": "string" }, { "name": "PayMode", "type": "integer", "required": false, "description": "付费类型检索 1-包年包月，0-按量计费", "example": "1" }, { "name": "VpcId", "type": "string", "required": false, "description": "实例所属VPC的唯一字符串ID，格式如：vpc-xxx，传空字符串(“”)则按照基础网络筛选。", "example": "vpc-mknbt351" }, { "name": "SubnetId", "type": "string", "required": false, "description": "实例所属子网的唯一字符串ID，格式如： subnet-xxx，传空字符串(“”)则按照基础网络筛选。", "example": "subnet-f72hylo6" }, { "name": "VipSet", "type": "array", "required": false, "description": "实例内网地址列表，格式如：172.1.0.12", "example": "[\"172.1.0.12\\n\"]", "item_type": "string" }, { "name": "InstanceNameSet", "type": "array", "required": false, "description": "实例名称列表，模糊查询", "example": "[\"\\u6570\\u4ed3\\n\"]", "item_type": "string" }, { "name": "VersionSet", "type": "array", "required": false, "description": "实例版本代号列表，格式如：2008R2，2012SP3等", "example": "[\"2008R2\\n\"]", "item_type": "string" }, { "name": "Zone", "type": "string", "required": false, "description": "实例可用区", "example": "ap-guangzhou-3" }, { "name": "TagKeys", "type": "array", "required": false, "description": "实例标签列表", "example": "[\"\\u6d4b\\u8bd5tag\\n\"]", "item_type": "string" }, { "name": "SearchKey", "type": "string", "required": false, "description": "模糊查询关键字，支持实例id、实例名、内网ip", "example": "172.17.0.12" }, { "name": "UidSet", "type": "array", "required": false, "description": "实例唯一Uid列表", "example": "[\"gamedb.gz1.cdb.db\"]", "item_type": "string" }, { "name": "InstanceType", "type": "string", "required": false, "description": "实例类型 HA-高可用 RO-只读实例 SI-基础版 BI-商业智能服务,cvmHA-云盘双机高可用，cvmRO-云盘只读副本,MultiHA-多节点,cvmMultiHA-云盘多节点", "example": "HA" }, { "name": "PaginationType", "type": "string", "required": false, "description": "分页查询方式 offset-按照偏移量分页查询，pageNumber-按照页数分页查询，默认取值pageNumber", "example": "pageNumber" } ], "required": [] }, { "name": "DescribeDBInstancesAttribute", "description": "本接口（DescribeDBInstancesAttribute）用于查询实例附属属性", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBPrivilegeByAccount", "description": "本接口(DescribeDBPrivilegeByAccount)用于查询账号关联的数据库和权限信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "AccountName", "type": "string", "required": true, "description": "账号名称", "example": "acc_test" }, { "name": "DBName", "type": "string", "required": false, "description": "账号关联的数据库名称", "example": "db_test" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" } ], "required": [ "InstanceId", "AccountName" ] }, { "name": "DescribeDBRestoreTime", "description": "本接口（DescribeDBRestoreTime）用于查询可回档的数据库", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "原实例ID", "example": "mssql-j8kv137v" }, { "name": "TargetInstanceId", "type": "string", "required": false, "description": "回档的目标实例ID，不填则回档到原实例ID", "example": "mssql-j8kv13ui1" }, { "name": "Time", "type": "string", "required": false, "description": "按时间点查询可回档数据库，时间格式 YYYY-MM-DD HH:MM:SS。BackupId，Time二选一，不能同时为空", "example": "2023-01-01 12:00:00" }, { "name": "BackupId", "type": "integer", "required": false, "description": "按备份集ID查询可回档数据库，可通过DescribeBackups接口获取。BackupId，Time二选一不能同时为空", "example": "890110" }, { "name": "DBName", "type": "string", "required": false, "description": "数据库名称", "example": "test_db" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBSecurityGroups", "description": "本接口(DescribeDBSecurityGroups)用于查询实例的安全组详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssql-c1nl9rpv或者mssqlro-c1nl9rpv，与云数据库控制台页面中显示的实例ID相同。", "example": "mssql-6f4ddx2f " } ], "required": [ "InstanceId" ] }, { "name": "DescribeDBs", "description": "本接口（DescribeDBs）用于查询数据库列表。**已废弃，请使用接口DescribeDatabases**", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "实例ID", "example": "[\"mssql-njj2mtpl\\r\\n\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "数据库名称", "example": "test_db" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序规则（desc-降序，asc-升序），默认desc", "example": "desc" }, { "name": "Encryption", "type": "string", "required": false, "description": "是否已开启TDE加密，enable-已加密，disable-未加密", "example": "disable" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段（Name-按名称排序，CreateTime-按创建时间排序），默认CreateTime", "example": "CreateTime" } ], "required": [ "InstanceIdSet" ] }, { "name": "DescribeDBsNormal", "description": "本接口(DescribeDBsNormal)用于查询数据库配置信息，此接口不包含数据库的关联账号。**此接口已废弃，请使用DescribeDatabasesNormal。**", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-7vfv3rk3", "example": "mssql-7vfv3rk3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeDatabaseNames", "description": "本接口（DescribeDatabaseNames）查询账户关联的数据库名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-rljoi3bf", "example": "mssql-njj2mtpl" }, { "name": "AccountName", "type": "string", "required": true, "description": "账户名称", "example": "account11" } ], "required": [ "InstanceId", "AccountName" ] }, { "name": "DescribeDatabases", "description": "本接口（DescribeDatabases）用于查询数据库列表。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "实例ID", "example": "[\"mssql-njj2mtpl\\r\\n\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "Name", "type": "string", "required": false, "description": "数据库名称", "example": "test_db" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序规则（desc-降序，asc-升序），默认desc", "example": "desc" }, { "name": "Encryption", "type": "string", "required": false, "description": "是否已开启TDE加密，enable-已加密，disable-未加密", "example": "disable" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段（Name-按名称排序，CreateTime-按创建时间排序），默认CreateTime", "example": "CreateTime" } ], "required": [ "InstanceIdSet" ] }, { "name": "DescribeDatabasesNormal", "description": "本接口(DescribeDBsNormal)用于查询数据库配置信息，此接口不包含数据库的关联账号", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-7vfv3rk3", "example": "mssql-7vfv3rk3" } ], "required": [ "InstanceId" ] }, { "name": "DescribeFlowStatus", "description": "本接口(DescribeFlowStatus)用于查询流程状态。", "status": "online", "parameters": [ { "name": "FlowId", "type": "integer", "required": true, "description": "流程ID", "example": "30403" } ], "required": [ "FlowId" ] }, { "name": "DescribeHASwitchLog", "description": "本接口(DescribeHASwitchLog)用于手动主备切换。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-8ua7ah" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间(yyyy-MM-dd HH:mm:ss)", "example": "2023-01-01 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间(yyyy-MM-dd HH:mm:ss)", "example": "2023-01-01 00:00:00" }, { "name": "SwitchType", "type": "integer", "required": false, "description": "切换模式 0-系统自动切换，1-手动切换，不填默认查全部。", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，页大小", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页,页数", "example": "0" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeIncrementalMigration", "description": "本接口（DescribeIncrementalMigration）用于查询增量备份导入任务。", "status": "online", "parameters": [ { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" }, { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupFileName", "type": "string", "required": false, "description": "备份文件名称", "example": "cvm" }, { "name": "StatusSet", "type": "array", "required": false, "description": "导入任务状态集合", "example": "[\"2\\n\"]", "item_type": "integer" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，页大小，默认值：100", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页，页数，默认值：0", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，name；createTime；startTime；endTime，默认按照createTime递增排序。", "example": "createTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，desc-递减排序，asc-递增排序。默认按照asc排序，且在OrderBy为有效值时，本参数有效", "example": "desc" }, { "name": "IncrementalMigrationId", "type": "string", "required": false, "description": "增量备份导入任务ID，由CreateIncrementalMigration接口返回", "example": "mssql-incremental-migration-kp7bgv8p" } ], "required": [ "BackupMigrationId", "InstanceId" ] }, { "name": "DescribeInquiryPriceParameter", "description": "本接口（DescribeInquiryPriceParameter）用于查询实例询价计费参数。当前接口查询实例新购的计费参数。内部接口用于活动页售卖场景。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。", "example": "ap-guangzhou-2" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例容量大小，单位：GB。", "example": "300" }, { "name": "InstanceType", "type": "string", "required": true, "description": "购买实例的类型 HA-高可用型(包括双机高可用，alwaysOn集群)，RO-只读副本型，SI-单节点型,cvmHA-新版高可用,cvmRO-新版只读，MultiHA-多节点，cvmMultiHA-云盘多节点", "example": "HA" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "计费类型，取值支持 PREPAID，POSTPAID。", "example": "POSTPAID" }, { "name": "Cpu", "type": "integer", "required": false, "description": "预购买实例的CPU核心数", "example": "2" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月。取值为1到48，默认为1", "example": "1" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "一次性购买的实例数量。取值1-100，默认取值为1", "example": "1" }, { "name": "DBVersion", "type": "string", "required": false, "description": "sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同...", "example": "2008R2" }, { "name": "MachineType", "type": "string", "required": false, "description": "购买实例的宿主机类型，PM-物理机, CLOUD_PREMIUM-云服务器高性能云盘，CLOUD_SSD-云服务器SSD云盘, CLOUD_HSSD-云服务器加强型SSD云盘，CLOUD_TSSD-云服务器极速型SSD云盘，CLOUD_BSSD-云服务器通用型SSD云盘", "example": "PM" }, { "name": "DrZones", "type": "array", "required": false, "description": "备节点可用区，默认为空。如果是多节点架构时必传，并且备机可用区集合最小为2个，最大不超过5个。", "example": "[\"ap-guangzhou-1\"]", "item_type": "string" } ], "required": [ "Zone", "Memory", "Storage", "InstanceType" ] }, { "name": "DescribeInstanceByOrders", "description": "本接口（DescribeInstanceByOrders）用于根据订单号查询资源ID", "status": "online", "parameters": [ { "name": "DealNames", "type": "array", "required": true, "description": "订单号集合", "example": "[2023010191871]", "item_type": "string" } ], "required": [ "DealNames" ] }, { "name": "DescribeInstanceParamRecords", "description": "该接口（DescribeInstanceParamRecords）用于查询实例参数修改历史。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：mssql-dj5i29c5n，与云数据库控制台页面中显示的实例 ID 相同，可使用 DescribeDBInstances 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "mssql-dj5i29c5n" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页，页数，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，页大小，默认20，最大不超过100", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceParams", "description": "该接口（DescribeInstanceParams）用于查询实例的参数列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：mssql-dj5i29c5n，与云数据库控制台页面中显示的实例 ID 相同，可使用 DescribeDBInstances 接口获取，其值为输出参数中字段 InstanceId 的值。", "example": "mssql-dj5i29c5n" } ], "required": [ "InstanceId" ] }, { "name": "DescribeInstanceTasks", "description": "本接口（DescribeInstanceTasks）用于查询实例相关的异步任务列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页大小", "example": "10" }, { "name": "Status", "type": "integer", "required": false, "description": "异步任务状态 1-运行中，2-运行成功，3-运行失败", "example": "2" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" } ], "required": [ "InstanceId", "Limit" ] }, { "name": "DescribeInstanceTradeParameter", "description": "本接口（DescribeInstanceTradeParameter）用于查询实例的计费参数", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "实例可用区，类似ap-guangzhou-1（广州一区）；实例可售卖区域可以通过接口DescribeZones获取", "example": "ap-guangzhou-1" }, { "name": "Cpu", "type": "integer", "required": true, "description": "实例核心数", "example": "2" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例内存大小，单位GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例磁盘大小，单位GB", "example": "100" }, { "name": "InstanceType", "type": "string", "required": true, "description": "购买实例的类型 HA-高可用型(包括双机高可用，alwaysOn集群)，RO-只读副本型，SI-单节点型,BI-商业智能服务,cvmHA-新版高可用,cvmRO-新版只读，MultiHA-多节点，cvmMultiHA-云盘多节点", "example": "cvmHA" }, { "name": "MachineType", "type": "string", "required": true, "description": "购买实例的宿主机磁盘类型,CLOUD_HSSD-云服务器加强型SSD云盘，CLOUD_TSSD-云服务器极速型SSD云盘，CLOUD_BSSD-云服务器通用型SSD云盘", "example": "CLOUD_BSSD" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费模式，取值支持 PREPAID（预付费），POSTPAID（后付费）。", "example": "PREPAID" }, { "name": "ProjectId", "type": "integer", "required": false, "description": "项目ID", "example": "1003" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "本次购买几个实例，默认值为1。取值不超过10", "example": "1" }, { "name": "DBVersion", "type": "string", "required": false, "description": "sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同...", "example": "2008R2" }, { "name": "SubnetId", "type": "string", "required": false, "description": "VPC子网ID，形如subnet-bdoe83fa；SubnetId和VpcId需同时设置或者同时不设置", "example": "subnet-bdoe83fa" }, { "name": "VpcId", "type": "string", "required": false, "description": "VPC网络ID，形如vpc-dsp338hz；SubnetId和VpcId需同时设置或者同时不设置", "example": "vpc-dsp338hz" }, { "name": "Period", "type": "integer", "required": false, "description": "购买实例周期，默认取值为1，表示一个月。取值不超过48", "example": "1" }, { "name": "SecurityGroupList", "type": "array", "required": false, "description": "安全组列表，填写形如sg-xxx的安全组ID", "example": "sg-xxxx", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "自动续费标志：0-正常续费 1-自动续费，默认为1自动续费。只在购买预付费实例时有效。", "example": "0" }, { "name": "Weekly", "type": "array", "required": false, "description": "可维护时间窗配置，以周为单位，表示周几允许维护，1-7分别代表周一到周末", "example": "1", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "可维护时间窗配置，每天可维护的开始时间", "example": "2020-04-09 00:00:00" }, { "name": "Span", "type": "integer", "required": false, "description": "可维护时间窗配置，持续时间，单位：小时", "example": "2" }, { "name": "MultiZones", "type": "boolean", "required": false, "description": "是否跨可用区部署，默认值为false", "example": "ture" }, { "name": "ResourceTags", "type": "array", "required": false, "description": "新建实例绑定的标签集合", "example": "[resource tag]", "item_type": "object", "children": [ { "name": "TagKey", "type": "string", "required": false, "description": "标签key", "example": "created-by" }, { "name": "TagValue", "type": "string", "required": false, "description": "标签value", "example": "andy" } ] }, { "name": "TimeZone", "type": "string", "required": false, "description": "系统时区，默认：China Standard Time", "example": "China Standard Time" }, { "name": "Collation", "type": "string", "required": false, "description": "系统字符集排序规则，默认：Chinese_PRC_CI_AS", "example": "Chinese_PRC_CI_AS" }, { "name": "MultiNodes", "type": "boolean", "required": false, "description": "是否多节点架构，默认值为false", "example": "false" }, { "name": "DrZones", "type": "array", "required": false, "description": "备节点可用区，默认为空。如果是多节点架构时必传，并且当MultiZones=true时备节点可用区不能全部相同。备机可用区集合最小为2个，最大不超过5个。", "example": "[\"ap-guangzhou-1\"]", "item_type": "string" } ], "required": [ "Zone", "Cpu", "Memory", "Storage", "InstanceType", "MachineType" ] }, { "name": "DescribeMaintenanceSpan", "description": "本接口（DescribeMaintenanceSpan）根据实例ID查询该实例的可维护时间窗。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-k8voqdlz", "example": "mssql-6upluvd5" } ], "required": [ "InstanceId" ] }, { "name": "DescribeMigrationDatabases", "description": "本接口（DescribeMigrationDatabases）的作用是查询待迁移数据库列表", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "迁移源实例的ID，格式如：mssql-si2823jyl", "example": "mssql-si2823jyl" }, { "name": "UserName", "type": "string", "required": true, "description": "迁移源实例用户名", "example": "sqlserver_admin" }, { "name": "Password", "type": "string", "required": true, "description": "迁移源实例密码", "example": "Qy2255778899" } ], "required": [ "InstanceId", "UserName", "Password" ] }, { "name": "DescribeMigrationDetail", "description": "本接口（DescribeMigrationDetail）用于查询迁移任务的详细情况", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "2728" } ], "required": [ "MigrateId" ] }, { "name": "DescribeMigrations", "description": "本接口（DescribeMigrations）根据输入的限定条件，查询符合条件的迁移任务列表", "status": "online", "parameters": [ { "name": "StatusSet", "type": "array", "required": false, "description": "状态集合。只要符合集合中某一状态的迁移任务，就会查出来", "example": "[\"1\\r\\n\",\"4\\r\\n\"]", "item_type": "integer" }, { "name": "MigrateName", "type": "string", "required": false, "description": "迁移任务的名称，模糊匹配", "example": "andy_Migrate" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为100", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "OrderBy", "type": "string", "required": false, "description": "查询结果按照关键字排序，可选值为name、createTime、startTime，endTime，status", "example": "name" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序方式，可选值为desc、asc", "example": "desc" } ], "required": [] }, { "name": "DescribeOrders", "description": "本接口（DescribeOrders）用于查询订单信息", "status": "online", "parameters": [ { "name": "DealNames", "type": "array", "required": true, "description": "订单数组。发货时会返回订单名字，利用该订单名字调用DescribeOrders接口查询发货情况", "example": "[\"201806271245\\r\\n\"]", "item_type": "string" } ], "required": [ "DealNames" ] }, { "name": "DescribeProductConfig", "description": "本接口（DescribeProductConfig）用于查询售卖规格配置。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区英文 ID", "example": "ap-guangzhou-3" }, { "name": "InstanceType", "type": "string", "required": false, "description": "购买实例的类型 HA-本地盘高可用(包括双机高可用，alwaysOn集群)，RO-本地盘只读副本，SI-云盘版单节点,BI-商业智能服务，cvmHA-云盘版高可用，cvmRO-云盘版只读副本，MultiHA-多节点，cvmMultiHA-云盘多节点", "example": "HA" } ], "required": [ "Zone" ] }, { "name": "DescribeProductSpec", "description": "本接口 (DescribeProductSpec) 用于查询全地域售卖规格配置（内部前端使用不公开）", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeProjectSecurityGroups", "description": "本接口(DescribeProjectSecurityGroups)用于查询项目的安全组详情。", "status": "online", "parameters": [ { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID，可通过控制台项目管理中查看", "example": "0" } ], "required": [ "ProjectId" ] }, { "name": "DescribePublishSubscribe", "description": "本接口（DescribePublishSubscribe）用于查询发布订阅关系列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-12klhrx2c" }, { "name": "PubOrSubInstanceId", "type": "string", "required": false, "description": "订阅/发布实例ID，与InstanceId是发布实例还是订阅实例有关；当InstanceId为发布实例时，本字段按照订阅实例ID做筛选；当InstanceId为订阅实例时，本字段按照发布实例ID做筛选；", "example": "mssql-hh598yjo" }, { "name": "PubOrSubInstanceIp", "type": "string", "required": false, "description": "订阅/发布实例内网IP，与InstanceId是发布实例还是订阅实例有关；当InstanceId为发布实例时，本字段按照订阅实例内网IP做筛选；当InstanceId为订阅实例时，本字段按照发布实例内网IP做筛选；", "example": "10.0.1.27" }, { "name": "PublishSubscribeId", "type": "integer", "required": false, "description": "订阅发布ID，用于筛选", "example": "5" }, { "name": "PublishSubscribeName", "type": "string", "required": false, "description": "订阅发布名字，用于筛选", "example": "Change_name" }, { "name": "PublishDBName", "type": "string", "required": false, "description": "发布库名字，用于筛选", "example": "PublishDBName" }, { "name": "SubscribeDBName", "type": "string", "required": false, "description": "订阅库名字，用于筛选", "example": "SubscribeDBName" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页，页数", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页，页大小", "example": "10" } ], "required": [ "InstanceId" ] }, { "name": "DescribeReadOnlyGroupAutoWeight", "description": "本接口（DescribeReadOnlyGroupAutoWeight）用于查询只读组的自动权重分配结果，在接口BalanceReadOnlyGroup接口中按照自动权重分配结果进行路由权重分配。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-dj5i29c5n" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID，格式如：mssqlro-3l3fgqn7", "example": "mssqlro-dj5i29c5n" } ], "required": [ "InstanceId", "ReadOnlyGroupId" ] }, { "name": "DescribeReadOnlyGroupByReadOnlyInstance", "description": "本接口（DescribeReadOnlyGroupByReadOnlyInstance）用于通过只读副本实例ID查询其所在的只读组。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssqlro-3l3fgqn7", "example": "mssqlro-91masbl1" } ], "required": [ "InstanceId" ] }, { "name": "DescribeReadOnlyGroupDetails", "description": "本接口（DescribeReadOnlyGroupDetails）用于查询只读组详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6f4ddx2f" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID，格式如：mssqlrg-3l3fgqn7", "example": "mssqlrg-552tyamb" } ], "required": [ "InstanceId", "ReadOnlyGroupId" ] }, { "name": "DescribeReadOnlyGroupList", "description": "本接口（DescribeReadOnlyGroupList）用于查询只读组列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6f4ddx2f" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRegions", "description": "本接口 (DescribeRegions) 用于查询售卖地域信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRegularBackupPlan", "description": "本接口（DescribeRegularBackupPlan）用于查询实例定期备份保留计划", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "RegularBackupSaveDays", "type": "integer", "required": true, "description": "定期备份保留天数 [90 - 3650]天，默认365天", "example": "90" }, { "name": "RegularBackupStrategy", "type": "string", "required": true, "description": "定期备份策略 years-每年，quarters-每季度，months-每月，默认months", "example": "months" }, { "name": "RegularBackupCounts", "type": "integer", "required": true, "description": "定期备份保留个数，默认1个", "example": "1" }, { "name": "RegularBackupStartTime", "type": "string", "required": true, "description": "定期备份开始日期，格式-YYYY-MM-DD 默认当前日期", "example": "2022-10-10" }, { "name": "BackupCycle", "type": "array", "required": true, "description": "常规备份周期", "example": "[1,2,3,4,5,6,7]", "item_type": "integer" } ], "required": [ "InstanceId", "RegularBackupSaveDays", "RegularBackupStrategy", "RegularBackupCounts", "RegularBackupStartTime", "BackupCycle" ] }, { "name": "DescribeRestoreTask", "description": "本接口（DescribeRestoreTask）用于查询回档任务列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "源实例ID", "example": "mssql-8943uijh21" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间", "example": "2023-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间", "example": "2023-01-01 13:00:00" }, { "name": "RestoreType", "type": "integer", "required": false, "description": "回档方式，0-按照时间点回档，1-按照备份集回档", "example": "1" }, { "name": "TargetRegion", "type": "string", "required": false, "description": "回档的目标实例所在地域", "example": "ap-shanghai" }, { "name": "TargetType", "type": "integer", "required": false, "description": "回档到目标实例的类型，0-当前实例，1-已有实例，2-全新实例", "example": "0" }, { "name": "Status", "type": "integer", "required": false, "description": "回档状态，0-初始化，1-运行中，2-成功，3-失败", "example": "2" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "20" }, { "name": "OrderBy", "type": "string", "required": false, "description": "排序字段，restoreTime-回档时间，startTime-任务开始时间，endTime-任务结束时间，默认按照任务开始时间降序", "example": "startTime" }, { "name": "OrderByType", "type": "string", "required": false, "description": "排序规则（desc-降序，asc-升序），默认desc", "example": "desc" }, { "name": "FlowId", "type": "integer", "required": false, "description": "回档异步任务ID", "example": "0" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeRestoreTimeRange", "description": "本接口(DescribeRestoreTimeRange)用于查询按照时间点可回档的时间范围。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "TargetInstanceId", "type": "string", "required": false, "description": "回档的目标实例ID，不填默认回档到原实例", "example": "mssql-dj5i29c5n" } ], "required": [ "InstanceId" ] }, { "name": "DescribeRollbackTime", "description": "本接口（DescribeRollbackTime）用于查询实例可回档时间范围", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "DBs", "type": "array", "required": true, "description": "需要查询的数据库列表", "example": "[\"db1\\r\\n\"]", "item_type": "string" } ], "required": [ "InstanceId", "DBs" ] }, { "name": "DescribeSlowlogs", "description": "本接口（DescribeSlowlogs）用于获取慢查询日志文件信息", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-k8voqdlz", "example": "mssql-9aajrcn7" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间(yyyy-MM-dd HH:mm:ss)", "example": "2018-03-28 00:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间(yyyy-MM-dd HH:mm:ss)", "example": "2020-11-20 00:00:00" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1-100，默认值为20", "example": "20" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" } ], "required": [ "InstanceId", "StartTime", "EndTime" ] }, { "name": "DescribeSpecSellStatus", "description": "本接口（DescribeSpecSellStatus）用于查询售卖规格状态信息，其中包括售卖状态，参考价格等(实际价格以询价接口为准)。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区英文ID，形如ap-guangzhou-3", "example": "ap-guangzhou-3" }, { "name": "SpecIdSet", "type": "array", "required": true, "description": "实例规格ID，可通过DescribeProductConfig接口获取。", "example": " [62]", "item_type": "integer" }, { "name": "DBVersion", "type": "string", "required": true, "description": "数据库版本信息，可通过DescribeProductConfig接口获取。", "example": "2008R2" }, { "name": "Pid", "type": "integer", "required": true, "description": "产品ID，可通过DescribeProductConfig接口获取。", "example": "100456" }, { "name": "PayMode", "type": "string", "required": true, "description": "付费模式，POST-按量计费 PRE-包年包月", "example": "POST" }, { "name": "Currency", "type": "string", "required": true, "description": "付费模式，CNY-人民币 USD-美元", "example": "CNY" } ], "required": [ "Zone", "SpecIdSet", "DBVersion", "Pid", "PayMode", "Currency" ] }, { "name": "DescribeUpgradeInstanceCheck", "description": "本接口（DescribeUpgradeInstanceCheck）用于在实例变配前，预检查实例变配的影响情况等。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-dj5i29c5n" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例变配后的CPU核心数，不填则不修改", "example": "1" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例变配后内存大小，单位GB，不填则不修改", "example": "2" }, { "name": "Storage", "type": "integer", "required": false, "description": "实例变配后磁盘大小，单位GB，不填则不修改", "example": "500" }, { "name": "DBVersion", "type": "string", "required": false, "description": "实例版本，不填则不修改", "example": "2008R2" }, { "name": "HAType", "type": "string", "required": false, "description": "实例变配后的类型，可选值：CLUSTER-集群，不填则不修改", "example": "CLUSTER" }, { "name": "MultiZones", "type": "string", "required": false, "description": "实例变配后的跨可用区类型，可选值： SameZones-修改为同可用区 MultiZones-修改为跨可用区，不填则不修改", "example": "SameZones" }, { "name": "DrZones", "type": "array", "required": false, "description": "多节点架构实例的备节点可用区，默认为空。如果需要在变配的同时修改指定备节点的可用区时必传，当MultiZones = MultiZones时主节点和备节点可用区不能全部相同。备机可用区集合最小为2个，最大不超过5个。", "example": "无", "item_type": "object", "children": [ { "name": "DrInstanceId", "type": "string", "required": false, "description": "备机资源ID", "example": "mssqldr-io91h2" }, { "name": "Zone", "type": "string", "required": false, "description": "备机可用区", "example": "ap-guangzhou-3" } ] } ], "required": [ "InstanceId" ] }, { "name": "DescribeUploadBackupInfo", "description": "本接口（DescribeUploadBackupInfo）用于查询备份上传权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-kpl74n9l" } ], "required": [ "InstanceId", "BackupMigrationId" ] }, { "name": "DescribeUploadIncrementalInfo", "description": "本接口（DescribeUploadIncrementalInfo）用于查询增量备份上传权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" }, { "name": "IncrementalMigrationId", "type": "string", "required": true, "description": "增量导入任务ID", "example": "mssql-incremental-migration-kp7bgv8p" } ], "required": [ "InstanceId", "BackupMigrationId", "IncrementalMigrationId" ] }, { "name": "DescribeXEvents", "description": "本接口（DescribeXEvents）用于查询扩展事件列表。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-wy78shs8" }, { "name": "EventType", "type": "string", "required": true, "description": "事件类型，slow-慢SQL事件，blocked-阻塞事件，deadlock-死锁事件", "example": "slow" }, { "name": "StartTime", "type": "string", "required": true, "description": "扩展文件生成开始时间(yyyy-MM-dd HH:mm:ss)", "example": "2023-01-01 12:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "扩展文件生成结束时间(yyyy-MM-dd HH:mm:ss)", "example": "2023-01-01 12:05:00" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页返回，页编号，默认值为第0页", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页返回，每页返回的数目，取值为1~100，默认值为20", "example": "10" } ], "required": [ "InstanceId", "EventType", "StartTime", "EndTime" ] }, { "name": "DescribeZones", "description": "本接口（DescribeZones）用于查询当前可售卖的可用区信息。", "status": "online", "parameters": [], "required": [] }, { "name": "DisassociateSecurityGroups", "description": "本接口(DisassociateSecurityGroups)用于安全组批量解绑实例。", "status": "online", "parameters": [ { "name": "SecurityGroupId", "type": "string", "required": true, "description": "安全组ID。", "example": "sg-igw86yth" }, { "name": "InstanceIdSet", "type": "array", "required": true, "description": "实例ID 列表，一个或者多个实例ID组成的数组。多个实例必须是同一个地域，同一个可用区，同一个项目下的。", "example": "[\"mssql-6f4ddx2f\\r\\n\"]", "item_type": "string" } ], "required": [ "SecurityGroupId", "InstanceIdSet" ] }, { "name": "InquiryPriceCreateDBInstances", "description": "本接口（InquiryPriceCreateDBInstances）用于查询申请实例价格。", "status": "online", "parameters": [ { "name": "Zone", "type": "string", "required": true, "description": "可用区ID。该参数可以通过调用 DescribeZones 接口的返回值中的Zone字段来获取。", "example": "ap-guangzhou-2" }, { "name": "Memory", "type": "integer", "required": true, "description": "内存大小，单位：GB", "example": "2" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例容量大小，单位：GB。", "example": "300" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "计费类型，取值支持 PREPAID，POSTPAID。", "example": "POSTPAID" }, { "name": "Period", "type": "integer", "required": false, "description": "购买时长，单位：月。取值为1到48，默认为1", "example": "1" }, { "name": "GoodsNum", "type": "integer", "required": false, "description": "一次性购买的实例数量。取值1-100，默认取值为1", "example": "1" }, { "name": "DBVersion", "type": "string", "required": false, "description": "sqlserver版本，目前所有支持的版本有：2008R2 (SQL Server 2008 R2 Enterprise)，2012SP3 (SQL Server 2012 Enterprise)，201202 (SQL Server 2012 Standard)，2014SP2 (SQL Server 2014 Enterprise)，201402 (SQL Server 2014 Standard)，2016SP1 (SQL Server 2016 Enterprise)，201602 (SQL Server 2016 Standard)，2017 (SQL Server 2017 Enterprise)，201702 (SQL Server 2017 Standard)，2019 (SQL Server 2019 Enterprise)，201902 (SQL Server 2019 Standard)。每个地域支持售卖的版本不同...", "example": "2008R2" }, { "name": "Cpu", "type": "integer", "required": false, "description": "预购买实例的CPU核心数", "example": "2" }, { "name": "InstanceType", "type": "string", "required": false, "description": "购买实例的类型 HA-高可用型(包括双机高可用，alwaysOn集群)，RO-只读副本型，SI-单节点型,cvmHA-虚拟机双机高可用,cvmRO-虚拟机只读，MultiHA-多节点，cvmMultiHA-云盘", "example": "HA" }, { "name": "MachineType", "type": "string", "required": false, "description": "购买实例的宿主机类型，PM-物理机, CLOUD_PREMIUM-虚拟机高性能云盘，CLOUD_SSD-虚拟机SSD云盘, CLOUD_HSSD-虚拟机加强型SSD云盘，CLOUD_TSSD-虚拟机极速型SSD云盘，CLOUD_BSSD-虚拟机通用型SSD云盘", "example": "PM" }, { "name": "DrZones", "type": "array", "required": false, "description": "备节点可用区，默认为空。如果是多节点架构时必传，并且备机可用区集合最小为2个，最大不超过5个。", "example": "[\"ap-guangzhou-3\"]", "item_type": "string" } ], "required": [ "Zone", "Memory", "Storage" ] }, { "name": "InquiryPriceRenewDBInstance", "description": "本接口（InquiryPriceRenewDBInstance）用于查询包年包月实例的续费价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-njj2mtpl" }, { "name": "Period", "type": "integer", "required": false, "description": "续费周期。按月续费最多48个月。默认查询续费一个月的价格", "example": "1" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "续费周期单位。month表示按月续费，当前只支持按月付费查询价格", "example": "month" } ], "required": [ "InstanceId" ] }, { "name": "InquiryPriceUpgradeDBInstance", "description": "本接口（InquiryPriceUpgradeDBInstance）用于查询包年包月实例升级变配的价格。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "Memory", "type": "integer", "required": true, "description": "实例升级后的内存大小，单位GB，其值不能比当前实例内存小", "example": "8" }, { "name": "Storage", "type": "integer", "required": true, "description": "实例升级后的磁盘大小，单位GB，其值不能比当前实例磁盘小", "example": "300" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例升级后的CPU核心数，其值不能比当前实例CPU小", "example": "2" } ], "required": [ "InstanceId", "Memory", "Storage" ] }, { "name": "ModifyAccountPrivilege", "description": "本接口（ModifyAccountPrivilege）用于修改实例账户权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "Accounts", "type": "array", "required": true, "description": "账号权限变更信息", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "数据库用户名", "example": "ac1" }, { "name": "DBPrivileges", "type": "array", "required": true, "description": "账号权限变更信息。参数DBPrivileges和AccAllDB只能二选一", "example": "无", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": true, "description": "数据库名", "example": "db_test" }, { "name": "Privilege", "type": "string", "required": true, "description": "权限变更信息。ReadWrite表示可读写，ReadOnly表示只读，Delete表示删除账号对该DB的权限，DBOwner所有者", "example": "ReadWrite" } ] }, { "name": "IsAdmin", "type": "boolean", "required": false, "description": "表示是否为管理员账户，当值为true，表示是 管理员。若实例 是 单节点，则管理员所在的 账号类型为超级权限账号 ，即AccountType=L0；若实例 是 双节点，则管理员所在的 账号类型为高级权限账号，即AccountType=L1；当值为false，表示 不是管理员，则账号类型为普通账号，即AccountType=L3", "example": "true" }, { "name": "AccountType", "type": "string", "required": false, "description": "账号类型，IsAdmin字段的扩展字段。 L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限，默认L3", "example": "L0" }, { "name": "AccAllDB", "type": "object", "required": false, "description": "全量修改指定账号下的所有DB权限，只支持特殊权限账号和普通权限账号。参数DBPrivileges和AccAllDB只能二选一", "example": "无", "children": [ { "name": "Privilege", "type": "string", "required": true, "description": "权限变更信息。ReadWrite表示可读写，ReadOnly表示只读，Delete表示删除账号对该DB的权限，DBOwner所有者", "example": "ReadWrite" } ] } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "ModifyAccountRemark", "description": "本接口（ModifyAccountRemark）用于修改账户备注。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-j8kv137v" }, { "name": "Accounts", "type": "array", "required": true, "description": "修改备注的账户信息", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": false, "description": "账户名", "example": "tom" }, { "name": "Remark", "type": "string", "required": false, "description": "对应账户新的备注信息", "example": "部门一" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "ModifyBackupMigration", "description": "本接口（ModifyBackupMigration）用于修改备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-kpl74n9l" }, { "name": "MigrationName", "type": "string", "required": false, "description": "任务名称", "example": "字符串" }, { "name": "RecoveryType", "type": "string", "required": false, "description": "迁移任务恢复类型，FULL,FULL_LOG,FULL_DIFF", "example": "FULL" }, { "name": "UploadType", "type": "string", "required": false, "description": "COS_URL-备份放在用户的对象存储上，提供URL。COS_UPLOAD-备份放在业务的对象存储上，用户上传", "example": "COS_UPLOAD" }, { "name": "BackupFiles", "type": "array", "required": false, "description": "UploadType是COS_URL时这里时URL，COS_UPLOAD这里填备份文件的名字；只支持1个备份文件，但1个备份文件内可包含多个库", "example": "[\"db1.bak\\n\"]", "item_type": "string" }, { "name": "DBRename", "type": "array", "required": false, "description": "需要重命名的数据库名称集合", "example": "[{\"OldName\":\"test1\",\"NewName\":\"test2\"}]", "item_type": "object", "children": [ { "name": "OldName", "type": "string", "required": false, "description": "库的名字，如果oldName不存在则返回失败。 在用于离线迁移任务时可不填。", "example": "db1" }, { "name": "NewName", "type": "string", "required": false, "description": "库的新名字，在用于离线迁移时，不填则按照OldName命名，OldName和NewName不能同时不填。在用于克隆数据库时，OldName和NewName都必须填写，且不能重复", "example": "db2" } ] } ], "required": [ "InstanceId", "BackupMigrationId" ] }, { "name": "ModifyBackupName", "description": "本接口(ModifyBackupName)用于修改备份任务名称。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6upluvd5" }, { "name": "BackupName", "type": "string", "required": true, "description": "修改的备份名称", "example": "backup_name" }, { "name": "BackupId", "type": "integer", "required": false, "description": "备份ID 可通过 [DescribeBackups](https://cloud.tencent.com/document/product/238/19943) 接口获取。当GroupId为空时，BackupId必填。", "example": "1234568" }, { "name": "GroupId", "type": "string", "required": false, "description": "备份任务组ID，在单库备份文件模式下，可通过[DescribeBackups](https://cloud.tencent.com/document/product/238/19943) 接口获得。 BackupId 和 GroupId 同时存在，按照BackupId进行修改。", "example": "558800" } ], "required": [ "InstanceId", "BackupName" ] }, { "name": "ModifyBackupStrategy", "description": "本接口（ModifyBackupStrategy）用于修改备份策略", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "BackupType", "type": "string", "required": false, "description": "备份类型，当length(BackupDay) =2时，取值为weekly，当length(BackupDay)=1时，取值daily，默认daily", "example": "daily" }, { "name": "BackupTime", "type": "integer", "required": false, "description": "备份时间点，取值为0-23的整数", "example": "14" }, { "name": "BackupDay", "type": "integer", "required": false, "description": "BackupType取值为daily时，表示备份间隔天数。当前取值只能为1", "example": "1" }, { "name": "BackupModel", "type": "string", "required": false, "description": "备份模式，master_pkg-主节点上打包备份文件；master_no_pkg-主节点单库备份文件；slave_pkg-从节点上打包备份文件；slave_no_pkg-从节点上单库备份文件，从节点上备份只有在always on容灾模式下支持。", "example": "master_no_pkg" }, { "name": "BackupCycle", "type": "array", "required": false, "description": "BackupType取值为weekly时，表示每周的星期N做备份。（如果数据备份保留时间=7天，则备份周期取值至少是一周的任意2天）", "example": "[1,2,3,4,5,6,7]", "item_type": "integer" }, { "name": "BackupSaveDays", "type": "integer", "required": false, "description": "数据(日志)备份保留天数（必填），取值[3-1830]天，默认7天", "example": "7" }, { "name": "RegularBackupEnable", "type": "string", "required": false, "description": "定期备份状态 enable-开启，disable-关闭，默认关闭", "example": "disable" }, { "name": "RegularBackupSaveDays", "type": "integer", "required": false, "description": "定期备份保留天数 [90 - 3650]天，默认365天", "example": "90" }, { "name": "RegularBackupStrategy", "type": "string", "required": false, "description": "定期备份策略 years-每年，quarters-每季度，months-每月，默认months", "example": "months" }, { "name": "RegularBackupCounts", "type": "integer", "required": false, "description": "定期备份保留个数，默认1个", "example": "1" }, { "name": "RegularBackupStartTime", "type": "string", "required": false, "description": "定期备份开始日期，格式-YYYY-MM-DD 默认当前日期", "example": "2022-10-10" } ], "required": [ "InstanceId" ] }, { "name": "ModifyCloseWanIp", "description": "本接口(ModifyCloseWanIp)用于关闭实例外网。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例资源ID", "example": "mssql-7vfv3rk3" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "RO只读组Id", "example": "mssqlrg-hua8ajq" } ], "required": [ "InstanceId" ] }, { "name": "ModifyCrossBackupStrategy", "description": "本接口(ModifyCrossBackupStrategy)用于开启、关闭地域备份策略。", "status": "online", "parameters": [ { "name": "CrossBackupEnabled", "type": "string", "required": true, "description": "跨地域备份开关(数据备份\u0026日志备份) enable-开启，disable-关闭", "example": "enable" }, { "name": "InstanceId", "type": "string", "required": false, "description": "实例Id", "example": "mssql-7vfv3rk3" }, { "name": "InstanceIdSet", "type": "array", "required": false, "description": "实例ID列表", "example": "[mssql-7vfv3rk3]", "item_type": "string" }, { "name": "CrossBackupSaveDays", "type": "integer", "required": false, "description": "跨地域备份保留天数，取值：7~1830，默认7天", "example": "7" }, { "name": "CrossBackupRegion", "type": "array", "required": false, "description": "跨地域备份的目标地域ID，最多两个，最少一个", "example": "[ap-guangzhou]", "item_type": "string" }, { "name": "CleanUpCrossBackup", "type": "integer", "required": false, "description": "是否立即清理跨地域备份(数据备份\u0026日志备份) ，只有在BackupEnabled = disable时有效。1-是，0-否，默认：0", "example": "1" } ], "required": [ "CrossBackupEnabled" ] }, { "name": "ModifyDBEncryptAttributes", "description": "本接口（ModifyDBEncryptAttributes）用于开启、关闭数据库的TDE加密功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-182jha8a" }, { "name": "DBTDEEncrypt", "type": "array", "required": true, "description": "开启、关闭数据库TDE加密", "example": "无", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": false, "description": "数据库名称", "example": "test_db" }, { "name": "Encryption", "type": "string", "required": false, "description": "enable-开启数据库TDE加密，disable-关闭数据库TDE加密", "example": "enable" } ] } ], "required": [ "InstanceId", "DBTDEEncrypt" ] }, { "name": "ModifyDBInstanceName", "description": "本接口（ModifyDBInstanceName）用于修改实例名字。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "InstanceName", "type": "string", "required": true, "description": "新的数据库实例名字", "example": "testModifyInstanceName" } ], "required": [ "InstanceId", "InstanceName" ] }, { "name": "ModifyDBInstanceNetwork", "description": "本接口（ModifyDBInstanceNetwork）用于修改运行中实例的网络，仅支持从VPC网络到VPC网络的转换", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例id", "example": "mssql-p2yli7gv" }, { "name": "NewVpcId", "type": "string", "required": true, "description": "新VPC网络Id", "example": "vpc-ilki4qdp" }, { "name": "NewSubnetId", "type": "string", "required": true, "description": "新子网Id", "example": "subnet-lru6dhh8" }, { "name": "OldIpRetainTime", "type": "integer", "required": false, "description": "原vip保留时长，单位小时，默认为0，代表立即回收，最大为168小时", "example": "12" }, { "name": "Vip", "type": "string", "required": false, "description": "指定VIP地址", "example": "127.0.0.1" }, { "name": "DRNetwork", "type": "integer", "required": false, "description": "目标节点，0-修改主节点网络，1-修改备节点网络，默认取值0", "example": "0" }, { "name": "DrInstanceId", "type": "string", "required": false, "description": "备机资源ID。当DRNetwork = 1时必填", "example": "mssqldr-juiay7a" } ], "required": [ "InstanceId", "NewVpcId", "NewSubnetId" ] }, { "name": "ModifyDBInstanceNote", "description": "本接口（ModifyDBInstanceNote）用于修改实例备注信息。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "InstanceNote", "type": "string", "required": true, "description": "实例备注信息", "example": "noteMsg" } ], "required": [ "InstanceId", "InstanceNote" ] }, { "name": "ModifyDBInstanceProject", "description": "本接口（ModifyDBInstanceProject）用于修改数据库实例所属项目。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "实例ID数组，形如mssql-j8kv137v", "example": "[\"mssql-j8kv137v\\r\\n\"]", "item_type": "string" }, { "name": "ProjectId", "type": "integer", "required": true, "description": "项目ID，为0的话表示默认项目", "example": "347" } ], "required": [ "InstanceIdSet", "ProjectId" ] }, { "name": "ModifyDBInstanceRenewFlag", "description": "本接口（ModifyDBInstanceRenewFlag）用于修改实例续费标记", "status": "online", "parameters": [ { "name": "RenewFlags", "type": "array", "required": true, "description": "实例续费状态标记信息", "example": "无", "item_type": "object", "children": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-j8kv137v" }, { "name": "RenewFlag", "type": "integer", "required": true, "description": "实例续费标记。0：正常续费，1：自动续费，2：到期不续", "example": "0" } ] } ], "required": [ "RenewFlags" ] }, { "name": "ModifyDBInstanceSSL", "description": "本接口（ModifyDBInstanceSSL）用于开启\\关闭\\更新SSL加密", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "Type", "type": "string", "required": true, "description": "操作类型。enable-开启SSL，disable-关闭SSL，renew-更新证书有效期", "example": "enable" }, { "name": "WaitSwitch", "type": "integer", "required": true, "description": "操作设置。0-立即执行，1- 维护时间内执行，默认取值0。", "example": "0" }, { "name": "IsKMS", "type": "integer", "required": false, "description": "是否被KMS加密保护，0-表示否，1表示被KMS保护，默认取值0", "example": "0" }, { "name": "KeyId", "type": "string", "required": false, "description": "IsKMS为1时必填", "example": "df*******************************52" }, { "name": "KeyRegion", "type": "string", "required": false, "description": "IsKMS为1时必填", "example": "ap-guangzhou" } ], "required": [ "InstanceId", "Type", "WaitSwitch" ] }, { "name": "ModifyDBInstanceSecurityGroups", "description": "本接口(ModifyDBInstanceSecurityGroups)用于修改实例绑定的安全组。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例 ID，格式如：mssql-c1nl9rpv 或者 mssqlro-c1nl9rpv，与云数据库控制台页面中显示的实例 ID 相同。", "example": "mssql-6f4ddx2f" }, { "name": "SecurityGroupIdSet", "type": "array", "required": true, "description": "要修改的安全组 ID 列表，一个或者多个安全组 ID 组成的数组。可通过 DescribeDBSecurityGroups 接口获取。输入的安全组 ID 数组无长度限制。 注意：该入参会全量替换存量已有集合，非增量更新。修改需传入预期的全量集合。", "example": "[\"sg-ajr1jzgj\"]", "item_type": "string" } ], "required": [ "InstanceId", "SecurityGroupIdSet" ] }, { "name": "ModifyDBName", "description": "本接口（ModifyDBName）用于更新数据库名。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-i1z41iwd" }, { "name": "OldDBName", "type": "string", "required": true, "description": "旧数据库名", "example": "test_db" }, { "name": "NewDBName", "type": "string", "required": true, "description": "新数据库名", "example": "test_db_newname" } ], "required": [ "InstanceId", "OldDBName", "NewDBName" ] }, { "name": "ModifyDBRemark", "description": "本接口（ModifyDBRemark）用于修改数据库备注。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-rljoi3bf", "example": "mssql-njj2mtpl" }, { "name": "DBRemarks", "type": "array", "required": true, "description": "数据库名称及备注数组，每个元素包含数据库名和对应的备注", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "数据库名称", "example": "db1" }, { "name": "Remark", "type": "string", "required": true, "description": "备注信息", "example": "andy" } ] } ], "required": [ "InstanceId", "DBRemarks" ] }, { "name": "ModifyDReadable", "description": "本接口（ModifyDReadable）用于开通或者关闭备机只读", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "Type", "type": "string", "required": true, "description": "操作类型。enable-开启备机只读，disable-关闭备机只读", "example": "disable" }, { "name": "VpcId", "type": "string", "required": false, "description": "备机网络ID，不填默认和主实例保持一致", "example": "vpc-jh8ah7" }, { "name": "SubnetId", "type": "string", "required": false, "description": "备机网络子网ID，不填默认和主实例保持一致", "example": "sub-i90aoa" }, { "name": "Vip", "type": "string", "required": false, "description": "指定的备机只读vip，不填自动分配。多节点SingleReadOnly模式不支持指定vip。", "example": "127.0.0.1" }, { "name": "ReadMode", "type": "string", "required": false, "description": "备机只读模式，多节点架构默认取值BalancedReadOnly。SingleReadOnly-每个备机各对应一个只读地址（多节点架构），BalancedReadOnly-所有备机共用一个只读地址。当实例是双节点架构时，固定取值SingleReadOnly。", "example": "BalancedReadOnly" } ], "required": [ "InstanceId", "Type" ] }, { "name": "ModifyDatabaseCDC", "description": "本接口(ModifyDatabaseCDC)用于开启、关闭数据库数据变更捕获(CDC)", "status": "online", "parameters": [ { "name": "DBNames", "type": "array", "required": true, "description": "数据库名数组", "example": "[db_test]", "item_type": "string" }, { "name": "ModifyType", "type": "string", "required": true, "description": "开启、关闭数据库CDC功能 enable；开启，disable：关闭", "example": "enable" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" } ], "required": [ "DBNames", "ModifyType", "InstanceId" ] }, { "name": "ModifyDatabaseCT", "description": "本接口(ModifyDatabaseCT)用于启用、禁用数据库数据变更跟踪(CT)", "status": "online", "parameters": [ { "name": "DBNames", "type": "array", "required": true, "description": "数据库名数组", "example": "[db_test]", "item_type": "string" }, { "name": "ModifyType", "type": "string", "required": true, "description": "启用、禁用数据库CT功能 enable；启用，disable：禁用", "example": "enable" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "ChangeRetentionDay", "type": "integer", "required": false, "description": "启用CT时额外保留天数，默认保留3天，最小3天，最大30天", "example": "3" } ], "required": [ "DBNames", "ModifyType", "InstanceId" ] }, { "name": "ModifyDatabaseMdf", "description": "本接口(ModifyDatabaseMdf)用于收缩数据库mdf(Shrink mdf)。**本接口已废弃，请使用接口ModifyDatabaseShrinkMDF**。", "status": "online", "parameters": [ { "name": "DBNames", "type": "array", "required": true, "description": "数据库名数组", "example": "[db_test]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" } ], "required": [ "DBNames", "InstanceId" ] }, { "name": "ModifyDatabasePrivilege", "description": "本接口（ModifyDatabasePrivilege）用于修改实例数据库权限。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "DataBaseSet", "type": "array", "required": true, "description": "数据库权限变更信息", "example": "无", "item_type": "object", "children": [ { "name": "DataBaseName", "type": "string", "required": true, "description": "数据库名称", "example": "db1" }, { "name": "AccountPrivileges", "type": "array", "required": true, "description": "数据库权限变更信息", "example": "[{\"UserName\": \"andy\",\"Privilege\": \"ReadOnly\",\"AccountType\": \"\tL0\"}]", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "数据库用户名", "example": "db_test" }, { "name": "Privilege", "type": "string", "required": true, "description": "数据库权限。ReadWrite表示可读写，ReadOnly表示只读,Delete表示删除DB对该账户的权限，DBOwner所有者", "example": "ReadOnly" }, { "name": "AccountType", "type": "string", "required": false, "description": "账户名称，L0-超级权限(基础版独有),L1-高级权限,L2-特殊权限,L3-普通权限", "example": "L0" } ] } ] } ], "required": [ "InstanceId", "DataBaseSet" ] }, { "name": "ModifyDatabaseShrinkMDF", "description": "本接口（ModifyDatabaseShrinkMDF）用于收缩数据库 mdf（Shrink mdf）。", "status": "online", "parameters": [ { "name": "DBNames", "type": "array", "required": true, "description": "数据库名数组", "example": "[\"db_test\"]", "item_type": "string" }, { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" } ], "required": [ "DBNames", "InstanceId" ] }, { "name": "ModifyIncrementalMigration", "description": "本接口（ModifyIncrementalMigration）用于修改增量备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" }, { "name": "IncrementalMigrationId", "type": "string", "required": true, "description": "增量导入任务ID，由CreateIncrementalMigration接口返回", "example": "mssql-incremental-migration-kp7bgv8p" }, { "name": "IsRecovery", "type": "string", "required": false, "description": "是否需要恢复，NO-不需要，YES-需要，默认不修改增量备份导入任务是否需要恢复的属性。", "example": "YES" }, { "name": "BackupFiles", "type": "array", "required": false, "description": "UploadType是COS_URL时这里时URL，COS_UPLOAD这里填备份文件的名字；只支持1个备份文件，但1个备份文件内可包含多个库", "example": "[\"db_cvm_1_20200927204209_2log2_2reconvery2.bak\\n\"]", "item_type": "string" } ], "required": [ "InstanceId", "BackupMigrationId", "IncrementalMigrationId" ] }, { "name": "ModifyInstanceEncryptAttributes", "description": "本接口（ModifyInstanceEncryptAttributes）用于开通实例的TDE加密功能。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-182jha8a" }, { "name": "CertificateAttribution", "type": "string", "required": true, "description": "证书归属。self-表示使用该账号自身的证书，others-表示引用其他账号的证书，kms-表示使用kms的CMK证书，默认取值self。", "example": "self" }, { "name": "QuoteUin", "type": "string", "required": false, "description": "引用的其他主账号ID，当CertificateAttribution 为others时必填。", "example": "1000****6845" }, { "name": "KeyId", "type": "string", "required": false, "description": "CertificateAttribution为kms时必填", "example": "df4fd19c-ea4e-11ed-8c28-525400b4ad52" }, { "name": "KeyRegion", "type": "string", "required": false, "description": "CertificateAttribution为kms时必填", "example": "ap-guangzhou" } ], "required": [ "InstanceId", "CertificateAttribution" ] }, { "name": "ModifyInstanceParam", "description": "本接口(ModifyInstanceParam)用于修改云数据库实例的参数。 注意：如果修改的参数是需要重启实例的，那么实例将会按照WaitSwitch参数的设置(可能是立即执行也可能在可维护时间窗内自动执行)在执行参数修改时重启实例。 您可以通过DescribeInstanceParams接口查询修改参数时是否会重启实例，以免导致您的实例不符合预期重启。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例短 ID 列表", "example": "[“mssql-bm5e51kb”]", "item_type": "string" }, { "name": "ParamList", "type": "array", "required": true, "description": "要修改的参数列表。每一个元素是 Name 和 CurrentValue 的组合。Name 是参数名，CurrentValue 是要修改的值。注意：如果修改的参数需要重启实例，那么您的实例将会在执行修改时重启。您可以通过DescribeInstanceParams接口查询修改参数时是否会重启实例，以免导致您的实例不符合预期重启。", "example": "[{\"Name\": \"fill factor (%)\",\"CurrentValue\": \"50\"}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": false, "description": "参数名称", "example": "fill factor (%)" }, { "name": "CurrentValue", "type": "string", "required": false, "description": "参数值", "example": "1" } ] }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "执行参数调整任务的方式，默认为 0。支持值包括：0 - 立刻执行，1 - 时间窗执行。", "example": "0" } ], "required": [ "InstanceIds", "ParamList" ] }, { "name": "ModifyMaintenanceSpan", "description": "本接口（ModifyMaintenanceSpan）用于修改实例的可维护时间窗", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-k8voqdlz", "example": "mssql-6upluvd5" }, { "name": "Weekly", "type": "array", "required": false, "description": "以周为单位，表示允许周几维护，例如：[1,2,3,4,5,6,7]表示周一到周日均为可维护日，本参数不填，则不修改此值。", "example": "[\"1\\r\\n\",\"2\\r\\n\",\"3\\r\\n\"]", "item_type": "integer" }, { "name": "StartTime", "type": "string", "required": false, "description": "每天可维护的开始时间，例如：10:24标识可维护时间窗10点24分开始，本参数不填，则不修改此值。", "example": "00:00" }, { "name": "Span", "type": "integer", "required": false, "description": "每天可维护的持续时间，单位是h，例如：1 表示从可维护的开始时间起持续1小时，本参数不填，则不修改此值。", "example": "6" } ], "required": [ "InstanceId" ] }, { "name": "ModifyMigration", "description": "本接口（ModifyMigration）可以修改已有的迁移任务信息", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "2728" }, { "name": "MigrateName", "type": "string", "required": false, "description": "新的迁移任务的名称，若不填则不修改", "example": "测试接口" }, { "name": "MigrateType", "type": "integer", "required": false, "description": "新的迁移类型（1:结构迁移 2:数据迁移 3:增量同步），若不填则不修改", "example": "2" }, { "name": "SourceType", "type": "integer", "required": false, "description": "迁移源的类型 1:TencentDB for SQLServer 2:云服务器自建SQLServer数据库 4:SQLServer备份还原 5:SQLServer备份还原（COS方式），若不填则不修改", "example": "5" }, { "name": "Source", "type": "object", "required": false, "description": "迁移源，若不填则不修改", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "迁移源实例的ID，MigrateType=1(TencentDB for SQLServers)时使用，格式如：mssql-si2823jyl", "example": "mssql-si2823jyl" }, { "name": "CvmId", "type": "string", "required": false, "description": "迁移源Cvm的ID，MigrateType=2(云服务器自建SQLServer数据库)时使用", "example": "ins-62dhd3d1" }, { "name": "VpcId", "type": "string", "required": false, "description": "迁移源Cvm的Vpc网络标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：vpc-6ys9ont9", "example": "vpc-6ys9ont9" }, { "name": "SubnetId", "type": "string", "required": false, "description": "迁移源Cvm的Vpc下的子网标识，MigrateType=2(云服务器自建SQLServer数据库)时使用，格式如：subnet-h9extioi", "example": "subnet-h9extioi" }, { "name": "UserName", "type": "string", "required": false, "description": "用户名，MigrateType=1或MigrateType=2使用", "example": "andy" }, { "name": "Password", "type": "string", "required": false, "description": "密码，MigrateType=1或MigrateType=2使用", "example": "Zh22448899" }, { "name": "Ip", "type": "string", "required": false, "description": "迁移源Cvm自建库的内网IP，MigrateType=2(云服务器自建SQLServer数据库)时使用", "example": "172.1.1.5" }, { "name": "Port", "type": "integer", "required": false, "description": "迁移源Cvm自建库的端口号，MigrateType=2(云服务器自建SQLServer数据库)时使用", "example": "22" }, { "name": "Url", "type": "array", "required": false, "description": "离线迁移的源备份地址，MigrateType=4或MigrateType=5使用", "example": "http://gz-oncvm-1254065710.cosgz.myqcloud.com/test4_20180724021516.bak", "item_type": "string" }, { "name": "UrlPassword", "type": "string", "required": false, "description": "离线迁移的源备份密码，MigrateType=4或MigrateType=5使用", "example": "Ps55336622" } ] }, { "name": "Target", "type": "object", "required": false, "description": "迁移目标，若不填则不修改", "example": "无", "children": [ { "name": "InstanceId", "type": "string", "required": false, "description": "迁移目标实例的ID，格式如：mssql-si2823jyl", "example": "mssql-si2823jyl" }, { "name": "UserName", "type": "string", "required": false, "description": "迁移目标实例的用户名", "example": "andy" }, { "name": "Password", "type": "string", "required": false, "description": "迁移目标实例的密码", "example": "Zh22446688" } ] }, { "name": "MigrateDBSet", "type": "array", "required": false, "description": "迁移DB对象 ，离线迁移（SourceType=4或SourceType=5）不使用，若不填则不修改", "example": "无", "item_type": "object", "children": [ { "name": "DBName", "type": "string", "required": false, "description": "迁移数据库的名称", "example": "db1" } ] } ], "required": [ "MigrateId" ] }, { "name": "ModifyOpenWanIp", "description": "本接口(ModifyOpenWanIp)用于开通实例外网。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例资源ID", "example": "mssql-7vfv3rk3" }, { "name": "RoGroupId", "type": "string", "required": false, "description": "RO只读组Id", "example": "mssqlrg-uq7jq8q" } ], "required": [ "InstanceId" ] }, { "name": "ModifyPublishSubscribe", "description": "本接口（ModifyPublishSubscribe）用于修改实例的发布订阅关系。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，例如：mssql-dg32dcv", "example": "mssql-dj5i29c5n" }, { "name": "PublishSubscribeId", "type": "integer", "required": true, "description": "发布订阅ID", "example": "2" }, { "name": "DatabaseTupleSet", "type": "array", "required": true, "description": "修改的数据库订阅发布关系集合", "example": "无", "item_type": "object", "children": [ { "name": "DatabaseTuple", "type": "object", "required": true, "description": "要修改的订阅关系", "example": "无", "children": [ { "name": "PublishDatabase", "type": "string", "required": true, "description": "发布数据库名称", "example": "db1" }, { "name": "SubscribeDatabase", "type": "string", "required": true, "description": "订阅数据库名称", "example": "db2" } ] }, { "name": "NewDatabaseTuple", "type": "object", "required": false, "description": "修改后的订阅关系。DeleteDataBasesTuple为false时有效", "example": "无", "children": [ { "name": "PublishDatabase", "type": "string", "required": true, "description": "发布数据库名称", "example": "db1" }, { "name": "SubscribeDatabase", "type": "string", "required": true, "description": "订阅数据库名称", "example": "db2" } ] }, { "name": "DeleteDataBasesTuple", "type": "boolean", "required": false, "description": "是否删除订阅关系。此选项为true时，NewDatabaseTuple无效", "example": "true" } ] } ], "required": [ "InstanceId", "PublishSubscribeId", "DatabaseTupleSet" ] }, { "name": "ModifyPublishSubscribeName", "description": "本接口（ModifyPublishSubscribeName）修改发布订阅的名称。", "status": "online", "parameters": [ { "name": "PublishSubscribeId", "type": "integer", "required": true, "description": "发布订阅ID", "example": "5" }, { "name": "PublishSubscribeName", "type": "string", "required": true, "description": "待修改的发布订阅名称", "example": "Change_name" } ], "required": [ "PublishSubscribeId", "PublishSubscribeName" ] }, { "name": "ModifyReadOnlyGroupDetails", "description": "本接口（ModifyReadOnlyGroupDetails）用于修改只读组详情。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例ID，格式如：mssql-3l3fgqn7", "example": "mssql-6f4ddx2f" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组ID", "example": "mssqlrg-552tyamb" }, { "name": "ReadOnlyGroupName", "type": "string", "required": false, "description": "只读组名称，不填此参数，则不修改", "example": "change_name" }, { "name": "IsOfflineDelay", "type": "integer", "required": false, "description": "是否启动超时剔除功能,0-不开启剔除功能，1-开启剔除功能，不填此参数，则不修改", "example": "1" }, { "name": "ReadOnlyMaxDelayTime", "type": "integer", "required": false, "description": "启动超时剔除功能后，使用的超时阈值，不填此参数，则不修改", "example": "18" }, { "name": "MinReadOnlyInGroup", "type": "integer", "required": false, "description": "启动超时剔除功能后，只读组至少保留的只读副本数，不填此参数，则不修改", "example": "1" }, { "name": "WeightPairs", "type": "array", "required": false, "description": "只读组实例权重修改集合，不填此参数，则不修改", "example": "无", "item_type": "object", "children": [ { "name": "ReadOnlyInstanceId", "type": "string", "required": true, "description": "只读实例ID，格式如：mssqlro-3l3fgqn7", "example": "mssqlro-3l3fgqn7" }, { "name": "ReadOnlyWeight", "type": "integer", "required": true, "description": "只读实例权重 ，范围是0-100", "example": "10" } ] }, { "name": "AutoWeight", "type": "integer", "required": false, "description": "0-用户自定义权重（根据WeightPairs调整）,1-系统自动分配权重(WeightPairs无效)， 默认为0", "example": "0" }, { "name": "BalanceWeight", "type": "integer", "required": false, "description": "0-不重新均衡负载，1-重新均衡负载，默认为0", "example": "1" } ], "required": [ "InstanceId", "ReadOnlyGroupId" ] }, { "name": "OpenInterCommunication", "description": "本接口（OpenInterCommunication）用于打开实例的互通，实例互通可以实现商业智能服务相互联通。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "打开互通组的实例ID集合", "example": "mssql-dj5i29c5n", "item_type": "string" } ], "required": [ "InstanceIdSet" ] }, { "name": "QueryMigrationCheckProcess", "description": "本接口（QueryMigrationCheckProcess）的作用是查询迁移检查任务的进度，适用于迁移源的类型为TencentDB for SQLServer 的迁移方式", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "1066" } ], "required": [ "MigrateId" ] }, { "name": "RecycleDBInstance", "description": "本接口（RecycleDBInstance）用于主动回收已下线的SQLSERVER实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-ms2m7vut" } ], "required": [ "InstanceId" ] }, { "name": "RecycleReadOnlyGroup", "description": "本接口（RecycleReadOnlyGroup）立即回收只读组的资源，只读组占用的vip等资源将立即释放且不可找回。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "主实例的ID", "example": "mssql-2cwisu23" }, { "name": "ReadOnlyGroupId", "type": "string", "required": true, "description": "只读组的ID", "example": "mssqlrg-787oxy95" } ], "required": [ "InstanceId", "ReadOnlyGroupId" ] }, { "name": "RemoveBackups", "description": "本接口（RemoveBackups）可以删除用户手动创建的备份文件。待删除的备份策略可以是实例备份，也可以是多库备份。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-6upluvd5" }, { "name": "BackupNames", "type": "array", "required": false, "description": "待删除的备份名称，备份名称可通过DescribeBackups接口的FileName字段获得，单次请求批量删除备份数不能超过10个。当StartTime、EndTime为空时，此字段必填。", "example": "[\"manual_instance_58001_20180702010430.bak.tar\\r\\n\"]", "item_type": "string" }, { "name": "StartTime", "type": "string", "required": false, "description": "批量删除手动备份起始时间。当BackupNames为空时，此字段必填。", "example": "2022-04-20 22:23:12" }, { "name": "EndTime", "type": "string", "required": false, "description": "批量删除手动备份截止时间。当BackupNames为空时，此字段必填。", "example": "2022-04-21 22:23:12" } ], "required": [ "InstanceId" ] }, { "name": "RenewDBInstance", "description": "本接口（RenewDBInstance）用于续费实例。当被续费实例是按量计费实例时，则按量计费实例转为包年包月计费方式。 按量计费实例转包年包月询价可通过(InquiryPriceRenewDBInstance)接口获得。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-j8kv137v" }, { "name": "Period", "type": "integer", "required": false, "description": "续费多少个月，取值范围为1-48，默认为1", "example": "2" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券，0-不使用；1-使用；默认不使用", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID数组，目前只支持使用1张代金券", "example": "VoucherIds", "item_type": "string" }, { "name": "AutoRenewFlag", "type": "integer", "required": false, "description": "续费标记 0:正常续费 1:自动续费：只用于按量计费转包年包月时有效。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "RenewPostpaidDBInstance", "description": "本接口（RenewPostpaidDBInstance）用于将通过接口TerminateDBInstance手动隔离的按量计费实例从回收站中恢复。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，格式如：mssql-3l3fgqn7 或 mssqlro-3l3fgqn7", "example": "mssql-ms2m7vut" } ], "required": [ "InstanceId" ] }, { "name": "ResetAccountPassword", "description": "本接口（ResetAccountPassword）用于重置实例的账号密码。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "Accounts", "type": "array", "required": true, "description": "更新后的账户密码信息数组", "example": "无", "item_type": "object", "children": [ { "name": "UserName", "type": "string", "required": true, "description": "用户名", "example": "andy" }, { "name": "Password", "type": "string", "required": true, "description": "密码", "example": "Zh22448899" }, { "name": "EncryptedVersion", "type": "integer", "required": false, "description": "加密密钥版本号，0表示不使用加密", "example": "0" } ] } ], "required": [ "InstanceId", "Accounts" ] }, { "name": "RestartDBInstance", "description": "本接口（RestartDBInstance）用于重启数据库实例。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "数据库实例ID，形如mssql-njj2mtpl", "example": "mssql-njj2mtpl" }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "重启设置，0-立刻重启，1-维护时间窗口内重启，默认0", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "RestoreInstance", "description": "本接口（RestoreInstance）用于按照备份集回档数据库。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-njj2mtpl" }, { "name": "BackupId", "type": "integer", "required": true, "description": "备份文件ID，该ID可以通过DescribeBackups接口返回数据中的Id字段获得", "example": "32687264876" }, { "name": "TargetInstanceId", "type": "string", "required": false, "description": "备份恢复到的同一个APPID下的实例ID，不填则恢复到原实例ID", "example": "mssql-njj2mtpl" }, { "name": "RenameRestore", "type": "array", "required": false, "description": "按照ReNameRestoreDatabase中的库进行恢复，并重命名，不填则按照默认方式命名恢复的库，且恢复所有的库。", "example": "无", "item_type": "object", "children": [ { "name": "OldName", "type": "string", "required": false, "description": "库的名字，如果oldName不存在则返回失败。 在用于离线迁移任务时可不填。", "example": "db1" }, { "name": "NewName", "type": "string", "required": false, "description": "库的新名字，在用于离线迁移时，不填则按照OldName命名，OldName和NewName不能同时不填。在用于克隆数据库时，OldName和NewName都必须填写，且不能重复", "example": "db2" } ] }, { "name": "Type", "type": "integer", "required": false, "description": "回档类型，0-覆盖方式；1-重命名方式，默认1", "example": "1" }, { "name": "DBList", "type": "array", "required": false, "description": "需要覆盖回档的数据库，只有覆盖回档时必填", "example": "[\"test_db\"]", "item_type": "string" }, { "name": "GroupId", "type": "string", "required": false, "description": "备份任务组ID，在单库备份文件模式下", "example": "2993992" } ], "required": [ "InstanceId", "BackupId" ] }, { "name": "RollbackInstance", "description": "本接口（RollbackInstance）用于按照时间点回档实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-j8kv137v" }, { "name": "Type", "type": "integer", "required": true, "description": "回档类型，0-回档的数据库覆盖原库；1-回档的数据库以重命名的形式生成，不覆盖原库", "example": "0" }, { "name": "Time", "type": "string", "required": true, "description": "回档目标时间点", "example": "2018-08-0711:32:29" }, { "name": "DBs", "type": "array", "required": false, "description": "需要回档的数据库", "example": "[\"db1\"]", "item_type": "string" }, { "name": "TargetInstanceId", "type": "string", "required": false, "description": "备份恢复到的同一个APPID下的实例ID，不填则恢复到原实例ID", "example": "mssql-dj5i29c5n" }, { "name": "RenameRestore", "type": "array", "required": false, "description": "按照ReNameRestoreDatabase中的库进行重命名，仅在Type = 1重命名回档方式有效；不填则按照默认方式命名库，DBs参数确定要恢复的库", "example": "无", "item_type": "object", "children": [ { "name": "OldName", "type": "string", "required": false, "description": "库的名字，如果oldName不存在则返回失败。 在用于离线迁移任务时可不填。", "example": "db1" }, { "name": "NewName", "type": "string", "required": false, "description": "库的新名字，在用于离线迁移时，不填则按照OldName命名，OldName和NewName不能同时不填。在用于克隆数据库时，OldName和NewName都必须填写，且不能重复", "example": "db2" } ] } ], "required": [ "InstanceId", "Type", "Time" ] }, { "name": "RunMigration", "description": "本接口（RunMigration）用于启动迁移任务，开始迁移", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "2729" } ], "required": [ "MigrateId" ] }, { "name": "StartBackupMigration", "description": "本接口（StartBackupMigration）用于启动备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-kpl74n9l" } ], "required": [ "InstanceId", "BackupMigrationId" ] }, { "name": "StartIncrementalMigration", "description": "本接口（StartIncrementalMigration）用于启动增量备份导入任务。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "导入目标实例ID", "example": "mssql-rdc0gajn" }, { "name": "BackupMigrationId", "type": "string", "required": true, "description": "备份导入任务ID，由CreateBackupMigration接口返回", "example": "mssql-backup-migration-cg0ffgqt" }, { "name": "IncrementalMigrationId", "type": "string", "required": true, "description": "增量备份导入任务ID", "example": "mssql-incremental-migration-kp7bgv8p" } ], "required": [ "InstanceId", "BackupMigrationId", "IncrementalMigrationId" ] }, { "name": "StartInstanceXEvent", "description": "本接口（StartInstanceXEvent）用于开启、关闭扩展事件。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-wuw78w" }, { "name": "EventConfig", "type": "array", "required": true, "description": "开启、关闭扩展事件", "example": "[]", "item_type": "object", "children": [ { "name": "EventType", "type": "string", "required": true, "description": "事件类型，slow-设置慢SQL阈值，blocked-设置阻塞、死锁阈值", "example": "slow" }, { "name": "Threshold", "type": "integer", "required": true, "description": "阈值，单位毫秒。0表示关闭，大于0表示开启", "example": "1000" } ] } ], "required": [ "InstanceId", "EventConfig" ] }, { "name": "StartMigrationCheck", "description": "本接口（StartMigrationCheck）的作用是启动一个迁移前的校验任务，适用于迁移源的类型为TencentDB for SQLServer 的迁移方式", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务id", "example": "1066" } ], "required": [ "MigrateId" ] }, { "name": "StopMigration", "description": "本接口（StopMigration）作用是中止一个迁移任务", "status": "online", "parameters": [ { "name": "MigrateId", "type": "integer", "required": true, "description": "迁移任务ID", "example": "2729" } ], "required": [ "MigrateId" ] }, { "name": "SwitchCloudInstanceHA", "description": "本接口(SwitchCloudInstanceHA)用于手动主备切换。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID", "example": "mssql-8ua7ah" }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "切换执行方式，0-立刻执行，1-时间窗内执行，默认取值为0。", "example": "0" } ], "required": [ "InstanceId" ] }, { "name": "TerminateDBInstance", "description": "本接口(TerminateDBInstance)用于主动隔离实例，使得实例进入回收站。", "status": "online", "parameters": [ { "name": "InstanceIdSet", "type": "array", "required": true, "description": "主动销毁的实例ID列表，格式如：[mssql-3l3fgqn7]。与云数据库控制台页面中显示的实例ID相同", "example": "[\"mssql-njj2mtpl\\n\"]", "item_type": "string" } ], "required": [ "InstanceIdSet" ] }, { "name": "UpgradeDBInstance", "description": "本接口（UpgradeDBInstance）用于升级实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID，形如mssql-j8kv137v", "example": "mssql-j8kv137v" }, { "name": "Memory", "type": "integer", "required": false, "description": "实例升级后内存大小，单位GB，其值不能小于当前实例内存大小", "example": "4" }, { "name": "Storage", "type": "integer", "required": false, "description": "实例升级后磁盘大小，单位GB，其值不能小于当前实例磁盘大小", "example": "400" }, { "name": "AutoVoucher", "type": "integer", "required": false, "description": "是否自动使用代金券，0 - 不使用；1 - 默认使用。取值默认为0", "example": "0" }, { "name": "VoucherIds", "type": "array", "required": false, "description": "代金券ID，目前单个订单只能使用一张代金券", "example": "[\"134\"]", "item_type": "string" }, { "name": "Cpu", "type": "integer", "required": false, "description": "实例升级后的CPU核心数", "example": "1" }, { "name": "DBVersion", "type": "string", "required": false, "description": "升级sqlserver的版本，目前支持：2008R2（SQL Server 2008 Enterprise），2012SP3（SQL Server 2012 Enterprise）版本等。每个地域支持售卖的版本不同，可通过DescribeProductConfig接口来拉取每个地域可售卖的版本信息，版本不支持降级，不填则不修改版本", "example": "2008R2" }, { "name": "HAType", "type": "string", "required": false, "description": "升级sqlserver的高可用架构,从镜像容灾升级到always on集群容灾，仅支持2017及以上版本且支持always on高可用的实例，不支持降级到镜像方式容灾，CLUSTER-升级为always on容灾，不填则不修改高可用架构", "example": "CLUSTER" }, { "name": "MultiZones", "type": "string", "required": false, "description": "修改实例是否为跨可用区容灾，SameZones-修改为同可用区 MultiZones-修改为跨可用区", "example": "MultiZones" }, { "name": "WaitSwitch", "type": "integer", "required": false, "description": "执行变配的方式，默认为 1。支持值包括：0 - 立刻执行，1 - 维护时间窗执行", "example": "1" }, { "name": "DrZones", "type": "array", "required": false, "description": "多节点架构实例的备节点可用区，默认为空。如果需要在变配的同时修改指定备节点的可用区时必传，当MultiZones = MultiZones时主节点和备节点可用区不能全部相同。备机可用区集合最小为2个，最大不超过5个。", "example": "无", "item_type": "object", "children": [ { "name": "DrInstanceId", "type": "string", "required": false, "description": "备机资源ID", "example": "mssqldr-io91h2" }, { "name": "Zone", "type": "string", "required": false, "description": "备机可用区", "example": "ap-guangzhou-3" } ] }, { "name": "UpgradeCompatLevel", "type": "integer", "required": false, "description": "是否自动升级数据库的兼容性级别，默认0。0-否，1-是", "example": "0" } ], "required": [ "InstanceId" ] } ] }