DescribeElasticDailyPlan - AnalyticDB - Alibaba Cloud Documentation Center

Operation description

This operation is available only for AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters in elastic mode for Cluster Edition that have 32 cores or more.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
adb:DescribeElasticDailyPlan	get	DBCluster acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster. Note You can call the DescribeDBClusters operation to query the cluster IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a specific region.	am-bp11q28kvl688****
ElasticPlanName	string	Yes	The name of the scaling plan. Valid values: The name must be 2 to 30 characters in length. The name can contain letters, digits, and underscores (_).	realtimeplan
ResourcePoolName	string	Yes	The name of the resource group. Note You can call the DescribeDBResourceGroup operation to query the resource group name.	test
ElasticDailyPlanDay	string	Yes	The start date of the current-day scaling plan. Specify the date in the yyyy-MM-dd format.	2022-12-02
ElasticDailyPlanStatusList	string	Yes	The execution state of the current-day scaling plan. Separate multiple values with commas (,). Valid values: 1: The scaling plan is not executed. 2: The scaling plan is being executed. 3: The scaling plan is executed. 4: The scaling plan fails to be executed.	3

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	1AD222E9-E606-4A42-BF6D-8A4442913CEF
ElasticDailyPlanList	array<object>	Details of the current-day scaling plans.
	object
Status	integer	The execution state of the current-day scaling plan. Multiple values are separated by commas (,). Valid values: 1: The scaling plan is not executed. 2: The scaling plan is being executed. 3: The scaling plan is executed. 4: The scaling plan fails to be executed.	3
Day	string	The start date of the current-day 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-up time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.	2022-12-02 16:00:00
PlanEndTs	string	The scheduled restoration time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.	2022-12-02 16:00:00
PlanStartTs	string	The scheduled scale-up time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.	2022-12-02 15:00:00
ElasticNodeNum	integer	The number of nodes involved in the scaling plan. If ElasticPlanType is set to worker, a value of 0 or null is returned. If ElasticPlanType is set to executorcombineworker or executor, a value greater than 0 is returned.	0
EndTs	string	The actual restoration time. The time is in the yyyy-MM-dd hh:mm:ss format. The time is displayed in UTC.	2022-12-02 16:00:00
PlanName	string	The name of the scaling plan.	realtimeplan
ElasticPlanType	string	The type of the scaling plan. Default value: executorcombineworker. Valid values: worker: scales only elastic I/O resources. executor: scales only computing resources. executorcombineworker: scales both elastic I/O resources and computing resources by proportion.	worker
ElasticPlanWorkerSpec	string	The resource specifications that can be scaled up by the scaling plan. Default value: 8 Core 64 GB. Valid values: 8 Core 64 GB 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

Sample success responses

JSONformat

{
  "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.

For a list of error codes, visit the Service error codes.