DescribeHistoryTasksStat を使用した履歴タスク統計のクエリ - MongoDB

タスクセンターのタスクの概要を照会します。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:DescribeHistoryTasksStat

list

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#InstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	未処理イベントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-beijing
Status	string	任意	タスクステータス。有効な値： Scheduled：タスクは実行待ちです。 Running：タスクは実行中です。 Succeed：タスクは成功しました。 Failed：タスクは失敗しました。 Cancelling：タスクは終了中です。 Canceled：タスクは終了しました。 Waiting：タスクはスケジュールされた時刻を待っています。複数のステータスはコンマ (,) で区切ります。このパラメーターはデフォルトで空であり、すべてのステータスのタスクが照会されることを示します。	Succeed
InstanceId	string	任意	インスタンス ID。複数のインスタンス ID はコンマ (,) で区切ります。最大 30 個のインスタンス ID を指定できます。このパラメーターはデフォルトで空であり、すべてのインスタンスのタスクが照会されることを示します。	dds-8vb38f0e7933xxxx
TaskId	string	任意	タスク ID。複数のタスク ID はコンマ (,) で区切ります。最大 30 個のタスク ID を指定できます。このパラメーターはデフォルトで空であり、すべてのタスクが照会されることを示します。	t-0mq1yyhm3ffl2bxxxx
TaskType	string	任意	タスクタイプ。このパラメーターはデフォルトで空のままにすることができ、その場合はすべてのタイプのタスクが照会されます。有効な値： CreateIns：インスタンスの作成。 DeleteIns：インスタンスの削除。 ChangeVariable：インスタンスのパラメーター設定の変更。 ModifyInsConfig：インスタンスの構成の変更。 RestartIns：インスタンスの再起動。 HaSwitch：インスタンスのプライマリ/セカンダリのスイッチオーバー。 CloneIns：インスタンスのクローン。 KernelVersionUpgrade：インスタンスのマイナーバージョンの更新。 ProxyVersionUpgrade：インスタンスのエージェントバージョンのアップグレード。 ModifyAccount：インスタンスのアカウントの変更。 ModifyInsSpec：インスタンスの仕様変更またはデータ移行。 CreateReadIns：読み取り専用インスタンスの作成。 StartIns：インスタンスの開始。 StopIns：インスタンスの停止。 ModifyNetwork：インスタンスのネットワークタイプの変更。 LockIns：インスタンスのロック。 UnlockIns：インスタンスのロック解除。 DiskOnlineExpansion：インスタンスのディスクのオンライン拡張。 StorageOnlineExpansion：インスタンスのストレージ容量のオンライン拡張。 AddInsNode：インスタンスへのノードの追加。 DeleteInsNode：インスタンスからのノードの削除。 ManualBackupIns：インスタンスの手動バックアップ。 ModifyInsStorageType：インスタンスのストレージタイプの変更。	DeleteIns
FromStartTime	string	必須	実行する O&M タスクの開始時刻。 ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。過去 30 日以内のデータを照会できます。	2023-04-16T02:46:21Z
ToStartTime	string	必須	実行する O&M タスクの終了時刻。 ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で時刻を指定します。時刻は UTC である必要があります。過去 30 日以内のデータを照会できます。	2023-05-16T02:15:52Z
FromExecTime	integer	任意	タスクの最小実行時間。このパラメーターは、実行時間が最小実行時間より長いタスクをフィルターするために使用されます。単位：秒。デフォルト値は 0 で、クエリに制限がないことを示します。	0
ToExecTime	integer	任意	タスクの最大実行時間。このパラメーターは、実行時間が最大実行時間以下のタスクをフィルターするために使用されます。単位：秒。デフォルト値は 0 で、クエリに制限がないことを示します。	0
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmyiu4ekp****

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	FC724D23-XXXX-XXXX-ABB1-606C935AE7FD
Items	array<object>	タスクオブジェクト。
	object
Status	string	タスクステータス。有効な値： Scheduled：タスクは実行待ちです。 Running：タスクは実行中です。 Succeed：タスクは成功しました。 Failed：タスクは失敗しました。 Cancelling：タスクは終了中です。 Canceled：タスクは終了しました。 Waiting：タスクはスケジュールされた時刻を待っています。	Succeed
TotalCount	integer	指定されたステータスのタスク数。	2

例

成功レスポンス

JSONJSON

{
  "RequestId": "FC724D23-XXXX-XXXX-ABB1-606C935AE7FD",
  "Items": [
    {
      "Status": "Succeed",
      "TotalCount": 2
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	Param.Invalid	Param invalid
400	Param.Invalid.TimeEndBeforeStart	Param invalid. End time before start time

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

変更履歴

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