All Products
Search
Document Center

AnalyticDB:ApplyAdviceById

Last Updated:Feb 26, 2026

Calls the ApplyAdviceById operation to apply an optimization suggestion.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

adb:ApplyAdviceById

update

DBCluster

acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}

None None

Request parameters

Parameter

Type

Required

Description

Example

DBClusterId

string

Yes

The ID of the cluster.

Note

You can call the DescribeDBClusters operation to view the cluster ID of an AnalyticDB for MySQL cluster.

am-uf6g8w25jacm7****

RegionId

string

Yes

The ID of the region.

Note

You can call the DescribeRegions operation to view available regions.

cn-hangzhou

AdviceId

string

No

The ID of the suggestion.

0baf1f52-53df-487f-8292-99a03716****

AdviceDate

integer

No

The date when the suggestion was generated. Format: yyyyMMdd (UTC time).

20221101

ApplyType

string

No

BuildImmediately

boolean

No

Response elements

Element

Type

Description

Example

object

The response object.

Message

string

The result of applying the suggestion. Valid values:

  • If the request succeeds, the value is SUCCESS.

  • If the request fails, the value is the specific error message.

Valid values:

  • SUCCESS :

    SUCCESS

  • 报错信息 :

    Error message

SUCCESS

RequestId

string

The ID of the request.

5DC10091-348D-12B1-906D-AB49D658012E

Examples

Success response

JSON format

{
  "Message": "SUCCESS",
  "RequestId": "5DC10091-348D-12B1-906D-AB49D658012E"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.