すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeActiveOperationTask

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeActiveOperationTask

    最終更新日:Jan 26, 2026

    ApsaraDB for 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:DescribeActiveOperationTask

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Region

    string

    必須

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

    説明

    Region パラメーターを all に設定すると、ご利用の Alibaba Cloud アカウントで作成されたすべてのタスクが照会されます。この場合、taskType パラメーターを all に設定する必要があります。

    cn-shanghai
    TaskType

    string

    必須

    タスクのタイプ。有効な値：

    • rds_apsaradb_ha：マスター/レプリカスイッチオーバー

    • rds_apsaradb_transfer：インスタンスの移行

    • rds_apsaradb_upgrade：マイナーバージョンの更新

    rds_apsaradb_ha
    IsHistory

    integer

    任意

    履歴タスクを返すかどうかを指定します。

    デフォルト値：0。有効な値：

    • 0：現在のタスクを返します。

    • 1：履歴タスクを返します。

    0
    PageSize

    integer

    任意

    各ページに返すエントリの数。10 より大きい値を指定します。デフォルト値：30。

    30
    PageNumber

    integer

    任意

    返すページ番号。0 より大きい整数である必要があります。デフォルト値：1。

    1
    ProductId

    string

    任意

    プロダクトの ID です。

    MongoDB

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalRecordCount

    integer

    返されたエントリの総数です。

    0
    RequestId

    string

    リクエスト ID です。

    6FD47DC4-0750-5524-A89E-E7D559Cxxxxx
    PageSize

    integer

    ページごとに返されるエントリの数です。

    30
    PageNumber

    integer

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

    1
    Items

    array<object>

    タスクのリストです。

    object

    Status

    integer

    タスクの状態。有効な値：

    • 2：ユーザーがスイッチオーバー時間を指定するのを待機しています。

    • 3：タスクの実行を待機しています。

    • 4：タスクは実行中です。タスクがこの状態の場合、ModifyActiveOperationTask 操作を呼び出して予定切り替え日時を変更することはできません。

    • 5：タスクは実行されました。

    • 6：タスクは失敗しました。

    • 7：タスクはキャンセルされました。

    2
    TaskParams

    string

    タスクのパラメーターです。

    ""
    PrepareInterval

    string

    タスクの開始時刻とスイッチオーバー時間の間に必要な準備期間です。時間は HH:mm:ss 形式で表示されます。

    14:00:00
    Deadline

    string

    タスクの実行時間を変更できる締め切りです。時刻は UTC で、yyyy-MM-ddTHH:mm:ssZ 形式で表示されます。

    2023-03-29T13:59:59Z
    StartTime

    string

    タスクが実行された時刻です。時刻は ISO 8601 規格に準拠した yyyy-MM-ddThh:mm:ssZ 形式で、UTC で表示されます。

    2023-03-20T02:40:00Z
    TaskType

    string

    タスクのタイプ。有効な値：

    • rds_apsaradb_ha：マスター/レプリカスイッチオーバー

    • rds_apsaradb_transfer：インスタンスの移行

    • rds_apsaradb_upgrade：マイナーバージョンの更新

    • all：すべてのタイプ

    rds_apsaradb_ha
    ModifiedTime

    string

    タスクが変更された時刻です。時刻は ISO 8601 規格に準拠した yyyy-MM-ddThh:mm:ssZ 形式で、UTC で表示されます。

    2023-02-24T08:18:53Z
    InsName

    string

    インスタンス ID です。

    dds-bp12721xxxx9b914
    DbType

    string

    インスタンスのデータベースタイプです。

    mongodb
    Region

    string

    インスタンスのリージョンです。

    cn-beijing
    ResultInfo

    string

    結果情報です。

    ""
    CreatedTime

    string

    タスクが作成された時刻です。時刻は ISO 8601 規格に準拠した yyyy-MM-ddThh:mm:ssZ 形式で、UTC で表示されます。

    2024-11-06T13:11:08Z
    Id

    integer

    タスク ID です。

    50xx
    SwitchTime

    string

    システムがスイッチオーバー操作を実行する時刻です。時刻は ISO 8601 規格に準拠した yyyy-MM-ddThh:mm:ssZ 形式で、UTC で表示されます。

    2024-11-06T14:11:08Z

    例

    成功レスポンス

    JSONJSON

    {
  "TotalRecordCount": 0,
  "RequestId": "6FD47DC4-0750-5524-A89E-E7D559Cxxxxx",
  "PageSize": 30,
  "PageNumber": 1,
  "Items": [
    {
      "Status": 2,
      "TaskParams": "\"\"",
      "PrepareInterval": "14:00:00",
      "Deadline": "2023-03-29T13:59:59Z",
      "StartTime": "2023-03-20T02:40:00Z",
      "TaskType": "rds_apsaradb_ha",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "dds-bp12721xxxx9b914",
      "DbType": "mongodb",
      "Region": "cn-beijing",
      "ResultInfo": "\"\"",
      "CreatedTime": "2024-11-06T13:11:08Z",
      "Id": 0,
      "SwitchTime": "2024-11-06T14:11:08Z\n"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 RequiredParam.NotFound Required input param is not found.

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

    変更履歴

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