All Products
Search

This Product

    AnalyticDB for MySQL:CreateElasticPlan

    Document Center

    AnalyticDB for MySQL:CreateElasticPlan

    Last Updated:Apr 12, 2024

    Creates a scaling plan for an AnalyticDB for MySQL Data Lakehouse Edition (V3.0) cluster.

    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:CreateElasticPlanWrite
    • All Resources
      *
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ElasticPlanNamestringYes

    The name of the scaling plan.

    Note The name must be 2 to 30 characters in length and can contain letters, digits, and underscores (_). The name must start with a letter.
    		test
    ResourceGroupNamestringNo

    The name of the resource group.

    Note

    • If you want to create a scaling plan that uses interactive resource groups, you must specify this parameter. If you want to create a scaling plan that uses elastic I/O units (EIUs), you do not need to specify this parameter.

    • You can call the DescribeDBResourceGroup operation to query the resource group name for a cluster.

    		test
    StartTimestringNo

    The start time of the scaling plan.

    Note Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
    		2022-01-01T12:01:00Z
    EndTimestringNo

    The end time of the scaling plan.

    Note Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.
    		2025-01-01T12:01:00Z
    EnabledbooleanYes

    Specifies whether to immediately enable the scaling plan after the plan is created. Valid values:

    • true
    • false
    		true
    CronExpressionstringNo

    A CORN expression that specifies the scaling cycle and time for the scaling plan.

    		0 20 14 * * ?
    TargetSizestringNo

    The desired specifications of elastic resources after scaling.

    Note

    • If the scaling plan uses EIUs and Default Proportional Scaling for EIUs is enabled, you do not need to specify this parameter. In other cases, you must specify this parameter.

    • You can call the DescribeElasticPlanSpecifications operation to query the specifications that are supported for scaling plans.

    		32ACU
    TypestringYes

    The type of the scaling plan. Valid values:

    • EXECUTOR: the interactive resource group type, which indicates the computing resource type.
    • WORKER: the EIU type.
    		EXECUTOR
    AutoScalebooleanNo

    Specifies whether to enable Default Proportional Scaling for EIUs. Valid values:

    • true. In this case, storage resources are scaled along with computing resources, and the TargetSize and CronExpression parameters are not supported.
    • false
    Note

    • This parameter must be specified when Type is set to WORKER. This parameter is not required when Type is set to EXECUTOR.

    • You can enable Default Proportional Scaling for EIUs for only a single scaling plan of a cluster.

    		false
    DBClusterIdstringYes

    The cluster ID.

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

    		A5C433C2-001F-58E3-99F5-3274C14DF8BD

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "A5C433C2-001F-58E3-99F5-3274C14DF8BD"
}

    Error codes

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

    Change history

    Change timeSummary of changesOperation
    2023-12-12The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 404
    2023-06-30The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-04-14The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Error Codes 400 change
      delete Error Codes: 404
    2023-04-13The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      Added Error Codes: 400
      Added Error Codes: 404