UpdateAutoSqlOptimizeStatus - 批量开启、修改或关闭自动SQL优化功能

更新时间:
复制为 MD 格式

调用UpdateAutoSqlOptimizeStatus接口,批量开启、修改或关闭自动SQL优化功能。

接口说明

使用该接口需满足以下前提条件:

  • 在使用 SDK 调用 DAS 服务时,需要将地域指定为 cn-shanghai。

  • 目标数据库实例已开启 DAS 企业版,您可以调用 EnableDasPro 接口为指定数据库实例开启 DAS 企业版。

  • 目标数据库实例已开启自治服务,详情请参见自治中心

  • 本接口适用的数据库引擎为:

    • RDS MySQL 高可用系列、三节点企业系列

    • PolarDB MySQL 版的集群版

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hdm:UpdateAutoSqlOptimizeStatus

update

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Instances

string

数据库实例 ID,多个 ID 间以英文逗号(,)分隔。

说明

最多不能输入超过 50 个数据库实例 ID。

rm-bp10usoc1erj7****,rm-bp10usoc1erj7****

Status

integer

自动 SQL 优化功能的状态:

  • 0:关闭自动 SQL 优化功能。

  • 1:设置为SQL 诊断并自动索引创建

  • 3:设置为仅 SQL 诊断

1

返回参数

名称

类型

描述

示例值

object

Code

string

返回的状态码。

200

Message

string

请求返回消息。

说明

请求成功时该参数返回 Successful,请求失败时会返回请求异常信息(如错误码等)。

Successful

Data

object

返回数据。

Success

string

设置自动 SQL 优化功能请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

false

ErrorCode

string

错误码:

  • -1001:参数错误。

  • -91029:系统错误。

-1001

ErrorMsg

string

错误信息。

invalid param

RequestId

string

OpenAPI 请求的 ID。

A52AD37C-35ED-581A-AC23-2232BE54****

Success

string

OpenAPI 请求是否执行成功:

  • true:执行成功。

  • false:执行失败。

true

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "Successful",
  "Data": {
    "Success": "false",
    "ErrorCode": "-1001",
    "ErrorMsg": "invalid param"
  },
  "RequestId": "A52AD37C-35ED-581A-AC23-2232BE54****",
  "Success": "true"
}

错误码

HTTP status code

错误码

错误信息

描述

400 InvalidParams The request parameters are invalid. 请求参数错误
403 NoPermission You are not authorized to do this action. 没有权限执行该操作

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情