开通\关闭备机只读

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

我的收藏

1. 接口描述

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

本接口(ModifyDReadable)用于开通或者关闭备机只读

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDReadable。
Version String 公共参数,本接口取值:2018-03-28。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
示例值:mssql-j8kv137v
Type String 操作类型。enable-开启备机只读,disable-关闭备机只读
示例值:disable
VpcId String 备机网络ID,不填默认和主实例保持一致
SubnetId String 备机网络子网ID,不填默认和主实例保持一致
Vip String 指定的备机只读vip,不填自动分配

3. 输出参数

参数名称 类型 描述
FlowId Integer 任务ID
示例值:198081
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开通或者关闭备机只读功能

开通或者关闭备机只读功能

输入示例

POST / HTTP/1.1
Host: sqlserver.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyDReadable
<公共请求参数>

{
    "InstanceId": "mssql-j8kv137v",
    "Type": "enable",
    "VpcId": "vpc-jh8ah7",
    "SubnetId": "sub-i90aoa",
    "Vip": "127.0.0.1"
}

输出示例

{
    "Response": {
        "RequestId": "1fed8472-f117-11ec-be47-525400853186",
        "FlowId": 1012152
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.DBError 数据库错误。
FailedOperation.GcsError 操作失败或者网络超时。
FailedOperation.NotSupport 不支持此类操作。
ResourceNotFound.ParamsNotFound 参数未找到。
ResourceNotFound.VpcNotExist VPC网络不存在。
ResourceUnavailable.InstanceStatusInvalid 实例状态无效。
ResourceUnavailable.VpcNotExist VPC不存在。