DescribeRecommendIndex - ApsaraDB for OceanBase (Deprecated)

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

oceanbase:DescribeRecommendIndex

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TenantId	string	Yes	The index recommended for the SQL statement after calculation by the diagnostic system. If the recommended index is the primary key, PRIMARY is returned. If an index created by the user is recommended, the index name is returned. The system recommends only one index for an SQL statement. You can call the DescribeIndexes operation to view the indexes of a table.	t2mr3oae0****
InstanceId	string	Yes	The return result of the request.	ob317v4uif****
SQLId	string	Yes	The ID of the OceanBase cluster.	8D6E84**0B8FB1823D199E2CA1**

Response elements

Element	Type	Description	Example
	object	You can obtain the SQL ID from the return value of the DescribeSlowSQLList or DescribeTopSQLList operation.
RequestId	string	The tenant mode. Valid values: Oracle MySQL	EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C
RecommendIndex	object	The information about the recommended index.
SuggestIndex	string	Example 1	PRIMARY
TenantMode	string	Returns the tenant mode. Supported modes are: Oracle: Oracle mode. MySQL: MySQL mode.	mysql
TableList	string	Table information. Returns the data tables involved in the SQL statement corresponding to the SQLID. For a single-table query, it returns the single accessed data table. For a join query, it returns all data tables accessed by the SQL statement, separated by VERTICAL LINE, such as "Table1\|Table2".	testtable

Examples

Success response

JSON format

{
  "RequestId": "EE205C00-30E4-XXXX-XXXX-87E3A8A2AA0C",
  "RecommendIndex": {
    "SuggestIndex": "PRIMARY",
    "TenantMode": "mysql",
    "TableList": "testtable"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
2014	InternalError	The request processing has failed due to some unknown error.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.