すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):DescribeActiveOperationTask

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):DescribeActiveOperationTask

    最終更新日:Mar 30, 2026

    Tair (Redis OSS-compatible) インスタンスの O&M タスクの詳細を照会します。

    操作説明

    本 API オペレーションを呼び出して特定の O&M タスクの情報を照会した後、ModifyActiveOperationTask オペレーションを呼び出して、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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:DescribeActiveOperationTask

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    Region

    string

    必須

    O&M タスクのリージョン ID です。最新のリージョン一覧を照会するには、DescribeRegions オペレーションを呼び出します。

    説明

    all を指定すると、すべてのリージョン ID が対象になります。

    all
    TaskType

    string

    必須

    O&M タスクのタイプです。有効な値は以下のとおりです。

    • rds_apsaradb_ha: マスターレプリカ間のスイッチオーバー

    • rds_apsaradb_transfer: インスタンス移行

    • rds_apsaradb_upgrade: マイナーバージョンアップ

    rds_apsaradb_ha
    IsHistory

    integer

    任意

    履歴タスクを返すかどうかを指定します。デフォルト値は 0 です。有効な値は以下のとおりです。

    • 0: 現在実行中のタスクを返します。

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

    1
    PageSize

    integer

    任意

    1 ページあたりに返すエントリ数です。10 より大きい値を指定してください。デフォルト値は 30 です。

    30
    PageNumber

    integer

    任意

    返すページ番号です。正の整数を指定してください。デフォルト値は 1 です。

    1

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    PageNumber

    integer

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

    1
    RequestId

    string

    リクエストの ID です。

    2E1FF0CC-F42A-4B6F-A1F4-A17B1451****
    PageSize

    integer

    1 ページあたりに返す最大エントリ数です。

    30
    TotalRecordCount

    integer

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

    1
    Items

    array<object>

    O&M タスクの一覧です。

    object

    Status

    integer

    O&M タスクの状態です。有効な値は以下のとおりです。

    • 2: スイッチオーバー日時の指定をユーザーが待機中です。

    • 3: 実行待ち状態です。

    • 4: 実行中です。この状態の場合、ModifyActiveOperationTask オペレーションで予定切り替え日時を変更することはできません。

    • 5: 実行完了です。

    • 6: 実行失敗です。

    • 7: キャンセル済みです。

    5
    Deadline

    string

    O&M タスクの実行時刻を変更できる最終期限です。協定世界時 (UTC) で表示され、yyyy-MM-ddTHH:mm:ssZ 形式です。

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

    string

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

    14:00:00
    TaskType

    string

    タスクの種類です。有効な値は以下のとおりです。

    • rds_apsaradb_ha: マスターレプリカ間のスイッチオーバー

    • rds_apsaradb_transfer: インスタンス移行

    • rds_apsaradb_upgrade: マイナーバージョンアップ

    • all: すべての種類

    rds_apsaradb_upgrade
    StartTime

    string

    O&M タスクの実行時刻です。ISO 8601 標準に従い、yyyy-MM-ddThh:mm:ssZ 形式（協定世界時 UTC）で表示されます。

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

    string

    O&M タスクの変更時刻です。ISO 8601 標準に従い、yyyy-MM-ddThh:mm:ssZ 形式（協定世界時 UTC）で表示されます。

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

    string

    インスタンスの ID です。

    r-bp1lgal1sdvxrz****
    DbType

    string

    インスタンスのデータベースタイプです。戻り値は Redis です。

    redis
    Region

    string

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

    cn-hanghzou
    CreatedTime

    string

    O&M タスクの作成時刻です。ISO 8601 標準に従い、yyyy-MM-ddThh:mm:ssZ 形式（協定世界時 UTC）で表示されます。

    2023-02-24T06:00:11Z
    Id

    integer

    O&M タスクの ID です。

    1****1
    SwitchTime

    string

    システムがスイッチオーバー操作を実行する時刻です。ISO 8601 標準に従い、yyyy-MM-ddThh:mm:ssZ 形式（協定世界時 UTC）で表示されます。

    2023-03-20T03:10:00Z

    例

    成功レスポンス

    JSONJSON

    {
  "PageNumber": 1,
  "RequestId": "2E1FF0CC-F42A-4B6F-A1F4-A17B1451****",
  "PageSize": 30,
  "TotalRecordCount": 1,
  "Items": [
    {
      "Status": 5,
      "Deadline": "2023-03-29T13:59:59Z",
      "PrepareInterval": "14:00:00",
      "TaskType": "rds_apsaradb_upgrade",
      "StartTime": "2023-03-20T02:40:00Z",
      "ModifiedTime": "2023-02-24T08:18:53Z",
      "InsName": "r-bp1lgal1sdvxrz****",
      "DbType": "redis",
      "Region": "cn-hanghzou",
      "CreatedTime": "2023-02-24T06:00:11Z",
      "Id": 0,
      "SwitchTime": "2023-03-20T03:10:00Z"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

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

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

    変更履歴

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