GetAutoResourceOptimizeRules-阿里云帮助中心

Queries the automatic fragment recycling rules of database instances.

Operation description

Before you call this operation, take note of the following items:

If you use an SDK to call API operations of Database Autonomy Service (DAS), you must set the region ID to cn-shanghai.
The database instance is an ApsaraDB RDS for MySQL instance of High-availability Edition.
The database instance has four or more cores, and innodb_file_per_table is set to ON.

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

hdm:GetAutoResourceOptimizeRules

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
InstanceIds	string	No	The database instance IDs. Specify the parameter value as a JSON array, such as `['Database account 1','Database account 2']`. Separate database instance IDs with commas (,). By default, if you leave this parameter empty, all database instances for which the automatic fragment recycling feature has been enabled within the current Alibaba Cloud account are returned. The following types of database instances are returned: Database instances for which the automatic fragment recycling feature is currently enabled. Database instances for which the automatic fragment recycling feature was once enabled but is currently disabled, including those for which DAS Enterprise Edition has been disabled but excluding those that have been released.	['rm-2ze8g2am97624**','rm-2vc54m2a6pd6p','rm-2ze9xrhze0709','rm-2ze8g2am97627**']

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code returned.	200
Message	string	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
Data	object	The data returned.
TotalAutoResourceOptimizeRulesCount	integer	The number of database instances for which the automatic fragment recycling feature has been enabled.	3
EnableAutoResourceOptimizeCount	integer	The number of database instances for which the automatic fragment recycling feature is currently enabled.	1
TurnOffAutoResourceOptimizeCount	integer	The number of database instances for which the automatic fragment recycling feature was once enabled but is currently disabled.	1
HasEnableRuleButNotDasProCount	integer	The number of database instances for which the automatic fragment recycling feature is enabled and DAS Enterprise Edition is disabled.	1
EnableAutoResourceOptimizeList	array<object>	The database instances for which the automatic fragment recycling feature is currently enabled.
	object
InstanceId	string	The database instance ID.	rm-2ze8g2am97624****
AutoDefragment	boolean	Indicates whether the automatic fragment recycling feature is enabled. Valid values: true false	true
TableSpaceSize	number	The minimum storage usage of a single physical table for which the automatic fragment recycling feature is enabled. Unit: GB.	10
DasProOn	boolean	Indicates whether DAS Enterprise Edition is enabled. Valid values: true false	true
TableFragmentationRatio	number	The fragmentation rate of a single physical table for which the automatic fragment recycling feature is enabled.	0.2
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
TurnOffAutoResourceOptimizeList	array<object>	The database instances for which the automatic fragment recycling feature was once enabled but is currently disabled.
	object
InstanceId	string	The database instance ID.	rm-2vc54m2a6pd6p****
AutoDefragment	boolean	Indicates whether the automatic fragment recycling feature is enabled. Valid values: true: false	false
TableSpaceSize	number	The minimum storage usage of a single physical table for which the automatic fragment recycling feature is enabled. Unit: GB.	10
DasProOn	boolean	Indicates whether DAS Enterprise Edition is enabled. Valid values: true false	true
TableFragmentationRatio	number	The fragmentation rate of a single physical table for which the automatic fragment recycling feature is enabled.	0.2
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
HasEnableRuleButNotDasProList	array<object>	The database instances for which the automatic fragment recycling feature is enabled and DAS Enterprise Edition is disabled. Note Automatic fragment recycling tasks are run on this type of database instances only if DAS Enterprise Edition is enabled for the database instances again.
	object
InstanceId	string	The database instance ID.	rm-2ze9xrhze0709****
AutoDefragment	boolean	Indicates whether the automatic fragment recycling feature is enabled. Valid values: true false	true
TableSpaceSize	number	The minimum storage usage of a single physical table for which the automatic fragment recycling feature is enabled. Unit: GB.	10
DasProOn	boolean	Indicates whether DAS Enterprise Edition is enabled. Valid values: true false	false
TableFragmentationRatio	number	The fragmentation rate of a single physical table for which the automatic fragment recycling feature is enabled.	0.2
UserId	string	The ID of the Alibaba Cloud account that is used to create the database instance.	140692647406****
NeverEnableAutoResourceOptimizeOrReleasedInstanceCount	integer	The number of database instances that do not exist or for which the automatic fragment recycling feature has never been enabled. Note If a database instance does not exist, the instance has been released or the specified instance ID is invalid.	1
NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList	array	The database instances that do not exist or for which the automatic fragment recycling feature has never been enabled.
	string	The database instance ID.	rm-2ze8g2am97624****
RequestId	string	The request ID.	B6D17591-B48B-4D31-9CD6-9B9796B2****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "TotalAutoResourceOptimizeRulesCount": 3,
    "EnableAutoResourceOptimizeCount": 1,
    "TurnOffAutoResourceOptimizeCount": 1,
    "HasEnableRuleButNotDasProCount": 1,
    "EnableAutoResourceOptimizeList": [
      {
        "InstanceId": "rm-2ze8g2am97624****",
        "AutoDefragment": true,
        "TableSpaceSize": 10,
        "DasProOn": true,
        "TableFragmentationRatio": 0.2,
        "UserId": "140692647406****"
      }
    ],
    "TurnOffAutoResourceOptimizeList": [
      {
        "InstanceId": "rm-2vc54m2a6pd6p****",
        "AutoDefragment": false,
        "TableSpaceSize": 10,
        "DasProOn": true,
        "TableFragmentationRatio": 0.2,
        "UserId": "140692647406****"
      }
    ],
    "HasEnableRuleButNotDasProList": [
      {
        "InstanceId": "rm-2ze9xrhze0709****",
        "AutoDefragment": true,
        "TableSpaceSize": 10,
        "DasProOn": false,
        "TableFragmentationRatio": 0.2,
        "UserId": "140692647406****"
      }
    ],
    "NeverEnableAutoResourceOptimizeOrReleasedInstanceCount": 1,
    "NeverEnableAutoResourceOptimizeOrReleasedInstanceIdList": [
      "rm-2ze8g2am97624****"
    ]
  },
  "RequestId": "B6D17591-B48B-4D31-9CD6-9B9796B2****",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The request parameters are invalid.
403	NoPermission	You are not authorized to do this action.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.