DescribeHistoryTasks - ApsaraDB RDS - Alibaba Cloud Documentation Center

Queries the historical tasks that are created within 30 days.

Operation description

Supported database engines

MySQL
PostgreSQL
SQL Server

References

Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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
rds:DescribeHistoryTasks	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the pending event. You can call the DescribeRegions operation to query the most recent region list.	cn-beijing
PageSize	integer	No	The number of entries per page. Valid values: 10 to 100. Default value: 10.	10
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1
InstanceType	string	No	Only Instance is supported.	Instance
Status	string	No	The task status. Valid values: Scheduled Running Succeed Failed Cancelling Canceled Waiting Separate multiple values with commas (,). By default, this parameter is left empty, which indicates that tasks in all statuses are queried.	Scheduled
InstanceId	string	No	The instance ID. Separate multiple instance IDs with commas (,). You can specify up to 30 instance IDs. This parameter is empty by default, which indicates that you can specify an unlimited number of instance IDs.	rm-uf62br2491p5l****
TaskId	string	No	The task ID. You can call the DescribeTasks operation to query the task ID. If multiple task IDs exist, separate them with commas (,). You can specify up to 30 task IDs. By default, this parameter is left empty, which indicates that all tasks are queried.	t-83br18hloy3faf****
TaskType	string	No	The task type. Separate multiple task types with commas (,). You can specify up to 30 task types. This parameter is empty by default, which indicates that you can specify an unlimited number of task types.	autotest_dispatch_cases
FromStartTime	string	Yes	The beginning of the time range to query. Only tasks that have a start time later than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC. The start time can be up to 30 days earlier than the current time. If you set this parameter to a time more than 30 days earlier than the current time, the specified time is automatically converted to a time that is exactly 30 days earlier than the current time.	2022-01-02T11:31:03Z
ToStartTime	string	Yes	The end of the time range to query. Only tasks that have a start time earlier than or equal to the time specified by this parameter are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.	2022-03-02T11:31:03Z
FromExecTime	integer	No	The minimum execution duration of the task. This parameter is used to filter tasks whose execution duration is longer than the minimum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.	0
ToExecTime	integer	No	The maximum execution duration of a task. This parameter is used to filter tasks whose execution duration is shorter than or equal to the maximum execution duration. Unit: seconds. The default value is 0, which indicates that no limit is imposed.	0
ResourceGroupId	string	No	The ID of the resource group.	rg-aekzbvctytru7ua

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
PageNumber	integer	The page number.	1
RequestId	string	The unique ID of the request. If the request fails, provide this ID for technical support to troubleshoot the failure.	5CD61041-35F7-10F7-BE94-33A48B22****
PageSize	integer	The number of entries per page.	10
TotalCount	integer	The total number of tasks that meet these constraints without taking pagination into account.	2
Items	array<object>	The tasks.
Items	object	The task object.
Status	integer	The task status. Valid values: Scheduled Running Succeed Failed Cancelling Canceled Waiting	Running
TaskId	string	The task ID.	t-83br18hloy3faf****
CurrentStepName	string	The name of the current step. If this parameter is left empty, the task is not started.	exec_task
StartTime	string	The start time of the task.	2022-02-03T11:31:03Z
EndTime	string	The end time of the task.	2022-02-03T12:06:17Z
TaskType	string	The task type.	autotest_dispatch_cases
RemainTime	integer	The estimated amount of time remaining to complete the task. Unit: seconds.	1000
Progress	float	Indicates the task progress.	79.0
RegionId	string	The region ID.	cn-shanghai
InstanceType	string	The instance category.	Instance
InstanceId	string	The instance ID.	rm-uf62br2491p5l****
InstanceName	string	The instance name.	test
DbType	string	The database type.	mysql
Product	string	The service name.	rds
TaskDetail	string	The task details.	{\"callerUid\":\"test\"}
ReasonCode	string	The reason why the current task was initiated.	****
ActionInfo	string	A set of allowed actions that can be taken on the task. The system matches the current step name and status of the task to the available actions specified by ActionInfo. If no matching action is found, the current status of the task does not support any action. Example: `"steps": [ { "step_name": "exec_task", // The name of the step, which matches CurrentStepName. "action_info": { // The actions supported for this step. "Waiting": [ // The status, which matches Status. "modifySwitchTime" // The action. Multiple actions are supported. ] } }, { "step_name": "init_task", // The name of the step. "action_info": { // The actions supported for this step. "Running": [ // The status. "cancel", // The action. "pause" ] } } ] }` The system may support the following actions: retry: retries the action. cancel: cancels the action. modifySwitchTime: changes the switching time or restoration time.	{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}
Uid	string	The ID of the user to which the resources belong.	141345906006****
CallerSource	string	The ID of the user who made the request. If CallerSource is set to User, CallerUid indicates the unique ID (UID) of the user.	141345906006****
CallerUid	string	The source of the request. Valid values: System User	User

Examples

Sample success responses

JSONformat

{
  "PageNumber": 1,
  "RequestId": "5CD61041-35F7-10F7-BE94-33A48B22****",
  "PageSize": 10,
  "TotalCount": 2,
  "Items": [
    {
      "Status": 0,
      "TaskId": "t-83br18hloy3faf****",
      "CurrentStepName": "exec_task",
      "StartTime": "2022-02-03T11:31:03Z",
      "EndTime": "2022-02-03T12:06:17Z",
      "TaskType": "autotest_dispatch_cases",
      "RemainTime": 1000,
      "Progress": 79,
      "RegionId": "cn-shanghai",
      "InstanceType": "Instance",
      "InstanceId": "rm-uf62br2491p5l****",
      "InstanceName": "test",
      "DbType": "mysql",
      "Product": "rds",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": " ****",
      "ActionInfo": "{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}",
      "Uid": "141345906006****",
      "CallerSource": "141345906006****",
      "CallerUid": "User"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Param.Invalid	Param invalid	A request parameter error occurred.
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time	The end time cannot be earlier than the start time.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.	-
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.	-
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	BasicInfoUncompleted	Your information is incomplete, Complete your information before the operation.	-
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.	-
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.	-
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.	-
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.	-
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.	-
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.	-
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.

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

Change history

Change time	Summary of changes	Operation
2023-11-20	The Error code has changed. The response structure of the API has changed	View Change Details
2022-06-20	Add Operation	View Change Details