All Products
Search

This Product

    AnalyticDB for MySQL:ModifyElasticPlan

    Document Center

    AnalyticDB for MySQL:ModifyElasticPlan

    Last Updated:Mar 22, 2024

    Modifies a scheduled scaling plan. This operation can be used only for AnalyticDB for MySQL clusters in elastic mode for Cluster Edition.

    Operation description

    You can call this operation 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.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    adb:ModifyElasticPlanWrite
    • DBCluster
      acs:adb:{#regionId}:{#accountId}:dbcluster/{#DBClusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the AnalyticDB for MySQL Data Warehouse Edition (V3.0) cluster.

    Note You can call the DescribeDBClusters operation to query the IDs of all AnalyticDB for MySQL Data Warehouse Edition (V3.0) clusters within a region.
    		am-bp1rqvm70uh2v****
    ElasticPlanNamestringYes

    The name of the scaling plan.

    • The name must be 2 to 30 characters in length.
    • The name can contain letters, digits, and underscores (_).
    Note You can call the DescribeElasticPlan operation to query the information about all scaling plans of a cluster, including the scaling plan names.
    		realtime
    ResourcePoolNamestringNo

    The name of the resource group.

    Note You can call the DescribeDBResourceGroup operation to query the resource group name.
    		test
    ElasticPlanNodeNumintegerNo

    The number of nodes that are involved in the scaling plan.

    • If ElasticPlanType is set to worker, you can set this parameter to 0 or leave this parameter empty.
    • If ElasticPlanType is set to executorcombineworker or executor, you must set this parameter to a value that is greater than 0.
    		0
    ElasticPlanTimeStartstringNo

    The scale-up time of the scaling plan. Specify the time on the hour in the HH:mm:ss format.

    		8:00:00
    ElasticPlanTimeEndstringNo

    The restoration time of the scaling plan. Specify the time on the hour in the HH:mm:ss format. The interval between the scale-up time and the restoration time cannot be more than 24 hours.

    		10:00:00
    ElasticPlanWeeklyRepeatstringNo

    The days of the week when you want to execute the scaling plan. Valid values: 0 to 6, which indicate Sunday to Saturday. Separate multiple values with commas (,).

    		1,2,3,4,5
    ElasticPlanMonthlyRepeatstringNo

    The dates of the month when you want to execute the scaling plan. A number specifies a date of the month. Separate multiple values with commas (,).

    		1,15,25
    ElasticPlanStartDaystringNo

    The start date of the scaling plan. Specify the date in the yyyy-MM-dd format.

    		2022-12-02
    ElasticPlanEndDaystringNo

    The end date of the scaling plan. Specify the date in the yyyy-MM-dd format.

    		2022-12-09
    ElasticPlanEnablebooleanYes

    Specifies whether the scaling plan takes effect. Valid values:

    • true (default)
    • false
    		true
    ElasticPlanTypestringNo

    The type of the scaling plan. Valid values:

    • worker: scales only elastic I/O resources.
    • executor: scales only computing resources.
    • executorcombineworker (default): scales both elastic I/O resources and computing resources by proportion.
    Note

    • If you want to set this parameter to executorcombineworker, make sure that the cluster runs a minor version of 3.1.3.2 or later.

    • If you want to set this parameter to worker or executor, make sure that the cluster runs a minor version of 3.1.6.1 or later and a ticket is submitted. After your request is approved, you can set this parameter to worker or executor.

    		worker
    ElasticPlanWorkerSpecstringNo

    The resource specifications that can be scaled up by the scaling plan. 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

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		1AD222E9-E606-4A42-BF6D-8A4442913CEF

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400ElasticPlanParameterErrorThe specified elastic plan parameter is invalid.The specified elastic plan parameter is invalid.
    404InvalidDBCluster.NotFoundThe 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.

    Change history

    Change timeSummary of changesOperation
    2024-02-05The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    2023-12-27The Error code has changed. The request parameters of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    Input ParametersThe request parameters of the API has changed.
      Added Input Parameters: ElasticPlanMonthlyRepeat
    2023-04-06The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 404
      Added Error Codes: 400