DescribeElasticDailyPlan - AnalyticDB - Alibaba Cloud Documentation Center

You can call DescribeElasticDailyPlan to query the execution information of a daily time-based scaling plan. This operation applies only to new-version Data Warehouse Edition clusters in elastic mode.

Operation description

Usage notes

This operation applies only to new-version Data Warehouse Edition clusters in elastic mode with 32 or more cores.

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

get

DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the Data Warehouse Edition cluster. Note Call DescribeDBClusters to query the IDs of all Data Warehouse Edition clusters in the destination region.	am-bp11q28kvl688****
ElasticPlanName	string	No	The name of the scaling plan. The name must meet the following requirements: It must be 2 to 30 characters in length. It must consist of uppercase letters, lowercase letters, digits, and underscores (_).	realtimeplan
ResourcePoolName	string	No	The name of the resource group. Note Call DescribeDBResourceGroup to query the name of the resource group.	test
ElasticDailyPlanDay	string	No	The start date of the daily scaling plan. Specify the date in the yyyy-MM-dd format.	2022-12-02
ElasticDailyPlanStatusList	string	No	The execution status of the daily scaling plan. To query multiple statuses, separate them with commas (,). Valid values: 1: Not executed. 2: Executing. 3: Succeeded. 4: Failed.	3

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The request ID.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticDailyPlanList	array<object>	A list of daily scaling plans.
	object	The details of the struct.
Status	integer	The execution status of the daily scaling plan. Valid values: 1: Not executed. 2: Executing. 3: Succeeded. 4: Failed.	3
Day	string	The start date of the daily scaling plan. The date is in the yyyy-MM-dd format.	2022-12-02
ResourcePoolName	string	The name of the resource group.	test
StartTs	string	The actual scale-out time. The time is in the yyyy-MM-dd hh:mm:ss format and is displayed in UTC.	2022-12-02 16:00:00
PlanEndTs	string	The scheduled time to revert the scaled-out resources. The time is in the yyyy-MM-dd hh:mm:ss format and is displayed in UTC.	2022-12-02 16:00:00
PlanStartTs	string	The scheduled scale-out time. The time is in the yyyy-MM-dd hh:mm:ss format and is displayed in UTC.	2022-12-02 15:00:00
ElasticNodeNum	integer	The number of nodes for the scaling plan. If ElasticPlanType is set to worker, this parameter is not returned or the returned value is 0. If ElasticPlanType is set to executorcombineworker or executor, a value greater than 0 is returned.	0
EndTs	string	The actual time when the scaled-out resources were reverted. The time is in the yyyy-MM-dd hh:mm:ss format and is displayed in UTC.	2022-12-02 16:00:00
PlanName	string	The name of the scaling plan.	realtimeplan
ElasticPlanType	string	The resource type for the scaling plan. Valid values: worker: scales only elastic I/O resources. executor: scales only computing resources. executorcombineworker (default): scales both computing resources and elastic I/O resources based on the default ratio.	worker
ElasticPlanWorkerSpec	string	The resource specifications that are supported for scaling. Valid values: 8 Core 64 GB (default) 16 Core 64 GB 32 Core 64 GB 64 Core 128 GB 12 Core 96 GB 24 Core 96 GB 52 Core 86 GB	16 Core 64 GB

Examples

Success response

JSON format

{
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
  "ElasticDailyPlanList": [
    {
      "Status": 3,
      "Day": "2022-12-02",
      "ResourcePoolName": "test",
      "StartTs": "2022-12-02 16:00:00",
      "PlanEndTs": "2022-12-02 16:00:00",
      "PlanStartTs": "2022-12-02 15:00:00",
      "ElasticNodeNum": 0,
      "EndTs": "2022-12-02 16:00:00",
      "PlanName": "realtimeplan",
      "ElasticPlanType": "worker",
      "ElasticPlanWorkerSpec": "16 Core 64 GB"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist. Make sure that the DBClusterId value is valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.