すべてのプロダクト
Search

このプロダクト

    Container Service for Kubernetes:DescribeTaskInfo

    ドキュメントセンター

    Container Service for Kubernetes:DescribeTaskInfo

    最終更新日:May 12, 2026

    DescribeTaskInfo API を呼び出して、クラスタータスクの詳細 (タイプ、ステータス、現在のフェーズなど) をクエリします。

    今すぐお試しください

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

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    cs:DescribeTaskInfo

    get

    *All Resource

    *

    		 なし なし

    リクエスト構文

    GET /tasks/{task_id} HTTP/1.1

    パスパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    task_id

    string

    必須

    タスクの ID。

    T-5faa48fb31b6b8078d00****

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例

    リクエストパラメーターは必要ありません。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    レスポンスボディです。

    task_id

    string

    タスク ID です。

    T-5faa48fb31b6b8078d000006
    cluster_id

    string

    クラスター ID です。

    c78592bfe92244365b3c3ad47f1de****
    task_type

    string

    タスクタイプです。値が cluster_scaleout の場合は、スケールアウトタスクを示します。

    cluster_scaleout
    state

    string

    タスクのステータスです。有効値：

    • running ：実行中。

    • fail ：失敗。

    • success ：成功。

    running
    created

    string

    タスクが作成された時刻です。

    2020-11-10T16:02:04+08:00
    updated

    string

    タスクが最後に更新された時刻です。

    2020-11-10T16:03:06+08:00
    target

    object

    タスクの対象オブジェクトです。

    id

    string

    タスクの対象オブジェクトの ID です。

    c78592bfe92244365b3c3ad47f1de****

    type

    string

    タスクの対象オブジェクトのタイプです。

    cluster
    parameters

    object

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

    stages

    array<object>

    タスクステージです。

    array<object>

    タスクステージの詳細です。

    state

    string

    タスクステージのステータスです。

    running
    start_time

    string

    タスクステージの開始時刻です。

    2022-12-15 23:00:00
    end_time

    string

    タスクステージの終了時刻です。

    2022-12-15 23:00:00
    message

    string

    タスクステージのメッセージです。

    success to xxxxx
    outputs

    object

    タスクステージの出力です。

    current_stage

    string

    現在のタスクステージです。

    DrainNodes
    events

    array<object>

    タスクによって生成されたイベントです。

    object

    イベントの詳細です。

    action

    string

    イベントアクションです。

    start
    level

    string

    イベントレベルです。

    Normal
    message

    string

    イベントメッセージです。

    start to xxx
    reason

    string

    イベントの理由です。

    NodePoolUpgradeStart
    source

    string

    イベントソースです。

    ACK
    timestamp

    string

    イベントが生成された時刻です。

    1669706229286
    task_result

    array<object>

    タスクの実行結果です。

    object

    単一リソースの実行結果です。

    data

    string

    タスクが操作するリソースです。たとえば、インスタンスを操作するスケールアウトタスクの場合、このフィールドはインスタンス ID を返します。

    i-xxx
    status

    string

    リソースの処理ステータスです。有効値：

    • success ：成功。

    • failed ：失敗。

    • initial ：初期。

    success
    error

    object

    発生したエラーに関する詳細です。このパラメーターは、タスクが失敗した場合にのみ返されます。

    code

    string

    エラーコードです。

    400
    message

    string

    エラーメッセージです。

    failed to xxx
    outputs

    object

    例

    成功レスポンス

    JSONJSON

    {
  "task_id": "T-5faa48fb31b6b8078d000006",
  "cluster_id": "c78592bfe92244365b3c3ad47f1de****",
  "task_type": "cluster_scaleout",
  "state": "running",
  "created": "2020-11-10T16:02:04+08:00",
  "updated": "2020-11-10T16:03:06+08:00",
  "target": {
    "id": "c78592bfe92244365b3c3ad47f1de****\n",
    "type": "cluster"
  },
  "parameters": {
    "test": "test",
    "test2": 1
  },
  "stages": [
    {
      "state": "running",
      "start_time": "2022-12-15 23:00:00",
      "end_time": "2022-12-15 23:00:00",
      "message": "success to xxxxx",
      "outputs": {
        "test": "test",
        "test2": 1
      }
    }
  ],
  "current_stage": "DrainNodes",
  "events": [
    {
      "action": "start",
      "level": "Normal",
      "message": "start to xxx",
      "reason": "NodePoolUpgradeStart",
      "source": "ACK",
      "timestamp": "1669706229286"
    }
  ],
  "task_result": [
    {
      "data": "i-xxx",
      "status": "success"
    }
  ],
  "error": {
    "code": "400",
    "message": "failed to xxx"
  },
  "outputs": {
    "test": "test",
    "test2": 1
  }
}

    エラーコード

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

    変更履歴

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