DescribeHistoryTasks - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

30 日以内に作成された履歴タスクを照会します。

操作説明

サポートされているデータベースエンジン

MySQL
PostgreSQL
SQL Server

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribeHistoryTasks

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	未処理イベントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-beijing
PageSize	integer	任意	1ページあたりのエントリ数。有効値：10～100。デフォルト値：10。	10
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。デフォルト値：1。	1
InstanceType	string	任意	Instance のみがサポートされています。	Instance
Status	string	任意	タスクステータス。有効値： Scheduled Running Succeed Failed Cancelling Canceled Waiting 複数の値をコンマ (,) で区切ります。デフォルトでは、このパラメーターは空のままです。これは、すべてのステータスのタスクが照会されることを示します。	Scheduled
InstanceId	string	任意	インスタンス ID。複数のインスタンス ID をコンマ (,) で区切ります。最大 30 個のインスタンス ID を指定できます。このパラメーターはデフォルトで空です。これは、インスタンス ID の数を無制限に指定できることを示します。	rm-uf62br2491p5l****
TaskId	string	任意	タスク ID。 DescribeTasks 操作を呼び出してタスク ID を照会できます。複数のタスク ID が存在する場合は、コンマ (,) で区切ります。最大 30 個のタスク ID を指定できます。デフォルトでは、このパラメーターは空のままです。これは、すべてのタスクが照会されることを示します。	t-83br18hloy3faf****
TaskType	string	任意	タスクタイプ。複数のタスクタイプをコンマ (,) で区切ります。最大 30 個のタスクタイプを指定できます。このパラメーターはデフォルトで空です。これは、タスクタイプの数を無制限に指定できることを示します。	autotest_dispatch_cases
FromStartTime	string	必須	照会する時間範囲の開始時刻。このパラメーターで指定された時刻以降の開始時刻を持つタスクのみが照会されます。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 規格で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。開始時刻は、現在時刻より最大 30 日前まで設定できます。このパラメーターを現在時刻より 30 日以上前の時刻に設定した場合、指定された時刻は自動的に現在時刻のちょうど 30 日前の時刻に変換されます。	2022-01-02T11:31:03Z
ToStartTime	string	必須	照会する時間範囲の終了時刻。このパラメーターで指定された時刻以前の開始時刻を持つタスクのみが照会されます。時刻は、yyyy-MM-ddTHH:mm:ssZ 形式の ISO 8601 規格で指定する必要があります。時刻は協定世界時 (UTC) である必要があります。	2022-03-02T11:31:03Z
FromExecTime	integer	任意	タスクの最小実行時間。このパラメーターは、実行時間が最小実行時間より長いタスクをフィルターするために使用されます。単位：秒。デフォルト値は 0 で、制限が課されないことを示します。	0
ToExecTime	integer	任意	タスクの最大実行時間。このパラメーターは、実行時間が最大実行時間以下のタスクをフィルターするために使用されます。単位：秒。デフォルト値は 0 で、制限が課されないことを示します。	0
ResourceGroupId	string	任意	リソースグループの ID。	rg-ae****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Items	array<object>	タスク。
	object	タスクオブジェクト。
ActionInfo	string	タスクに対して実行できる許可された操作のセット。システムは、タスクの現在のステップ名とステータスを、ActionInfo で指定された利用可能な操作と照合します。一致する操作が見つからない場合、タスクの現在のステータスはどの操作もサポートしていません。例： "steps": [ { "step_name": "exec_task", // ステップ名。CurrentStepName と一致します。 "action_info": { // このステップでサポートされる操作。 "Waiting": [ // ステータス。Status と一致します。 "modifySwitchTime" // 操作。複数の操作がサポートされています。 ] } }, { "step_name": "init_task", // ステップ名。 "action_info": { // このステップでサポートされる操作。 "Running": [ // ステータス。 "cancel", // 操作。 "pause" ] } } ] } システムは、次の操作をサポートする場合があります： retry：操作をリトライします。 cancel：操作をキャンセルします。 modifySwitchTime：切り替え時間または復元時間を変更します。	{\"steps\":[{\"action_info\":{\"Waiting\":[\"modifySwitchTime\"]},\"step_name\":\"exec_task\"}]}
CallerSource	string	リクエストを行ったユーザーの ID。 CallerSource が User に設定されている場合、CallerUid はユーザーの一意の ID (UID) を示します。	141345906006****
CallerUid	string	リクエストのソース。有効値： System User	User
CurrentStepName	string	現在のステップ名。このパラメーターが空の場合、タスクは開始されません。	exec_task
DbType	string	データベースタイプ。	mysql
EndTime	string	タスクの終了時刻。	2022-02-03T12:06:17Z
InstanceId	string	インスタンス ID。	rm-uf62br2491p5l****
InstanceName	string	インスタンス名。	test
InstanceType	string	インスタンスカテゴリ。	Instance
Product	string	サービス名。	rds
Progress	number	タスクの進捗状況を示します。	79.0
ReasonCode	string	現在のタスクが開始された理由。	****
RegionId	string	リージョン ID。	cn-shanghai
RemainTime	integer	タスク完了までの推定残り時間。単位：秒。	1000
StartTime	string	タスクの開始時刻。	2022-02-03T11:31:03Z
Status	string	タスクステータス。有効値： Scheduled Running Succeed Failed Cancelling Canceled Waiting	Running
TaskDetail	string	タスク詳細。	{\"callerUid\":\"test\"}
TaskId	string	タスク ID。	t-83br18hloy3faf****
TaskType	string	タスクタイプ。	autotest_dispatch_cases
Uid	string	リソースが属するユーザーの ID。	141345906006****
PageNumber	integer	ページ番号。	1
PageSize	integer	1ページあたりのエントリ数。	10
RequestId	string	リクエストの一意の ID。リクエストが失敗した場合は、この ID をテクニカルサポートに提供して、障害のトラブルシューティングを行ってください。	5CD61041-35F7-10F7-BE94-33A48B22****
TotalCount	integer	ページネーションを考慮せずに、これらの制約を満たすタスクの総数。	2

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	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.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
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.
400	Commodity.InvalidComponent	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.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	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.
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.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	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.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	InvalidRequest	Invalid Request.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	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.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。

ApsaraDB RDS:DescribeHistoryTasks