AppMirrorリソースを変更する
PUT /accounts/{account_id}/k8s/v1/appMirrors/{appMirror_id}
保存されているリソース全体を、指定されたJSONリクエストボディに置き換えますが、ユーザーが変更できないキー値は保持します。
副作用
-
desiredStateに基づくさまざまな副作用。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
appMirror_id |
string |
path(パス) |
True |
リストするappMirrorコレクションのID |
要求の本文
保存されているリソース全体を、指定されたJSONリクエストボディに置き換えますが、ユーザーが変更できないキー値は保持します。
副作用
-
desiredStateに基づくさまざまな副作用。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
False |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
sourceAppID |
string |
False |
ソースアプリケーションの識別子。sourceAppIDとdestinationAppIDを入れ替えた場合にのみ更新されます。定義された値は次のとおりです:
|
sourceClusterID |
string |
False |
ソースアプリケーションをホストしている管理対象クラスタの識別子。このフィールドは読み取り専用であり、ソースアプリケーションのホストクラスタに基づいて決定されます。アップデートで提供される場合、ソースアプリケーションのクラスタIDと一致する必要があるため、sourceAppIDとdestinationAppIDを入れ替える場合にのみ変更できます。定義された値は次のとおりです:
|
destinationAppID |
string |
False |
デスティネーション アプリケーションの識別子。作成時に指定することはできません。なぜなら、関係の初期化の一環として新しいアプリIDが生成されるからです。sourceAppIDとdestinationAppIDを入れ替えた場合にのみ更新可能です。定義された値は次のとおりです:
|
デスティネーション クラスタ ID |
string |
False |
デスティネーション アプリケーションをホストする管理対象クラスタの識別子。作成時に必ず指定する必要があります。これは、デスティネーション アプリケーションが作成されるクラスタを決定するためです。更新時に指定される場合、デスティネーション アプリケーションのクラスタIDと一致する必要があるため、sourceAppIDとdestinationAppIDを入れ替える場合にのみ変更できます。定義された値は次のとおりです:
|
namespaceMapping |
False |
宛先アプリケーションを作成する際に使用する名前空間(または複数の名前空間)。これは、ソースアプリケーションの名前空間に対応します。各 JSON オブジェクトには「clusterID」と「namespaces」というフィールドが含まれており、「clusterID」の値はソースまたはデスティネーション クラスタの JSON 文字列 ID で、「namespaces」の値は JSON 文字列の JSON 配列です。各クラスタには必ず 1 つの JSON オブジェクトが存在し、名前空間はインデックスによって関連付けられます。指定しない場合は、ソース クラスタの同じ名前空間がデスティネーション クラスタで使用されます。定義された値は次のとおりです:
|
|
storageClasses |
配列["storageClasses"] |
False |
新しい永続ボリューム要求(PVC)を作成するときにデスティネーション クラスタで使用されるストレージクラス。各JSONオブジェクトには「clusterID」と「storageClassName」のフィールドが含まれており、「clusterID」の値はソースまたはデスティネーション クラスタのJSON文字列IDで、「storageClassName」はそのクラスタでPVCを作成する際に使用するストレージクラスです。指定されていない場合、またはクラスタに対して値が欠落している場合は、そのクラスタにはデフォルトのストレージクラスが使用されます。定義された値は次のとおりです:
|
状態 |
string |
False |
関係の状態。定義された値は次のとおりです:
|
stateTransitions |
False |
許可された状態遷移。このリソースでは、以下の状態遷移が可能です:
|
|
stateDesired |
string |
False |
関係の望ましい状態。作成時に有効な値は「established」のみです。定義された値は次のとおりです:
|
stateAllowed |
array[string] |
False |
特定の状態で要求できる状態。各定義済み状態において、以下の状態を要求することができます:
|
stateDetails |
False |
現在の状態に関する追加の詳細情報(現在の状態に至った理由を含む)。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです:
|
|
transferState |
string |
False |
現在または直近のスナップショット転送の状態。定義された値は次のとおりです:
|
transferStateTransitions |
False |
特定の定義済み状態からの許可された状態遷移。このリソースでは、以下の状態遷移が可能です:
|
|
transferStateDetails |
False |
現在の状態に関する追加の詳細情報(現在の状態に至った理由を含む)。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです:
|
|
healthState |
string |
False |
リソースの健全性状態。定義された値は次のとおりです:
|
healthStateTransitions |
False |
特定の定義済み状態からの許可された状態遷移。このリソースでは、以下の状態遷移が可能です:
|
|
healthStateDetails |
False |
現在の状態に関する追加の詳細情報(現在の状態に至った理由を含む)。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです:
|
|
メタデータ |
False |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
リクエスト例
{
"type": "application/astra-appMirror",
"version": "1.0",
"stateDesired": "failedOver"
}
応答
Status: 204, Indicates if the appMirror resource was updated.
応答
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 |
|
invalidFields |
配列["invalidFields"] |
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 |
|
invalidFields |
配列["invalidFields"] |
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 |
回答例
{
"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"
}
用語の意味
定義を参照
namespaceMapping
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
clusterID |
string |
False |
名前空間が指定されているクラスタの識別子。定義された値は次のとおりです:
|
ネームスペース |
array[string] |
False |
クラスタで使用するネームスペースのリスト。インデックスによって他のクラスタのネームスペースリストと関連付けられます。定義された値は次のとおりです:
|
storageClasses
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
clusterID |
string |
False |
ストレージクラスが指定されているクラスタの識別子。定義された値は次のとおりです:
|
storageClassName |
string |
False |
「clusterID」で指定されたクラスタ上でPVCを作成する際に使用するストレージクラスの名前。定義された値は次のとおりです:
|
type_astra_stateTransition
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
- |
string |
True |
|
- |
array[string] |
True |
type_astra_stateDetail
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
type_astra_label
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
|
Value |
string |
True |
type_astra_metadata_update
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
-
Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |
invalidFields
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なリクエストボディフィールドの名前 |
理由 |
string |
True |
リクエスト本文フィールドが無効な理由 |