DescribeMvRecommendTasks - AnalyticDB - Alibaba Cloud Documentation Center

Views recommendation tasks for materialized views.

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

get

*DBClusterLakeVersion

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

None

Request parameters

Parameter	Type	Required	Description	Example
TaskName	string	No	The name of the materialized view recommendation task.	my_task_1
PageNumber	integer	No	The page number.	1
PageSize	integer	No	The number of entries per page.	30
DBClusterId	string	No	The cluster ID.	amv-bp11q28kvl688****
RegionId	string	No	The region ID.	cn-hangzhou
From	string	No	A static field. This parameter cannot be modified.	不支持修改
ActionInner	string	No	A static field. This parameter cannot be modified.	不支持修改

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
TotalCount	integer	The total number of entries.	4
Data	object	The returned data.
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	30
TotalCount	integer	The total number of entries.	4
MvRecommendTaskModels	array	The list of materialized view recommendation tasks.
	open_struct_MvRecommendTaskModel	The details of the materialized view recommendation task.

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalCount": 4,
  "Data": {
    "PageNumber": 1,
    "PageSize": 30,
    "TotalCount": 4,
    "MvRecommendTaskModels": [
      {
        "Description": "task desc\n",
        "CreatedTime": "2024-12-12 23:59",
        "LastRunAt": "2024-12-13 00:10",
        "TaskName": "mv_task1",
        "ScanQueriesRange": 3,
        "SchedulingSettings": "The 12:30 every day",
        "MinRewriteQueryCount": 3,
        "MinRewriteQueryPattern": 5,
        "SlowQueryThreshold": 2
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	MDS.IllegalArgument	Invalid argument.	An invalid parameter is used.
400	MDS.InvalidPrivilege	No permissions.	You are not authorized to perform this operation.
400	MDS.MetaSchemaAlreadyExist	The database already exists.	The specified database already exists.
400	MDS.MetaSchemaNotExist	The database does not exist.	The specified database does not exist.
400	MDS.MetaTableAlreadyExist	The table already exists.	The specified table already exists.
400	MDS.MetaTableNotExist	The table is not found.	The specified table does not exist.
500	MDS.InternalError	An internal MDS error occurred.	An internal error occurred.
500	MDS.MetaVisitError	Failed to access metadata.	Failed to access the metadata.
403	MDS.RamAuthAccessDenied	ram auth access denied.	RAM authentication failed

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.