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

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

  • 在使用SDK调用DAS服务时,需要将地域指定为cn-shanghai。
  • 目标数据库实例已开启DAS专业版,您可以调用EnableDasPro接口为指定数据库实例开启DAS专业版。
  • 目标数据库实例已开启自治服务,详情请参见自治中心
  • 本接口适用的数据库引擎为:
    • RDS MySQL高可用版、三节点企业版
    • PolarDB MySQL集群版、高压缩引擎(X-Engine)

请求参数

名称 类型 是否必选 示例值 描述
Action String UpdateAutoSqlOptimizeStatus

系统规定参数。取值:UpdateAutoSqlOptimizeStatus

Instances String rm-bp10usoc1erj7****,rm-bp10usoc1erj7****

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

说明 最多不能输入超过50个数据库实例ID。
Status Integer 1

自动SQL优化功能的状态:

  • 0:关闭自动SQL优化功能。
  • 1:设置为SQL诊断并自动索引创建
  • 3:设置为仅SQL诊断

返回数据

名称 类型 示例值 描述
Code String 200

返回的状态码。

Message String Successful

请求返回消息。

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

返回数据。

Success String false

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

  • true:执行成功。
  • false:执行失败。
ErrorCode String -1001

错误码:

  • -1001:参数错误。
  • -91029:系统错误。
ErrorMsg String invalid param

错误信息。

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

OpenAPI请求的ID。

Success String true

OpenAPI请求是否执行成功:

  • true:执行成功。
  • false:执行失败。

示例

请求示例

http(s)://das.cn-shanghai.aliyuncs.com/?Action=UpdateAutoSqlOptimizeStatus
&Instances=rm-bp10usoc1erj7****,rm-bp10usoc1erj7****
&Status=1
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<UpdateAutoSqlOptimizeStatusResponse>
    <Code>200</Code>
    <Message>Successful</Message>
    <Data>
        <Success>false</Success>
        <ErrorCode>-1001</ErrorCode>
        <ErrorMsg>invalid param</ErrorMsg>
    </Data>
    <RequestId>A52AD37C-35ED-581A-AC23-2232BE54****</RequestId>
    <Success>true</Success>
</UpdateAutoSqlOptimizeStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

HttpCode 错误码 错误信息 描述
400 InvalidParams The request parameters are invalid. 请求参数错误

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