すべてのプロダクト
Search

このプロダクト

    ApsaraDB for MongoDB:DescribeActiveOperationTasks

    ドキュメントセンター

    ApsaraDB for MongoDB:DescribeActiveOperationTasks

    最終更新日:Jan 26, 2026

    MongoDB インスタンスのスケジュールされた操作とメンテナンス（O&M）タスクの詳細をクエリします。

    今すぐお試しください

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

    list

    *Instance

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

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Region

    string

    任意

    未処理イベントが配置されているリージョンの ID です。DescribeRegions 操作を呼び出してリージョン ID を取得します。

    説明

    値 all は、すべてのリージョン ID を示します。

    cn-beijing
    TaskType

    string

    任意

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

    • rds_apsaradb_ha：プライマリ/セカンダリノードのスイッチオーバー。

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

    • rds_apsaradb_upgrade：マイナーバージョンのアップグレード。

    • rds_apsaradb_maxscale：プロキシのマイナーバージョンのアップグレード。

    • all：すべてのタスクタイプ。

    all
    PageSize

    integer

    任意

    1 ページあたりのエントリ数。有効な値：30、50、100。デフォルト値：30。

    30
    PageNumber

    integer

    任意

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

    1
    ProductId

    string

    任意

    プロダクト名。MongoDB インスタンスの場合、このパラメーターを MongoDB に設定します。

    MongoDB
    DbType

    string

    任意

    データベースタイプ。デフォルト値：all。

    mongoDb
    Status

    integer

    任意

    タスクステータス。このパラメーターは、返されるタスクを絞り込みます。

    • -1：すべてのタスク。

    • 3：保留中のタスク。

    • 4：実行中のタスク。

    • 5：正常に完了したタスク。

    • 6：失敗したタスク。

    • 7：キャンセル済みのタスク。

    -1
    InsName

    string

    任意

    インスタンス名。このパラメーターはオプションです。インスタンス名は 1 つのみ指定できます。

    dds-bp16aaccfe10****
    AllowChange

    integer

    任意

    時間を変更できるかどうかを指定します。有効な値：

    • -1 (デフォルト)：すべてのタスクを返します。

    • 0：時間を変更できないタスクのみを返します。

    • 1：時間を変更できるタスクのみを返します。

    -1
    AllowCancel

    integer

    任意

    タスクをキャンセルできるかどうかを指定します。有効な値：

    • -1 (デフォルト)：すべてのタスクを返します。

    • 0：キャンセルできないタスクのみを返します。

    • 1：キャンセルできるタスクのみを返します。

    -1
    ChangeLevel

    string

    任意

    タスクのレベル。有効な値：

    • all (デフォルト)：すべてのタスクを返します。

    • S0：脅威修正のタスクを返します。

    • S1：システム運用保守のタスクを返します。

    ***
    ResourceGroupId

    string

    任意

    リソースグループ ID。

    rg-acfmyiu4ekp****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageNumber

    integer

    ページ番号。

    1
    RequestId

    string

    リクエスト ID。

    111E7B16-0A87-4CBA-B271-F34AD61E****
    PageSize

    integer

    1 ページあたりのエントリ数。

    30
    TotalRecordCount

    integer

    返されたタスクレコードの数。

    1
    Items

    array<object>

    O&M タスクのリスト。

    object

    O&M タスクのリスト。

    Status

    integer

    タスクステータス。

    • 3：保留中。

    • 4：実行中。

    • 5：成功。

    • 6：失敗。

    • 7：キャンセル済み。

    3
    ChangeLevelEn

    string

    イベントレベル (英語)。

    System maintenance
    TaskType

    string

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

    • rds_apsaradb_ha：プライマリ/セカンダリノードのスイッチオーバー。

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

    • rds_apsaradb_upgrade：マイナーバージョンのアップグレード。

    • rds_apsaradb_maxscale：プロキシのマイナーバージョンのアップグレード。

    • all：すべてのタスクタイプ。

    rds_apsaradb_upgrade
    InsName

    string

    インスタンス名。

    dds-bp16aaccfe10****
    Region

    string

    未処理イベントが配置されているリージョンの ID。

    cn-beijing

    ImpactZh

    string

    イベントの影響 (中国語)。

    实例闪断
    CreatedTime

    string

    タスクが作成された時間。時間は yyyy-mm-ddThh:mm:ssZ 形式の UTC 時刻です。

    2023-05-30T14:30:00Z
    SwitchTime

    string

    スイッチオーバーが開始された時間。時間は yyyy-mm-ddThh:mm:ssZ 形式の UTC 時刻です。

    2023-05-30T14:30:00Z
    ChangeLevelZh

    string

    イベントレベル (中国語)。

    系统运维
    Deadline

    string

    タスクの実行時間を延期できる最終時刻。時間は yyyy-mm-ddThh:mm:ssZ 形式の UTC 時刻です。

    2023-05-30T23:59:59Z
    PrepareInterval

    string

    O&M タスクの開始時刻とスイッチオーバー時刻の間に必要な準備時間。時間は HH:mm:ss 形式です。

    04:00:00
    TaskTypeZh

    string

    タスクの理由 (中国語)。

    小版本升级
    CurrentAVZ

    string

    現在のゾーン。

    cn-beijing-h
    AllowChange

    string

    時間を変更できるかどうかを示します。

    • 1：時間を変更できます。

    • 0：時間を変更できません。

    1
    DbVersion

    string

    データベースエンジンのバージョン番号。

    5.6
    ImpactEn

    string

    イベントの影響 (英語)。

    Transient instance disconnection

    InsComment

    string

    インスタンスのエイリアスまたは説明。

    test
    StartTime

    string

    タスクが実行された時間。時間は yyyy-mm-ddThh:mm:ssZ 形式の UTC 時刻です。

    2023-05-30T00:00:00Z
    ModifiedTime

    string

    タスクが変更された時間。時間は yyyy-mm-ddThh:mm:ssZ 形式の UTC 時刻です。

    2023-05-30T14:30:00Z

    AllowCancel

    string

    タスクをキャンセルできるかどうかを示します。

    • 1：タスクはキャンセルできます。

    • 0：タスクはキャンセルできません。

    1
    DbType

    string

    データベースエンジンのタイプ。

    mongoDb
    ChangeLevel

    string

    イベントレベルのコード。

    • S1：システム運用保守。

    • S0：脅威の修正。

    S1
    TaskTypeEn

    string

    タスクの理由 (英語)。

    Minor version update

    ResultInfo

    string

    実行結果に関する情報。

    userCancel
    Id

    integer

    タスク ID。

    11111
    SubInsNames

    array

    サブインスタンスのリスト。

    string

    サブインスタンスの名前。

    sub1369716295573-tes2cy6****.2013052818****
    TaskParams

    string

    タスクパラメーター。

    ""

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "RequestId": "111E7B16-0A87-4CBA-B271-F34AD61E****",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 3,
      "ChangeLevelEn": "System maintenance",
      "TaskType": "rds_apsaradb_upgrade",
      "InsName": "dds-bp16aaccfe10****",
      "Region": "cn-beijing\n",
      "ImpactZh": "实例闪断",
      "CreatedTime": "2023-05-30T14:30:00Z",
      "SwitchTime": "2023-05-30T14:30:00Z",
      "ChangeLevelZh": "系统运维",
      "Deadline": "2023-05-30T23:59:59Z",
      "PrepareInterval": "04:00:00",
      "TaskTypeZh": "小版本升级",
      "CurrentAVZ": "cn-beijing-h",
      "AllowChange": "1",
      "DbVersion": "5.6",
      "ImpactEn": "Transient instance disconnection\n",
      "InsComment": "test",
      "StartTime": "2023-05-30T00:00:00Z",
      "ModifiedTime": "2023-05-30T14:30:00Z\n",
      "AllowCancel": "1",
      "DbType": "mongoDb",
      "ChangeLevel": "S1",
      "TaskTypeEn": "Minor version update\n",
      "ResultInfo": "userCancel",
      "Id": 11111,
      "SubInsNames": [
        "sub1369716295573-tes2cy6****.2013052818****"
      ],
      "TaskParams": "\"\""
    }
  ]
}

    エラーコード

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

    変更履歴

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