修改实例巡检开关状态

最近更新时间:2024-05-27 01:31:05

我的收藏

1. 接口描述

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

修改实例的配置信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyDiagDBInstanceConf。
Version String 公共参数,本接口取值:2021-05-27。
Region String 公共参数,详见产品支持的 地域列表
InstanceConfs InstanceConfs 实例配置,包括巡检、概览开关等。
Regions String 生效实例地域,取值为"All",代表全地域。
示例值:All
Product String 服务产品类型,支持值包括: "mysql" - 云数据库 MySQL, "cynosdb" - 云数据库 CynosDB for MySQL,"redis" - 云数据库 Redis。
示例值:mysql
InstanceIds.N Array of String 指定更改巡检状态的实例ID。
示例值:["cdb-fyclrp7r\n"]

3. 输出参数

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

4. 示例

示例1 修改实例巡检状态

修改实例巡检状态。

输入示例

https://dbbrain.tencentcloudapi.com/?Action=ModifyDiagDBInstanceConf
&InstanceIds.0=cdb-fyclrp7r
&InstanceConfs.DailyInspection=Yes
&Regions=All
&Product=mysql
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "77db16d7-bbe8-48a7-868b-ed776a96f1ab"
    }
}

示例2 修改Redis实例大key周期性分析

开启Redis实例大key周期性分析并自定义分隔符。

输入示例

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

{
    "Product": "redis",
    "Regions": "All",
    "InstanceIds": [
        "crs-pz1raq11"
    ],
    "InstanceConfs": {
        "AnalysisTopKey": "Yes",
        "KeyDelimiters": [
            "_",
            "-",
            ":"
        ]
    }
}

输出示例

{
    "Response": {
        "RequestId": "bcd97ab0-16d1-11ef-8e52-3d11a9997f13"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
InvalidParameterValue 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.UserHasNoStrategy CAM鉴权错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnknownParameter 未知参数错误。
UnsupportedOperation 操作不支持。