Skip to main content
24.02
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

アプリのアプリケーションバックアップを一覧表示する

PDF

GET /accounts/{account_id}/k8s/v1/apps/{app_id}/appBackups

コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。

パラメータ

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

account_id

string

path（パス）

True

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

  • 例：{{.Account}}

app_id

string

path（パス）

True

含まれるアプリリソースのID

含める

string

query

False

コレクションを一覧表示する際に、どのフィールドを返すかを指定します。

URLの例："include=id"、"include=id,name"

OpenAPI の例："id"

  • 例：id、name、state

制限（ Limit ）

string

query

False

コレクションを一覧表示する際に返されるリソースの最大数を示します。

URLの例："limit=2"

OpenAPI の例："2"

応答

Status: 200, Returns a JSON array of all matching resources in the collection. If individual fields are specified in the request, the items JSON array will contain the fields requested for each matching resource in the order specified.
Name を入力します 必須 説明

項目

配列[いずれか："appBackup_1.2_get_response_body"、配列[]]

True

メタデータ

"type_astra_metadata_list"

True
回答例 
{
  "type": "application/astra-appBackups",
  "version": "1.2",
  "items": [
    [
      "5cb608f9-571b-492e-a520-5bfb900a9b9c",
      "app-name-245",
      "pending"
    ],
    [
      "f8faa690-7e09-48a4-b33c-7965712acd0c",
      "app-name-244",
      "completed"
    ]
  ],
  "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: 500, Internal server error
Name を入力します 必須 説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False
回答例 
{
  "type": "https://astra.netapp.io/problems/96",
  "title": "Backups not listed",
  "detail": "The backups didn't list because of an internal server issue.",
  "status": "500"
}

エラー

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

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

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

用語の意味

定義を参照

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

appBackup_1.2_get_response_body

Name を入力します 必須 説明

を入力します

string

True

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

  • "application/astra-appBackup"

バージョン

string

True

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

  • "1.0"

  • "1.1"

  • "1.2"

ID

string

True

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

  • UUIDv4スキーマに準拠

名前

string

True

バックアップのユーザー指定名を含むJSON文字列。指定がない場合、またはバックアップがスケジュールによって開始された場合、システムはバックアップに名前を割り当てます。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • DNS 1123 Label Schemaに準拠

bucketID

string

True

バックアップの作成時に保存される場所を示すオプションのバケットIDを含むJSON文字列。指定がない場合は、システムが選択したバケットが使用されます。バケットが利用できない場合は、作成時にエラーが返されます。定義された値は次のとおりです：

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

snapshotID

string

False

バックアップの作成に使用されたスナップショットを含むJSON文字列。バックアップを作成するには、バックアップ対象アプリケーションに関連付けられたスナップショットIDを、作成時に指定できます。指定がない場合、バックアップ用に新しいスナップショットが作成されます。定義値は次のとおりです：

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

scheduleID

string

False

バックアップがスケジュールによってトリガーされたこと、およびどのスケジュールがバックアップをトリガーしたかを示す、オプションのスケジュールIDを含むJSON文字列。スケジュールに基づいて開始されるバックアップの場合にのみ存在します。定義値は次のとおりです：

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

状態

string

True

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

  • 「pending」 - アプリケーションのバックアップは検出のためにスケジュールされています

  • 「discovering」 - アプリケーションのバックアップが検出中です

  • 「running」 - アプリケーションのバックアップは正常に実行されています

  • 「completed」 - アプリケーションのバックアップが正常に完了しました

  • 「failed」 - アプリケーションのバックアップが永続的な失敗状態になっています

  • 「削除済み」 - アプリケーションのバックアップには現在アクセスできません

  • 「不明」 - アプリケーションのバックアップ状態を判断できません

  • 「削除中」 - アプリケーションのバックアップは削除予定です

stateUnready

array[string]

True

JSON文字列のJSON配列。各文字列は、アプリケーションのバックアップが「実行中」に移行できない理由、または「失敗」もしくは「削除済み」に移行した理由を示します。定義値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：127

stateDetails

配列["type_astra_stateDetail"]

False

現在の状態に関する詳細情報（現在の状態に至った理由を含む）をリストしたJSONオブジェクトのJSON配列。詳細情報がない場合は、この配列は空になります。定義された値は次のとおりです：

  • 最小アイテム数：0

hookState

string

False

スナップショットの一部として実行される実行フックの状態を示す値を含むJSON文字列。定義された値は次のとおりです：

  • 「failed」 - 1つ以上の実行フックが失敗しました

  • 「success」 - 適用可能なフックがゼロ個以上あり、すべて成功しました

hookStateDetails

配列["type_astra_stateDetail"]

False

「hookState」が「failed」に移行した理由に関する追加の詳細をリストするJSONオブジェクトのJSON配列。詳細情報がない場合は、この配列は空になります。

  • 最小アイテム数：0

backupCreationTimestamp

string

False

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

  • ISO-8601 Date Time Schemaに準拠

totalBytes

番号

False

バックアップに含まれる合計バイト数を表すJSON形式の数値。

bytesDone

番号

False

実行中のバックアップでバックアップされたバイト数を含むJSON形式の数値。バックアップが完了すると、totalBytesフィールドと一致します。

percentDone

番号

False

実行中のバックアップの完了率を示すJSON形式の数値。バックアップが完了すると、「100」に設定されます。

メタデータ

"type_astra_metadata"

True

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

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。

type_astra_metadata_list

Name を入力します 必須 説明

続行

string

False

カウント

番号

False

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

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

理由

string

True

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