UpdateAutoResourceOptimizeRulesAsync - Database Autonomy Service - Alibaba Cloud ドキュメントセンター

Asynchronously configures parameters related to the automatic fragment recycling feature for multiple database instances at a time.

Operation description

Note Asynchronous calls do not immediately return the complete results. To obtain the complete results, you must use the value of ResultId returned in the response to re-initiate the call until the value of isFinish is true.**** In this case, you must call this operation at least twice.

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

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

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

Request parameters

Parameter	Type	Required	Description	Example
ConsoleContext	string	No	The reserved parameter.	None
InstanceIds	string	Yes	The database instance IDs. Note Set this parameter to a JSON array that consists of multiple instance IDs. Separate instance IDs with commas (,). Example: `['Instance ID1', 'Instance ID2']`.	['rm-2ze8g2am97624**','rm-2ze9xrhze0709**']
TableSpaceSize	double	Yes	The minimum storage usage that triggers automatic fragment recycling of a single physical table. Valid values: 5 to 100. Unit: GB.	10
TableFragmentationRatio	double	Yes	The fragmentation rate that triggers automatic fragment recycling of a single physical table. Valid values: 0.10 to 0.99.	0.2
ResultId	string	No	The ID of the asynchronous request. Note Asynchronous calls do not immediately return the complete results. To obtain the complete results, you must use the value of ResultId returned in the response to re-initiate the call until the value of isFinish is true.**** In this case, you must call this operation at least twice.	async__507044db6c4eadfa2dab9b084e80****

Response parameters

Parameter	Type	Description	Example
	object
Code	long	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.
Fail	boolean	Indicates whether the asynchronous request failed. Valid values: true false	false
ConfigResponse	object	The returned data of the configuration. Note The data is returned only if the value of isFinish is true. This value indicates that the asynchronous request is complete.
TotalInstanceCount	long	The total number of database instances.	2
ConfigSuccessInstanceCount	long	The number of database instances for which the parameters are configured.	1
ConfigFailInstanceCount	long	The number of database instances for which the parameters failed to be configured.	1
ConfigSuccessInstanceList	array<object>	The database instances for which the parameters are configured.
configSuccessInstanceList	object
ConfigSuccess	boolean	Indicates whether the parameters are configured. Valid values: true false	true
InstanceId	string	The database instance ID.	rm-2ze8g2am97624****
ConfigFailInstanceList	array<object>	The database instances for which the parameters failed to be configured.
configFailInstanceList	object
ConfigSuccess	boolean	Indicates whether the parameters are configured. Valid values: true false	false
InstanceId	string	The database instance ID.	rm-2ze9xrhze0709****
ErrorMessage	string	The error message returned.	Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON
ResultId	string	The ID of the asynchronous request.	async__20ee808e72257f16a4fe024057ca****
IsFinish	boolean	Indicates whether the asynchronous request was complete. Valid values: true false	true
State	string	The state of the asynchronous request. Valid values: RUNNING SUCCESS FAIL	SUCCESS
Complete	boolean	Indicates whether the asynchronous request was complete. Valid values: true false	true
Timestamp	long	The time when the asynchronous request was made. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1645668213000
RequestId	string	The request ID.	9CB97BC4-6479-55D0-B9D0-EA925AFE****
Success	boolean	Indicates whether the request was successful. Valid values: true false	true

Examples

Sample success responses

JSONformat

{
  "Code": 200,
  "Message": "Successful",
  "Data": {
    "Fail": false,
    "ConfigResponse": {
      "TotalInstanceCount": 2,
      "ConfigSuccessInstanceCount": 1,
      "ConfigFailInstanceCount": 1,
      "ConfigSuccessInstanceList": [
        {
          "ConfigSuccess": true,
          "InstanceId": "rm-2ze8g2am97624****"
        }
      ],
      "ConfigFailInstanceList": [
        {
          "ConfigSuccess": false,
          "InstanceId": "rm-2ze9xrhze0709****",
          "ErrorMessage": "Only Support DAS Pro High-availability Edition RDS MySQL 5.6, 5.7, 8.0 instance, and CPU cores >= 4, innodb_file_per_table=ON"
        }
      ]
    },
    "ResultId": "async__20ee808e72257f16a4fe024057ca****",
    "IsFinish": true,
    "State": "SUCCESS",
    "Complete": true,
    "Timestamp": 1645668213000
  },
  "RequestId": "9CB97BC4-6479-55D0-B9D0-EA925AFE****",
  "Success": true
}

Error codes

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

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

Change history

Change time	Summary of changes	Operation
2023-11-17	The Error code has changed	View Change Details