实例变配检查

最近更新时间:2024-03-12 01:47:17

我的收藏

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(DescribeUpgradeInstanceCheck)用于在实例变配前,预检查实例变配的影响情况等。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUpgradeInstanceCheck。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 数据库实例ID,形如mssql-njj2mtpl
示例值:mssql-dj5i29c5n
Cpu Integer 实例变配后的CPU核心数,不填则不修改
示例值:1
Memory Integer 实例变配后内存大小,单位GB,不填则不修改
示例值:2
Storage Integer 实例变配后磁盘大小,单位GB,不填则不修改
示例值:500
DBVersion String 实例版本,不填则不修改
示例值:2008R2
HAType String 实例变配后的类型,可选值:CLUSTER-集群,不填则不修改
示例值:CLUSTER
MultiZones String 实例变配后的跨可用区类型,可选值: SameZones-修改为同可用区 MultiZones-修改为跨可用区,不填则不修改
示例值:SameZones

3. 输出参数

参数名称 类型 描述
IsAffect Integer 本变配是否对实例有影响,0-没有影响 1-有影响
示例值:1
Passed Integer 本变配是否可以执行 0-不通过,不能变配 1-通过,可以变配
示例值:1
ModifyMode String 本变配是升配还是降配,down-降配 up-升配
示例值:down
CheckItems Array of CheckItem 检查项列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 检查实例变配

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeUpgradeInstanceCheck
&InstanceId=mssql-30vft2ix
&Cpu=2
&Memory=16
&Storage=256
&DBVersion=2017
&HAType=CLUSTER
&MultiZones=SameZones
&<公共请求参数>

输出示例

{
    "Response": {
        "CheckItems": [
            {
                "CheckName": "CK_CPU",
                "CurrentValue": "0",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_MASTER_STORAGE",
                "CurrentValue": "",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_MEMORY",
                "CurrentValue": "0",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_STORAGE",
                "CurrentValue": "0",
                "IsAffect": 0,
                "Msg": "",
                "MsgCode": 0,
                "Passed": 1
            },
            {
                "CheckName": "CK_UPGRATE",
                "CurrentValue": "MIGRATE",
                "IsAffect": 1,
                "Msg": "version 2008 -> 2017 upgrade requires data migration",
                "MsgCode": 5,
                "Passed": 1
            }
        ],
        "IsAffect": 1,
        "ModifyMode": "up",
        "Passed": 1,
        "RequestId": "44416ab3-794e-47e2-840c-f645efc3481c"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.QueryPriceFailed 计费相关错误,查询价格失败。
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InvalidParameter.InputIllegal 输入错误。
InvalidParameter.NotSupportPubSubInstance 不支持具有发布订阅关系的实例。
InvalidParameter.NotSupportReadOnlyMasterInstance 不支持具有只读副本的主实例。
InvalidParameter.NotSupportSingleInstance 不支持单机版(基础版或者RO副本)实例。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。
InvalidParameterValue.IllegalSpec 实例规格信息错误。
ResourceNotFound.InstanceNotFound 实例不存在。
UnauthorizedOperation.PermissionDenied cam鉴权错误。