アプリの新しいアプリケーションスナップショットを作成する

パラメータ

Name	を入力します	入力	必須	説明
account_id	string	path（パス）	True	包含するアカウントリソースのID 例：{{.Account}}
app_id	string	path（パス）	True	含まれるアプリリソースのID

Name

を入力します

入力

必須

説明

account_id

string

path（パス）

True

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

例：{{.Account}}

app_id

string

path（パス）

True

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

要求の本文

作成するアプリケーションスナップショット API リソースの目的の値を示します。

Name	を入力します	必須	説明
を入力します	string	True	リソースのメディアタイプ。定義された値は次のとおりです： "application/astra-appSnap"
バージョン	string	True	リソースのバージョン。定義された値は次のとおりです： "1.0" "1.1" "1.2" "1.3"
名前	string	False	スナップショットにユーザーが指定した名前を含むJSON文字列。指定がない場合、またはスケジュールによってスナップショットが開始された場合、システムはスナップショットに名前を割り当てます。定義された値は次のとおりです：最小長さ：1 最大長さ：63 DNS 1123 Label Schemaに準拠
bucketID	string	False	スナップショットが作成時に保存される場所を示す、オプションのバケットIDを含むJSON文字列。指定がない場合、クラスター上のデフォルトのバケットが使用されます。クラスター上でデフォルトバケットが指定されていない場合、対応するクラウドのデフォルトバケットが使用されます。クラウドのデフォルトバケットが利用できない場合、作成時にエラーが返されます。定義された値は次のとおりです： Astra識別子スキーマに準拠
メタデータ	"type_astra_metadata"	False	リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです： Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。

Name

を入力します

必須

説明

を入力します

string

True

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

"application/astra-appSnap"

バージョン

string

True

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

"1.0"
"1.1"
"1.2"
"1.3"

名前

string

False

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

最小長さ：1
最大長さ：63
DNS 1123 Label Schemaに準拠

bucketID

string

False

スナップショットが作成時に保存される場所を示す、オプションのバケットIDを含むJSON文字列。指定がない場合、クラスター上のデフォルトのバケットが使用されます。クラスター上でデフォルトバケットが指定されていない場合、対応するクラウドのデフォルトバケットが使用されます。クラウドのデフォルトバケットが利用できない場合、作成時にエラーが返されます。定義された値は次のとおりです：

Astra識別子スキーマに準拠

メタデータ

"type_astra_metadata"

False

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

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

リクエスト例

{
  "type": "application/astra-appSnap",
  "version": "1.3",
  "name": "app-name-245"
}

応答

Status: 201, Returns the newly created appSnap resource in the JSON response body.

Name	を入力します	必須	説明
を入力します	string	True	リソースのメディアタイプ。定義された値は次のとおりです： "application/astra-appSnap"
バージョン	string	True	リソースのバージョン。定義された値は次のとおりです： "1.0" "1.1" "1.2" "1.3"
ID	string	True	リソースのグローバル一意識別子。定義された値は次のとおりです： UUIDv4スキーマに準拠
名前	string	True	スナップショットにユーザーが指定した名前を含むJSON文字列。指定がない場合、またはスケジュールによってスナップショットが開始された場合、システムはスナップショットに名前を割り当てます。定義された値は次のとおりです：最小長さ：1 最大長さ：63 DNS 1123 Label Schemaに準拠
bucketID	string	False	スナップショットが作成時に保存される場所を示す、オプションのバケットIDを含むJSON文字列。指定がない場合、クラスター上のデフォルトのバケットが使用されます。クラスター上でデフォルトバケットが指定されていない場合、対応するクラウドのデフォルトバケットが使用されます。クラウドのデフォルトバケットが利用できない場合、作成時にエラーが返されます。定義された値は次のとおりです： Astra識別子スキーマに準拠
scheduleID	string	False	スナップショットがスケジュールによってトリガーされたことを示すオプションのスケジュールIDと、スナップショットをトリガーしたスケジュールを指定するJSON文字列。スケジュールによって開始されたスナップショットの場合にのみ存在します。定義された値は次のとおりです： Astra識別子スキーマに準拠
snapshotAppAsset	string	False	スナップショットに対応するアプリケーションアセットのIDを含むJSON文字列。このフィールドは、アプリケーションのスナップショットの状態が「completed」になったときに返されます。定義された値は次のとおりです： Astra識別子スキーマに準拠
状態	string	True	スナップショットの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです：「pending」 - アプリケーションのスナップショットは検出のためにスケジュールされています「discovering」 - アプリケーションのスナップショットが検出中です「実行中」-アプリケーションのスナップショットは正常に実行されています「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
メタデータ	"type_astra_metadata"	True	リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです： Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。

Name

を入力します

必須

説明

を入力します

string

True

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

"application/astra-appSnap"

バージョン

string

True

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

"1.0"
"1.1"
"1.2"
"1.3"

ID

string

True

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

UUIDv4スキーマに準拠

名前

string

True

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

最小長さ：1
最大長さ：63
DNS 1123 Label Schemaに準拠

bucketID

string

False

スナップショットが作成時に保存される場所を示す、オプションのバケットIDを含むJSON文字列。指定がない場合、クラスター上のデフォルトのバケットが使用されます。クラスター上でデフォルトバケットが指定されていない場合、対応するクラウドのデフォルトバケットが使用されます。クラウドのデフォルトバケットが利用できない場合、作成時にエラーが返されます。定義された値は次のとおりです：

Astra識別子スキーマに準拠

scheduleID

string

False

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

Astra識別子スキーマに準拠

snapshotAppAsset

string

False

スナップショットに対応するアプリケーションアセットのIDを含むJSON文字列。このフィールドは、アプリケーションのスナップショットの状態が「completed」になったときに返されます。定義された値は次のとおりです：

Astra識別子スキーマに準拠

状態

string

True

スナップショットの動作状態を示す値を含むJSON文字列。定義された値は次のとおりです：

「pending」 - アプリケーションのスナップショットは検出のためにスケジュールされています
「discovering」 - アプリケーションのスナップショットが検出中です
「実行中」-アプリケーションのスナップショットは正常に実行されています
「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

メタデータ

"type_astra_metadata"

True

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

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

回答例

{
  "type": "application/astra-appSnap",
  "version": "1.3",
  "id": "c2cc5c22-ed0e-5c2b-8b7e-0fb81727f617",
  "name": "app-name-245",
  "bucketID": "0afbe357-a717-4c7a-8b3d-d0368959c8de",
  "scheduleID": "1fe83650-9b3c-41ef-bb25-a2910c19c33e",
  "state": "pending",
  "stateUnready": [],
  "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

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

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例

{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

応答

Status: 409, Conflict

Name	を入力します	必須
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

ステータス

string

True

correlationID

string

False

回答例

{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

応答

Status: 403, Forbidden

Name	を入力します	必須
を入力します	string	True
タイトル	string	True
詳細	string	True
ステータス	string	True
correlationID	string	False

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

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"
}

用語の意味

定義を参照

type_astra_label

Name	を入力します	必須	説明
名前	string	True
Value	string	True

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

Name

を入力します

必須

説明

ラベル

配列["type_astra_label"]

True

作成タイムスタンプ

string

True

modificationTimestamp

string

True

作成者

string

True

modifiedBy

string

False

additionalDetails

type_astra_stateDetail

Name	を入力します	必須
を入力します	string	True
タイトル	string	True
詳細	string	True
additionalDetails	"additionalDetails"	False

Name

を入力します

必須

説明

を入力します

string

True

タイトル

string

True

詳細

string

True

additionalDetails

"additionalDetails"

False

invalidParams

Name	を入力します	必須	説明
名前	string	True	無効なクエリパラメータの名前
理由	string	True	クエリパラメータが無効な理由

Name

を入力します

必須

説明

名前

string

True

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

理由

string

True

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

invalidFields

Name	を入力します	必須	説明
名前	string	True	無効なリクエストボディフィールドの名前
理由	string	True	リクエスト本文フィールドが無効な理由

Name

を入力します

必須

説明

名前

string

True

無効なリクエストボディフィールドの名前

理由

string

True

リクエスト本文フィールドが無効な理由

アプリの新しいアプリケーションスナップショットを作成する

Creating your file...

パラメータ

要求の本文

応答

応答

応答

応答

応答

エラー

用語の意味