DescribeAvailableAdvices - AnalyticDB - Alibaba Cloud Documentation Center

The DescribeAvailableAdvices operation lists available optimization suggestions.

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:DescribeAvailableAdvices

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster. Note Call DescribeDBClusters to view the cluster ID of an AnalyticDB for MySQL cluster.	am-bp198m028ih55****
RegionId	string	Yes	The ID of the region. Note Call DescribeRegions to view the IDs of available regions.	cn-hangzhou
AdviceDate	integer	Yes	The date when the suggestion was generated, in yyyyMMdd format (UTC). Note Data is generated daily after analysis at midnight. Specify a date that is at least one day earlier than today to retrieve results. For example, if today is 20240627, specify 20240626 or an earlier date.	20221124
Lang	string	Yes	The language used to display suggestions. Valid values: zh: Simplified Chinese (default). en: English. ja: Japanese. zh-tw: Traditional Chinese.	zh
PageSize	integer	Yes	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	Yes	The page number. Valid values: integers greater than 0 and less than or equal to the maximum value of the Integer data type. Default value: 1.	1
AdviceType	string	No	The type of suggestion. Valid values: INDEX: Index optimization. TIERING: Hot and cold data optimization.	Index
Keyword	string	No	The keyword used to search for suggestions. Supports fuzzy search by table name.	you_table_name
SchemaTableName	string	No	The concatenation of the database name and table name.	tpch.lineitem
Order	string	No	Sort query results by a specified field. Format as a JSON string, such as `[{"Field":"SchemaName","Type":"Asc"}]`. Values: `Field`: The field to sort by. Valid values: `SchemaName`: Database name. `TableName`: Table name. `Benefit`: Expected optimization benefit. `Type`: The sort order. Valid values: `Asc`: Ascending order. `Desc`: Descending order. Note If not specified, results are sorted by expected optimization benefit in descending order.	[{"Field":"Benefit","Type":"Desc"}]

Response elements

Element	Type	Description	Example
	object	The response object.
Items	array<object>	Details.
	object	The list of suggestions.
AdviceId	string	The ID of the suggestion.	dcd04135-0925-4aed-a5a7-e7d92cb1****
AdviceDate	string	The date when the suggestion was generated, in yyyyMMdd format (UTC).	20221124
AdviceType	string	The type of suggestion. Valid values: Index: Index optimization. Tiering: Hot and cold data optimization.	Index
SQL	string	The SQL statement to apply the suggestion.	alter table `schema1`.`table1` drop key col1_1_idx
Reason	string	The reason for generating the suggestion.	15天未使用，历史使用统计概率小于1%
Benefit	string	The benefit of applying the suggestion.	节省0.4 GB的存储空间。
TotalCount	integer	The total number of suggestions returned. Valid values: integers greater than or equal to 0 and less than or equal to the maximum value of the Integer data type. Default value: 0.	30
PageSize	integer	The number of entries per page. Valid values: 30 (default) 50 100	30
PageNumber	integer	The page number. Valid values: integers greater than 0 and less than or equal to the maximum value of the Integer data type. Default value: 1.	1
SchemaName	string	The database name.	adb_demo
TableName	string	The table name.	test_table
IndexFields	string
PageNumber	integer	The page number. Valid values: integers greater than 0 and less than or equal to the maximum value of the Integer data type. Default value: 1.	1
PageSize	integer	The number of entries per page. Valid values: 30 (default) 50 100	30
RequestId	string	The ID of the request.	96A55627-28E9-5E47-B8F6-D786BE551349
TotalCount	integer	The total number of results returned. Valid values: integers greater than or equal to 0 and less than or equal to the maximum value of the Integer data type. Default value: 0.	30
SchemaTableNames	array	The list of concatenated database names and table names.
	string	The concatenation of the database name and table name.	[ "tpch.lineitem", "tpch.partsupp", "tpch.orders" ]

Examples

Success response

JSON format

{
  "Items": [
    {
      "AdviceId": "dcd04135-0925-4aed-a5a7-e7d92cb1****",
      "AdviceDate": "20221124",
      "AdviceType": "Index",
      "SQL": "alter table `schema1`.`table1` drop key col1_1_idx",
      "Reason": "15天未使用，历史使用统计概率小于1%",
      "Benefit": "节省0.4 GB的存储空间。",
      "TotalCount": 30,
      "PageSize": 30,
      "PageNumber": 1,
      "SchemaName": "adb_demo",
      "TableName": "test_table",
      "IndexFields": ""
    }
  ],
  "PageNumber": 1,
  "PageSize": 30,
  "RequestId": "96A55627-28E9-5E47-B8F6-D786BE551349",
  "TotalCount": 30,
  "SchemaTableNames": [
    "[\n  \"tpch.lineitem\",\n  \"tpch.partsupp\",\n  \"tpch.orders\"\n]"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParameter.PageSize	The PageSize parameter is required.	The PageSize parameter is not specified.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.