All Products
Search
Document Center

Database Autonomy Service:UpdateAutoSqlOptimizeStatus

Last Updated:Nov 29, 2024

Enables, modifies, or disables the automatic SQL optimization feature for multiple database instances at a time.

Operation description

Before you call this operation, take note of the following items:

  • If you use an SDK to call API operations of Database Autonomy Service (DAS), you must set the region ID to cn-shanghai.

  • DAS Enterprise Edition must be enabled for the database instance that you want to manage. To enable DAS Enterprise Edition for a database instance, you can call the EnableDasPro operation.

  • The autonomy service must be enabled for the database instance. For more information, see Autonomy center.

  • This operation supports the following database engines:

    • ApsaraDB RDS for MySQL High-availability Edition or Enterprise Edition
    • PolarDB for MySQL Cluster Edition

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
hdm:UpdateAutoSqlOptimizeStatusupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
InstancesstringYes

The database instance IDs. Separate multiple IDs with commas (,).

Note You can specify up to 50 instance IDs.
rm-bp10usoc1erj7****,rm-bp10usoc1erj7****
StatusintegerYes

The status of the automatic SQL optimization feature. Valid values:

  • 0: The automatic SQL optimization feature is disabled.
  • 1: SQL diagnosis and automatic index creation is specified.
  • 3: SQL diagnosis only is specified.
1

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code returned.

200
Messagestring

The returned message.

Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.
Successful
Dataobject

The returned data.

Successstring

Indicates whether the request initiated to configure the automatic SQL optimization feature was successful. Valid values:

  • true
  • false
false
ErrorCodestring

The error code. Valid values:

  • -1001: indicates that the specified parameter is invalid.
  • -91029: indicates that a system error occurred.
-1001
ErrorMsgstring

The error message.

invalid param
RequestIdstring

The request ID.

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

Indicates whether the request was successful. Valid values:

  • true
  • false
true

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError message
400InvalidParamsThe request parameters are invalid.
403NoPermissionYou are not authorized to do this action.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history