アプリのAppMirrorリソースを一覧表示します
GET /accounts/{account_id}/k8s/v1/apps/{app_id}/appMirrors
コレクション内の一致するすべてのリソースのJSON配列を返します。リクエストで個別のフィールドが指定されている場合、アイテムのJSON配列には、一致する各リソースに対して要求されたフィールドが、指定された順序で含まれます。
パラメータ
| Name | を入力します | 入力 | 必須 | 説明 |
|---|---|---|---|---|
account_id |
string |
path(パス) |
True |
包含するアカウントリソースのID
|
app_id |
string |
path(パス) |
True |
含まれるアプリリソースのID |
含める |
string |
query |
False |
コレクションを一覧表示する際に、どのフィールドを返すかを指定します。 URLの例:"include=id"、"include=id,name" OpenAPI の例:"id" |
制限( Limit ) |
string |
query |
False |
コレクションを一覧表示する際に返されるリソースの最大数を示します。 URLの例:"limit=2" OpenAPI の例:"2" |
フィルタ |
string |
query |
False |
コレクションを一覧表示する際に、リソースを返すためにどのフィールドを一致させる必要があるかを示します。 サポートされているオペレータは次のとおりです:
URLの例:"filter=field%20eq%20%27value%27" OpenAPI の例:「field eq 'value'」 |
応答
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 | を入力します | 必須 | 説明 |
|---|---|---|---|
項目 |
配列[いずれか:"appMirror_1.1_get_response_body"、配列[]] |
True |
|
メタデータ |
True |
回答例
{
"type": "application/astra-appMirrors",
"version": "1.1",
"items": [
{
"type": "application/astra-appMirror",
"version": "1.1",
"id": "f1c98c2e-6391-42d3-8b21-3e75dac048a3",
"sourceAppID": "efd639b6-fc92-4112-8841-0c0ab7890ae0",
"sourceClusterID": "5789e026-c2e2-41e9-ab00-9766bcfa8951",
"destinationAppID": "cd7b6d91-fc19-4983-a754-9a7bb4d80a7b",
"destinationClusterID": "c5d023a9-4061-4a8a-bfbf-3be11ff06226",
"namespaceMapping": [
{
"clusterID": "5789e026-c2e2-41e9-ab00-9766bcfa8951",
"namespaces": [
"ns1-src",
"ns2-src"
]
},
{
"clusterID": "c5d023a9-4061-4a8a-bfbf-3be11ff06226",
"namespaces": [
"ns1-dest",
"ns2-dest"
]
}
],
"state": "established",
"stateTransitions": [
{
"from": "establishing",
"to": [
"established",
"deleting"
]
},
{
"from": "established",
"to": [
"failingOver",
"deleting"
]
},
{
"from": "failingOver",
"to": [
"failedOver",
"deleting"
]
},
{
"from": "failedOver",
"to": [
"establishing",
"deleting"
]
},
{
"from": "deleting",
"to": [
"deleted"
]
}
],
"stateDesired": "established",
"stateAllowed": [
"failedOver",
"deleted"
],
"stateDetails": [
{
"type": "https://astra.netapp.io/stateDetails/1",
"title": "AppMirror relationship established",
"detail": "The AppMirror relationship has been successfully established."
}
],
"healthState": "normal",
"healthStateTransitions": [
{
"from": "indeterminate",
"to": [
"normal",
"warning",
"critical"
]
},
{
"from": "normal",
"to": [
"indeterminate",
"warning",
"critical"
]
},
{
"from": "warning",
"to": [
"indeterminate",
"normal",
"critical"
]
},
{
"from": "critical",
"to": [
"indeterminate",
"normal",
"warning"
]
}
],
"healthStateDetails": [
{
"type": "https://astra.netapp.io/stateDetails/2",
"title": "SnapMirror syncing successfully",
"detail": "All SnapMirror relationships are synchronizing as expected."
}
],
"metadata": {
"labels": [],
"creationTimestamp": "2020-08-06T12:24:52.256624Z",
"modificationTimestamp": "2020-08-06T12:24:52.256624Z",
"createdBy": "11c0cfa1-4f27-4ef7-a21c-cb452fc5c9aa"
}
},
{
"type": "application/astra-appMirror",
"version": "1.1",
"id": "114633f0-5b59-4bd7-adce-a9ba4423a1bd",
"sourceAppID": "eaf8b854-211d-460a-ac18-d093d8e2ac70",
"sourceClusterID": "fcb27b51-ebb7-40ca-b8f1-1d23ebd06889",
"destinationAppID": "e829c5e0-750f-44ad-a684-aee85be2c2bb",
"destinationClusterID": "fcb27b51-ebb7-40ca-b8f1-1d23ebd06889",
"namespaceMapping": [
{
"clusterID": "fcb27b51-ebb7-40ca-b8f1-1d23ebd06889",
"namespaces": [
"app-namespace"
],
"role": "source"
},
{
"clusterID": "fcb27b51-ebb7-40ca-b8f1-1d23ebd06889",
"namespaces": [
"destination-app-namespace"
],
"role": "destination"
}
],
"storageClasses": [
{
"storageClassName": "destination-sc",
"clusterID": "fcb27b51-ebb7-40ca-b8f1-1d23ebd06889",
"role": "destination"
}
],
"state": "established",
"stateTransitions": [
{
"from": "establishing",
"to": [
"established",
"deleting"
]
},
{
"from": "established",
"to": [
"failingOver",
"deleting"
]
},
{
"from": "failingOver",
"to": [
"failedOver",
"deleting"
]
},
{
"from": "failedOver",
"to": [
"establishing",
"deleting"
]
}
],
"stateDesired": "established",
"stateAllowed": [
"failedOver",
"deleted"
],
"stateDetails": [],
"transferState": "idle",
"transferStateTransitions": [
{
"from": "transferring",
"to": [
"idle"
]
},
{
"from": "idle",
"to": [
"transferring"
]
}
],
"transferStateDetails": [
{
"type": "https://astra.netapp.io/stateDetails/24",
"title": "Snapshot replication completed",
"detail": "A snapshot was replicated to the destination.",
"additionalDetails": {
"completionTime": "2023-07-06T22:46:39Z",
"snapshotID": "ae60820d-e963-4eab-8bb3-9159e9f012f0",
"startTime": "2023-07-06T22:46:08Z"
}
}
],
"healthState": "normal",
"healthStateTransitions": [],
"healthStateDetails": [
{
"type": "https://astra.netapp.io/stateDetails/24",
"title": "Snapshot replication completed",
"detail": "A snapshot was replicated to the destination.",
"additionalDetails": {
"completionTime": "2023-07-06T22:46:39Z",
"snapshotID": "ae60820d-e963-4eab-8bb3-9159e9f012f0",
"startTime": "2023-07-06T22:46:08Z"
}
}
],
"metadata": {
"labels": [],
"creationTimestamp": "2023-07-06T22:45:24Z",
"modificationTimestamp": "2023-07-06T22:45:24Z",
"createdBy": "cc420827-f968-4da7-9e72-df8a0fd52f94"
}
}
],
"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/2",
"title": "Collection not found",
"detail": "The collection specified in the request URI wasn't found.",
"status": "404"
}
用語の意味
定義を参照
namespaceMapping
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
clusterID |
string |
False |
名前空間が指定されているクラスタの識別子。定義された値は次のとおりです:
|
ネームスペース |
array[string] |
False |
クラスタで使用するネームスペースのリスト。インデックスによって他のクラスタのネームスペースリストと関連付けられます。定義された値は次のとおりです:
|
ロール |
string |
False |
この名前空間定義の初期の役割。このパラメータは、同一クラスタレプリケーション構成を使用する場合を除き、オプションです。定義された値は次のとおりです:
|
storageClasses
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
clusterID |
string |
False |
ストレージクラスが指定されているクラスタの識別子。定義された値は次のとおりです:
|
storageClassName |
string |
False |
「clusterID」で指定されたクラスタ上でPVCを作成する際に使用するストレージクラスの名前。定義された値は次のとおりです:
|
ロール |
string |
False |
このストレージクラス定義の初期ロール。このパラメータは、同一クラスタレプリケーション構成を使用する場合を除き、オプションです。定義された値は次のとおりです:
|
type_astra_stateTransition
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
- |
string |
True |
|
- |
array[string] |
True |
additionalDetails
type_astra_stateDetail
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
|
タイトル |
string |
True |
|
詳細 |
string |
True |
|
additionalDetails |
False |
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 |
appMirror_1.1_get_response_body
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
を入力します |
string |
True |
リソースのメディアタイプ。定義された値は次のとおりです:
|
バージョン |
string |
True |
リソースのバージョン。定義された値は次のとおりです:
|
ID |
string |
True |
リソースのグローバル一意識別子。定義された値は次のとおりです:
|
sourceAppID |
string |
True |
ソースアプリケーションの識別子。sourceAppIDとdestinationAppIDを入れ替えた場合にのみ更新されます。定義された値は次のとおりです:
|
sourceClusterID |
string |
True |
ソースアプリケーションをホストしている管理対象クラスタの識別子。このフィールドは読み取り専用であり、ソースアプリケーションのホストクラスタに基づいて決定されます。アップデートで提供される場合、ソースアプリケーションのクラスタIDと一致する必要があるため、sourceAppIDとdestinationAppIDを入れ替える場合にのみ変更できます。定義された値は次のとおりです:
|
destinationAppID |
string |
False |
デスティネーション アプリケーションの識別子。作成時に指定することはできません。なぜなら、関係の初期化の一環として新しいアプリIDが生成されるからです。sourceAppIDとdestinationAppIDを入れ替えた場合にのみ更新可能です。定義された値は次のとおりです:
|
デスティネーション クラスタ ID |
string |
True |
デスティネーション アプリケーションをホストする管理対象クラスタの識別子。作成時に必ず指定する必要があります。これは、デスティネーション アプリケーションが作成されるクラスタを決定するためです。更新時に指定される場合、デスティネーション アプリケーションのクラスタ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 |
True |
関係の状態。定義された値は次のとおりです:
|
stateTransitions |
False |
許可された状態遷移。このリソースでは、以下の状態遷移が可能です:
|
|
stateDesired |
string |
True |
関係の望ましい状態。作成時に有効な値は「established」のみです。定義された値は次のとおりです:
|
stateAllowed |
array[string] |
False |
特定の状態で要求できる状態。各定義済み状態において、以下の状態を要求することができます:
|
stateDetails |
True |
現在の状態に関する追加の詳細情報(現在の状態に至った理由を含む)。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです:
|
|
transferState |
string |
False |
現在または直近のスナップショット転送の状態。定義された値は次のとおりです:
|
transferStateTransitions |
False |
特定の定義済み状態からの許可された状態遷移。このリソースでは、以下の状態遷移が可能です:
|
|
transferStateDetails |
False |
現在の状態に関する追加の詳細情報(現在の状態に至った理由を含む)。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです:
|
|
healthState |
string |
True |
リソースの健全性状態。定義された値は次のとおりです:
|
healthStateTransitions |
True |
特定の定義済み状態からの許可された状態遷移。このリソースでは、以下の状態遷移が可能です:
|
|
healthStateDetails |
True |
現在の状態に関する追加の詳細情報(現在の状態に至った理由を含む)。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです:
|
|
メタデータ |
True |
リソースに関連付けられた、クライアントおよびサービス指定のメタデータ。定義された値は次のとおりです:
|
type_astra_metadata_list
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
続行 |
string |
False |
|
カウント |
番号 |
False |
|
ラベル |
False |
||
作成タイムスタンプ |
string |
False |
|
modificationTimestamp |
string |
False |
|
作成者 |
string |
False |
|
modifiedBy |
string |
False |
invalidParams
| Name | を入力します | 必須 | 説明 |
|---|---|---|---|
名前 |
string |
True |
無効なクエリパラメータの名前 |
理由 |
string |
True |
クエリパラメータが無効な理由 |