All Products
Search

This Product

    Database Autonomy Service:ModifyAutoScalingConfig

    Document Center

    Database Autonomy Service:ModifyAutoScalingConfig

    Last Updated:Apr 25, 2024

    Modifies the auto scaling configurations of an instance.

    Operation description

    You can call this operation to modify the following auto scaling configurations of an instance: auto scaling for specifications, automatic storage expansion, automatic bandwidth adjustment, and auto scaling for resources.

    • You can modify the configurations of the auto scaling feature for specifications for the following types of database instances:

      • PolarDB for MySQL Cluster Edition instances. For more information about the feature and the billing rules, see Automatic performance scaling.
      • ApsaraDB RDS for MySQL High-availability Edition instances that use standard SSDs or enhanced SSDs (ESSDs). For more information about the feature and the billing rules, see Automatic performance scaling.

    • You can modify the configurations of the automatic storage expansion feature for the following types of database instances:

      • ApsaraDB RDS for MySQL High-availability Edition instances that use standard SSDs or ESSDs. For more information about the feature and the billing rules, see Automatic space expansion.

    • You can modify the configurations of the automatic bandwidth adjustment feature for the following types of database instances:

      • ApsaraDB for Redis Classic (Local Disk-based) Edition instances. For more information about the feature and the billing rules, see Automatic bandwidth adjustment.

    • You can modify the configurations of the auto scaling feature for resources for the following types of database instances:

      • General-purpose ApsaraDB RDS for MySQL Enterprise Edition instances. For more information about the feature and the billing rules, see Automatic performance scaling.

    • If you use an Alibaba Cloud SDK or Database Autonomy Service (DAS) SDK to call this operation, we recommend that you use the latest version of the SDK.

    • If you use an SDK to call operations of DAS, you must set the region ID to cn-shanghai.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    InstanceIdstringYes

    The instance ID.

    		rm-2ze8g2am97624****
    SpecobjectNo

    The configuration item of the auto scaling feature for specifications.

    ApplybooleanNo

    Specifies whether to apply the Spec configuration of the auto scaling feature for specifications. Valid values:

    • true
    • false
    		true
    UpgradebooleanNo

    Specifies whether to enable the automatic specification scale-up feature. Valid values:

    • true
    • false
    		true
    CpuUsageUpperThresholdintegerNo

    The average CPU utilization threshold that triggers automatic specification scale-up. Unit: %. Valid values:

    • 50
    • 60
    • 70
    • 80
    • 90
    Note This parameter must be specified if the database instance is a PolarDB for MySQL Cluster Edition instance or an ApsaraDB RDS for MySQL High-availability Edition instance that uses standard SSDs or ESSDs.
    		70
    MemUsageUpperThresholdintegerNo

    The average memory usage threshold that triggers automatic specification scale-up. Unit: %. Valid values:

    • 50
    • 60
    • 70
    • 80
    • 90
    Note This parameter must be specified if the database instance is an ApsaraDB for Redis Community Edition cloud-native instance on the China site (aliyun.com).
    		70
    MaxSpecstringNo

    The maximum specifications to which the database instance can be scaled up. The database instance can be upgraded only to a database instance of the same edition with higher specifications. For information about the specifications of different database instances, see the following topics:

    		polar.mysql.x8.12xlarge
    MaxReadOnlyNodesintegerNo

    The maximum number of read-only nodes of the instance.

    Note This parameter must be specified if the database instance is a PolarDB for MySQL Cluster Edition instance.
    		10
    ObservationWindowSizestringNo

    The observation window. The value of this parameter consists of a numeric value and a time unit suffix. The m time unit suffix specifies the minute and the h time unit suffix specifies the hour.

    • Valid values for PolarDB for MySQL Cluster Edition instances: 5m, 10m, 15m, and 30m.
    • Valid values for ApsaraDB RDS for MySQL High-availability Edition instances that use standard SSDs or ESSDs: 5m, 20m, 30m, 40m, and 1h.
    • Valid values for ApsaraDB for Redis Community Edition cloud-native instances: 5m, 10m, 15m, and 30m.
    		5m
    CoolDownTimestringNo

    The quiescent period. The value of this parameter consists of a numeric value and a time unit suffix. The m time unit suffix specifies the minute, the h time unit suffix specifies the hour, and the d time suffix unit specifies the day.

    • Valid values for PolarDB for MySQL Cluster Edition instances: 5m, 10m, 30m, 1h, 2h, 3h, 1d, and 7d.
    • Valid values for ApsaraDB RDS for MySQL High-availability Edition instances that use standard SSDs or ESSDs: 5m, 10m, 30m, 1h, 2h, 3h, 1d, and 7d.
    		5m
    DowngradebooleanNo

    Specifies whether to enable the automatic specification scale-down feature. Valid values:

    • true
    • false
    Note This parameter must be specified if the database instance is a PolarDB for MySQL Cluster Edition instance or an ApsaraDB RDS for MySQL High-availability Edition instance that uses standard SSDs or ESSDs.
    		true
    StorageobjectNo

    The configuration item of the automatic storage expansion feature.

    ApplybooleanNo

    Specifies whether to apply the Storage configuration of the automatic storage expansion feature. Valid values:

    • true
    • false
    		true
    UpgradebooleanNo

    Specifies whether to enable the automatic storage expansion feature. Valid values:

    • true
    • false
    		true
    DiskUsageUpperThresholdintegerNo

    The average storage usage threshold that triggers automatic storage expansion. Unit: %. Valid values:

    • 50
    • 60
    • 70
    • 80
    • 90
    		70
    MaxStorageintegerNo

    The maximum storage size of the database instance. The value must be greater than or equal to the total storage size of the instance. Valid values of different types of instances:

    • If the ApsaraDB for RDS instance uses ESSDs, the value of this parameter can be set to 32000, in GB.
    • If the ApsaraDB for RDS instance uses standard SSDs, the value of this parameter can be set to 6000, in GB.
    Note The ApsaraDB RDS for MySQL instances that use standard SSDs are discontinued. We recommend that you upgrade the storage type of an ApsaraDB RDS for MySQL instance from standard SSDs to ESSDs.
    		32000
    BandwidthobjectNo

    The configuration item of the automatic bandwidth adjustment feature.

    ApplybooleanNo

    Specifies whether to apply the Bandwidth configuration of the automatic bandwidth adjustment feature. Valid values:

    • true
    • false
    		true
    UpgradebooleanNo

    Specifies whether to enable the automatic bandwidth upgrade feature. Valid values:

    • true
    • false
    		true
    BandwidthUsageUpperThresholdintegerNo

    The average bandwidth usage threshold that triggers automatic bandwidth upgrade. Unit: %. Valid values:

    • 50
    • 60
    • 70
    • 80
    • 90
    • 95
    		70
    ObservationWindowSizestringNo

    The observation window of the automatic bandwidth adjustment feature. The value of this parameter consists of a numeric value and a time unit suffix. The m time unit suffix specifies the minute. Valid values:

    • 1m
    • 5m
    • 10m
    • 15m
    • 30m
    		5m
    DowngradebooleanNo

    Specifies whether to enable the automatic bandwidth downgrade feature. Valid values:

    • true
    • false
    		true
    BandwidthUsageLowerThresholdintegerNo

    The average bandwidth usage threshold that triggers automatic bandwidth downgrade. Unit: %. Valid values:

    • 10
    • 20
    • 30
    		30
    ShardobjectNo

    The configuration item of the auto scaling feature for shards.

    ApplybooleanNo

    Specifies whether to apply the Shard configuration of the auto scaling feature for shards. Valid values:

    • true
    • false
    Note The auto scaling feature for shards is available only for ApsaraDB for Redis Community Edition cloud-native instances on the China site (aliyun.com).
    		true
    UpgradebooleanNo

    Specifies whether to enable the feature of automatically adding shards. Valid values:

    • true
    • false
    		true
    MemUsageUpperThresholdintegerNo

    The average memory usage threshold that triggers automatic adding of shards. Unit: %. Valid values:

    • 50
    • 60
    • 70
    • 80
    • 90
    		70
    MaxShardsintegerNo

    The maximum number of shards in the instance. The value must be a positive integer. Valid values: 4 to 32.

    		16
    UpgradeObservationWindowSizestringNo

    The observation window of the feature of automatically adding shards. The value of this parameter consists of a numeric value and a time unit suffix. The m time unit suffix specifies the minute. Valid values:

    • 5m
    • 10m
    • 15m
    • 30m
    		5m
    DowngradebooleanNo

    Specifies whether to enable the feature of automatically removing shards. Valid values:

    • true
    • false
    Note The feature of automatically removing shards is in canary release.
    		true
    MemUsageLowerThresholdintegerNo

    The average memory usage threshold that triggers automatic removal of shards. Unit: %. Valid values:

    • 10
    • 20
    • 30
    		30
    MinShardsintegerNo

    The minimum number of shards in the instance. The value must be a positive integer. Valid values: 4 to 32.

    		4
    DowngradeObservationWindowSizestringNo

    The observation window of the feature of automatically removing shards. The value of this parameter consists of a numeric value and a time unit suffix. The h time unit suffix specifies the hour. The d time unit suffix specifies the day. Valid values:

    • 1h
    • 2h
    • 3h
    • 1d
    • 7d
    		1h
    ResourceobjectNo

    The configuration item of the auto scaling feature for resources.

    ApplybooleanNo

    Specifies whether to apply the Resource configuration of the auto scaling feature for resources. Valid values:

    • true
    • false
    		true
    EnablebooleanNo

    Specifies whether to enable the auto scaling feature for resources. Valid values:

    • true
    • false
    		true
    CpuUsageUpperThresholdintegerNo

    The average CPU utilization threshold that triggers automatic scale-out of resources. Unit: %. Valid values:

    • 70
    • 80
    • 90
    		70
    UpgradeObservationWindowSizestringNo

    The observation window of the automatic resource scale-out feature. The value of this parameter consists of a numeric value and a time unit suffix. The m time unit suffix specifies the minute. Valid values:

    • 1m
    • 3m
    • 5m
    • 10m
    • 20m
    • 30m
    		5m
    DowngradeObservationWindowSizestringNo

    The observation window of the automatic resource scale-in feature. The value of this parameter consists of a numeric value and a time unit suffix. The m time unit suffix specifies the minute. Valid values:

    • 1m
    • 3m
    • 5m
    • 10m
    • 20m
    • 30m
    		5m

    Response parameters

    ParameterTypeDescriptionExample
    object
    Codestring

    The HTTP status code returned.

    		200
    Messagestring

    The returned message.

    Note If the request was successful, Successful is returned. If the request failed, an error message such as an error code is returned.
    		Successful
    RequestIdstring

    The request ID.

    		B6D17591-B48B-4D31-9CD6-9B9796B2****
    Successstring

    Indicates whether the request was successful. Valid values:

    • true
    • false
    		true

    Examples

    Sample success responses

    JSONformat

    {
  "Code": "200",
  "Message": "Successful",
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": "true"
}

    Error codes

    HTTP status codeError codeError message
    400InvalidParamsThe request parameters are invalid.
    403NoPermissionYou are not authorized to do this action.

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

    Change history

    Change timeSummary of changesOperation
    2024-02-22The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400