すべてのプロダクト
Search
ドキュメントセンター

ApsaraDB for MongoDB:DescribeHistoryTasks

最終更新日:Jan 26, 2026

タスクセンターのタスクリストをクエリします。

今すぐお試しください

この 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:DescribeHistoryTasks

list

*Instance

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

なし なし

リクエストパラメーター

パラメーター

必須 / 任意

説明

RegionId

string

任意

未処理イベントのリージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストをクエリできます。

cn-beijing

PageSize

integer

任意

1 ページあたりのエントリ数。 有効値:10~100。 デフォルト値:10。

10

PageNumber

integer

任意

返すページ番号。 値は正の整数である必要があります。 デフォルト値:1。

1

InstanceType

string

任意

インスタンスのインスタンスタイプ。 値を Instance に設定します。

Instance

Status

string

任意

タスクステータス。 有効値:

  • Scheduled:タスクは実行を待機しています。

  • Running:タスクは実行中です。

  • Succeed:タスクは成功しました。

  • Failed:タスクは失敗しました。

  • Cancelling:タスクは終了処理中です。

  • Canceled:タスクは終了しました。

  • Waiting:タスクはスケジュールされた時刻を待機しています。

複数の状態をコンマ (,) で区切ります。 このパラメーターはデフォルトで空で、すべての状態のタスクがクエリされることを示します。

Succeed,Running,Waiting

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:インスタンスのストレージタイプを変更します。

DeleteInsNode

FromStartTime

string

必須

実行する O&M タスクの開始時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定します。 時刻は UTC である必要があります。 過去 30 日以内のデータをクエリできます。

2023-03-15T03:41:26Z

ToStartTime

string

必須

実行する O&M タスクの終了時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で指定します。 時刻は UTC である必要があります。 過去 30 日以内のデータをクエリできます。

2023-03-16T07:21:31Z

FromExecTime

integer

任意

タスクの最小実行時間。 このパラメーターは、実行時間が最小実行時間より長いタスクをフィルターするために使用されます。 単位:秒。 デフォルト値は 0 で、クエリに制限が課されないことを示します。

0

ToExecTime

integer

任意

タスクの最大実行時間。 このパラメーターは、実行時間が最大実行時間以下のタスクをフィルターするために使用されます。 単位:秒。 デフォルト値は 0 で、クエリに制限が課されないことを示します。

0

ResourceGroupId

string

任意

リソースグループの ID。

rg-aek2inrfrnw3xby

レスポンスフィールド

フィールド

説明

object

PageNumber

integer

返されたページのページ番号。

1

RequestId

string

リクエスト ID。

3C4A2494-XXXX-XXXX-93CF-548DB3375193

PageSize

integer

1 ページあたりに返されるエントリの最大数。

10

TotalCount

integer

ページネーションを考慮しない、これらの条件を満たすタスクの総数。

5

Items

array<object>

タスクオブジェクト。

object

Status

string

タスクステータス。 有効値:

  • Scheduled:タスクは実行を待機しています。

  • Running:タスクは実行中です。

  • Succeed:タスクは成功しました。

  • Failed:タスクは失敗しました。

  • Cancelling:タスクは終了処理中です。

  • Canceled:タスクは終了しました。

  • Waiting:タスクはスケジュールされた時刻を待機しています。

Succeed

TaskId

string

タスク ID。

t-0mq1yyhm3ffl2bxxxx

CurrentStepName

string

現在のステップの名前。 このパラメーターが空の場合、タスクは開始されていません。

exec_task

StartTime

string

実行された O&M タスクの開始時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。

2023-02-11T02:33Z

EndTime

string

実行された O&M タスクの終了時刻。 時刻は ISO 8601 規格に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。

2023-03-16T02:59Z

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:インスタンスのストレージタイプを変更します。

CreateIns

RemainTime

integer

推定残り実行時間。 単位:秒。 値 0 はタスクが完了したことを示します。

1000

Progress

number

タスクの現在の進捗。 有効値の範囲は 0~100 です。

100.0

RegionId

string

インスタンスのリージョン ID。

cn-hangzhou

InstanceType

string

インスタンスのインスタンスタイプ。 値は Instance に固定されています。

Instance

InstanceId

string

インスタンス ID

dds-t4n18194768fxxxx

InstanceName

string

インスタンスの名前。

test-dds

DbType

string

データベースタイプ。 値は mongodb に固定されています。

mongodb

Product

string

プロダクト。 値は dds に固定されています。

dds

TaskDetail

string

タスクの詳細。 タスクの詳細は、taskType パラメーターの値によって異なります。

{\"callerUid\":\"test\"}

ReasonCode

string

現在のタスクが開始された理由。

小版本升级

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\"}]}`

Uid

string

リソースが属するユーザーの ID。

141345906006****

CallerSource

string

リクエストソース。 有効値:System および User。

System

CallerUid

string

リクエストを行ったユーザーの ID。 CallerSource が User に設定されている場合、CallerUid はユーザーの一意の ID (UID) を示します。

141345906006****

成功レスポンス

JSONJSON

{
  "PageNumber": 1,
  "RequestId": "3C4A2494-XXXX-XXXX-93CF-548DB3375193",
  "PageSize": 10,
  "TotalCount": 5,
  "Items": [
    {
      "Status": "Succeed",
      "TaskId": "t-0mq1yyhm3ffl2bxxxx",
      "CurrentStepName": "exec_task",
      "StartTime": "2023-02-11T02:33Z",
      "EndTime": "2023-03-16T02:59Z",
      "TaskType": "CreateIns",
      "RemainTime": 1000,
      "Progress": 100,
      "RegionId": "cn-hangzhou",
      "InstanceType": "Instance",
      "InstanceId": "dds-t4n18194768fxxxx",
      "InstanceName": "test-dds",
      "DbType": "mongodb",
      "Product": "dds",
      "TaskDetail": "{\\\"callerUid\\\":\\\"test\\\"}",
      "ReasonCode": "小版本升级",
      "ActionInfo": "`{\\\"steps\\\":[{\\\"action_info\\\":{\\\"Waiting\\\":[\\\"modifySwitchTime\\\"]},\\\"step_name\\\":\\\"exec_task\\\"}]}`",
      "Uid": "141345906006****",
      "CallerSource": "System",
      "CallerUid": "141345906006****"
    }
  ]
}

エラーコード

HTTP ステータスコード

エラーコード

エラーメッセージ

説明

400 Param.Invalid Param invalid
400 Param.Invalid.TimeEndBeforeStart Param invalid. End time before start time

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

変更履歴

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