Skip to main content
23.07
本製品の最新リリースがご利用いただけます。
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

タスクを取得する

PDF

GET /accounts/{account_id}/core/v1/tasks/{task_id}

JSONレスポンスボディに格納されたTask APIリソースを返します。

パラメータ

Name を入力します 入力 必須 説明

account_id

string

path（パス）

True

包含するアカウントリソースのID

  • 例：{{.Account}}

task_id

string

path（パス）

True

一覧表示するタスクコレクションのID

応答

Status: 200, Returns the stored Task API resource in the JSON response body.
Name を入力します 必須 説明

を入力します

string

True

リソースのメディアタイプ。定義された値は次のとおりです：

  • "application/astra-task"

バージョン

string

True

リソースのバージョン。定義された値は次のとおりです：

  • "1.0"

  • "1.1"

ID

string

True

リソースのグローバル一意識別子。定義された値は次のとおりです：

  • UUIDv4スキーマに準拠

名前

string

True

タスクの階層名を示すドット表記（.）を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：3

  • 最大長さ：127

  • 定義された正規表現は次のとおりです："^[a-z])(\.([a-z])+$"

まとめ

string

True

タスクの簡潔な概要を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：3

  • 最大長さ：63

description

string

True

タスクの説明を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：511

service

string

False

タスクを管理しているサービスの名前を含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：31

parentTaskID

string

False

タスクの親タスクのグローバルに一意な識別子を含むJSON文字列。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠

ユーザーID

string

False

タスクに関連付けられたユーザーIDを含むJSON文字列。ユーザーが開始する操作に関連するタスクにのみ含まれます。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠

resourceID

string

True

タスクに関連付けられたリソースのグローバルに一意な識別子を含むJSON文字列。定義された値は次のとおりです：

  • Astra識別子スキーマに準拠

resourceURI

string

True

タスクに関連付けられたURIを含むJSON文字列。定義された値は次のとおりです：

  • 最小長さ：3

  • 最大長さ：4095

resourceCollectionURI

array[string]

True

JSON文字列のJSON配列。各文字列は、タスクに関連付けられたリソースの完全な展開済みアクセスURLを示します。定義された値は次のとおりです：

  • 最小長さ：3

  • 最大長さ：4095

状態

string

True

タスクの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「notStarted」- タスクの実行が開始されていません。

  • 「running」 - タスクは実行中です。

  • 「completed」 - タスクが完了しました。

  • 「一時停止」 - タスクの一時停止が要求されました。

  • 「paused」 - タスクが一時停止されています。

  • 「cancelling」 - タスクのキャンセルが要求されました。

  • 「cancelled」 - タスクはキャンセルされました。

  • 「failed」 - タスクが失敗しました。

  • 最小長さ：1

  • 最大長さ：31

stateTransitions

配列["type_astra_stateTransition"]

True

JSONオブジェクトのJSON配列。各オブジェクトは、特定の定義済み状態からの許可された状態遷移のセットを表します。各JSONオブジェクトには「from」と「to」というフィールドが含まれており、「from」の値は状態の名前、「to」の値は許可された宛先状態の配列です。

  • 最小長さ：1

  • 最大長さ：31 例："stateTransitions" : [ { "from": "running", "to": ["paused", "cancelled"] }, { "from": "paused", "to": ["running", "cancelled"] }, ]

stateDetails

配列["type_astra_stateDetail"]

True

現在の「状態」に関する詳細情報を一覧表示するJSONオブジェクトのJSON配列。このフィールドは、実際の状態が望ましい状態と一致しない原因となる条件やエラーが存在する場合を示します。詳細情報が利用できない場合、この配列は空になります。

  • 最小アイテム数：0

orderHint

番号

False

サブタスクの順序を表すJSON形式の数値。このフィールドは、クライアントがサブタスクを小さい順から大きい順に並べ替えるために使用できます。

percentDone

番号

False

実行中のタスクの完了率を示すJSON形式の数値。タスクが完了すると、この値は「100」に設定されます。

startTime

string

False

タスクが開始された日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

endTime

string

False

タスクが終了した時刻を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

cancelTime

string

False

タスクがキャンセルされた日時を示すタイムスタンプを含むJSON文字列。定義された値は次のとおりです：

  • ISO-8601 Date Time Schemaに準拠

メタデータ

"type_astra_metadata"

True

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astraメタデータスキーマに準拠
回答例 
{
  "type": "application/astra-task",
  "version": "1.1",
  "id": "26e8e8ef-5549-5928-98dd-2c3d43a608e8",
  "name": "astra.backup.prep",
  "summary": "Backup preparation",
  "description": "Task to prepare for the application backup",
  "service": "nautilus",
  "userID": "abda967f-cd2c-4237-908e-99266648c553",
  "parentTaskID": "9cc8c321-6af1-406c-8158-2c6582c247f8",
  "resourceID": "626a0978-d55f-4841-8b7c-dc0c0f592c6f",
  "resourceURI": "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/k8s/v1/apps/7c8bef49-697e-4fb4-810c-675cef4cf6c9/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130",
  "resourceCollectionURI": [
    "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/f8b58091-4b9c-4c64-9b40-018dbaf7c5de/apps/f670bf11-8850-44bd-b330-815af6186a06/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130",
    "/accounts/fdaa655c-15ab-4d34-aa61-1e9098e67be0/topology/v1/clouds/0df3f1a0-7203-4c12-aabf-a7bee6302671/clusters/dfd9de2d-6f0b-437b-a737-c8f7f176cd14/namespaces/923708f8-0435-45b5-8c00-fbdef3ffaf25/apps/f670bf11-8850-44bd-b330-815af6186a06/appSnaps/2b6dafc3-2172-4431-a482-6306b2703130"
  ],
  "state": "running",
  "stateTransitions": [
    {
      "from": "running",
      "to": [
        "paused",
        "cancelled"
      ]
    },
    {
      "from": "paused",
      "to": [
        "running",
        "cancelled"
      ]
    }
  ],
  "stateDetails": [],
  "orderHint": 0,
  "percentDone": 20.25,
  "startTime": "2020-08-06T12:24:52.256624Z",
  "endTime": "2020-08-06T12:26:52.256624Z",
  "metadata": {
    "labels": [],
    "creationTimestamp": "2022-10-06T20:58:16.305662Z",
    "modificationTimestamp": "2022-10-06T20:58:16.305662Z",
    "createdBy": "8f84cf09-8036-51e4-b579-bd30cb07b269"
  }
}

応答

Status: 401, Unauthorized
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

応答

Status: 400, Bad request
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

invalidParams

配列["invalidParams"]

False

無効なクエリパラメータのリスト
回答例 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 403, Forbidden
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

エラー

Status: 404, Not found
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
エラー応答の例 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

用語の意味

定義を参照

type_astra_stateTransition

Name を入力します 必須 説明

-

string

True

-

array[string]

True

additionalDetails

type_astra_stateDetail

Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

additionalDetails

"additionalDetails"

False

type_astra_label

Name を入力します 必須 説明

名前

string

True

Value

string

True

type_astra_metadata

リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです：

  • Astraメタデータスキーマに準拠

Name を入力します 必須 説明

ラベル

配列["type_astra_label"]

True

作成タイムスタンプ

string

True

modificationTimestamp

string

True

作成者

string

True

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

無効なクエリパラメータの名前

理由

string

True

クエリパラメータが無効な理由