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

AppMirrorリソースを取得する

PDF

GET /accounts/{account_id}/k8s/v1/appMirrors/{appMirror_id}

JSON レスポンスボディに保存されている AppMirror API リソースを返します。

パラメータ

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

account_id

string

path（パス）

True

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

  • 例：{{.Account}}

appMirror_id

string

path（パス）

True

リストするappMirrorコレクションのID

応答

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

を入力します

string

True

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

  • 「application/astra-appMirror」

バージョン

string

True

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

  • "1.0"

ID

string

True

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

  • UUIDv4スキーマに準拠

sourceAppID

string

True

ソースアプリケーションの識別子。sourceAppIDとdestinationAppIDを入れ替えた場合にのみ更新されます。定義された値は次のとおりです：

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

sourceClusterID

string

True

ソースアプリケーションをホストしている管理対象クラスタの識別子。このフィールドは読み取り専用であり、ソースアプリケーションのホストクラスタに基づいて決定されます。アップデートで提供される場合、ソースアプリケーションのクラスタIDと一致する必要があるため、sourceAppIDとdestinationAppIDを入れ替える場合にのみ変更できます。定義された値は次のとおりです：

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

destinationAppID

string

False

デスティネーション アプリケーションの識別子。作成時に指定することはできません。なぜなら、関係の初期化の一環として新しいアプリIDが生成されるからです。sourceAppIDとdestinationAppIDを入れ替えた場合にのみ更新可能です。定義された値は次のとおりです：

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

デスティネーション クラスタ ID

string

True

デスティネーション アプリケーションをホストする管理対象クラスタの識別子。作成時に必ず指定する必要があります。これは、デスティネーション アプリケーションが作成されるクラスタを決定するためです。更新時に指定される場合、デスティネーション アプリケーションのクラスタIDと一致する必要があるため、sourceAppIDとdestinationAppIDを入れ替える場合にのみ変更できます。定義された値は次のとおりです：

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

namespaceMapping

配列["namespaceMapping"]

False

宛先アプリケーションを作成する際に使用する名前空間（または複数の名前空間）。これは、ソースアプリケーションの名前空間に対応します。各 JSON オブジェクトには「clusterID」と「namespaces」というフィールドが含まれており、「clusterID」の値はソースまたはデスティネーション クラスタの JSON 文字列 ID で、「namespaces」の値は JSON 文字列の JSON 配列です。各クラスタには必ず 1 つの JSON オブジェクトが存在し、名前空間はインデックスによって関連付けられます。指定しない場合は、ソース クラスタの同じ名前空間がデスティネーション クラスタで使用されます。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：2

storageClasses

配列["storageClasses"]

False

新しい永続ボリューム要求（PVC）を作成するときにデスティネーション クラスタで使用されるストレージクラス。各JSONオブジェクトには「clusterID」と「storageClassName」のフィールドが含まれており、「clusterID」の値はソースまたはデスティネーション クラスタのJSON文字列IDで、「storageClassName」はそのクラスタでPVCを作成する際に使用するストレージクラスです。指定されていない場合、またはクラスタに対して値が欠落している場合は、そのクラスタにはデフォルトのストレージクラスが使用されます。定義された値は次のとおりです：

  • 最小長さ：0

  • 最大長さ：2

状態

string

True

関係の状態。定義された値は次のとおりです：

  • 「establishing」 - 関係が構築されつつある。

  • 「established」 - 関係が作成されます。

  • 「failingOver」- アプリケーションのデスティネーション クラスタへのフェイルオーバーが進行中です。

  • 「failedOver」- アプリケーションのデスティネーション クラスタへのフェイルオーバーが完了しました。

  • 「削除中」 - 関係によって作成されたリソースがクリーンアップされています。

  • 「削除済み」 - 関係が整理され、削除されました。

stateTransitions

配列["type_astra_stateTransition"]

False

許可された状態遷移。このリソースでは、以下の状態遷移が可能です：

  • 「establishing」：「established」、「deleting」

  • "established"："failingOver"、"deleting"

  • "failingOver"："failedOver"、"deleting"

  • "failedOver"："establishing"、"deleting"

  • "deleting"："deleted"

  • 「削除済み」：

stateDesired

string

True

関係の望ましい状態。作成時に有効な値は「established」のみです。定義された値は次のとおりです：

  • 「established」 - 関係が作成されます。

  • 「failedOver」- アプリケーションのデスティネーション クラスタへのフェイルオーバーが完了しました。

  • 「削除済み」 - 関係性は正常にクリーンアップされ、削除されました。

stateAllowed

array[string]

False

特定の状態で要求できる状態。各定義済み状態において、以下の状態を要求することができます：

  • 「establishing」：「established」、「deleted」

  • "established"："failedOver"、"deleted"

  • "failingOver"："failedOver"、"deleted"

  • "failedOver": "established"、"deleted"

  • "deleting"："deleted"

  • "deleted"："削除済み"

stateDetails

配列["type_astra_stateDetail"]

True

現在の状態に関する追加の詳細情報（現在の状態に至った理由を含む）。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです：

  • 最小アイテム数：0

transferState

string

False

現在または直近のスナップショット転送の状態。定義された値は次のとおりです：

  • 「転送中」 - 新しいスナップショットが作成され、現在デスティネーション クラスタにレプリケートされています。この状態には、以前の試行で失敗し、継続的に再試行されている転送も含まれます。

  • 「idle」 - 現在、転送処理は行われていません。

transferStateTransitions

配列["type_astra_stateTransition"]

False

特定の定義済み状態からの許可された状態遷移。このリソースでは、以下の状態遷移が可能です：

  • "transferring": "idle"

  • "idle":"transferring"

transferStateDetails

配列["type_astra_stateDetail"]

False

現在の状態に関する追加の詳細情報（現在の状態に至った理由を含む）。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです：

  • 最小アイテム数：0

healthState

string

True

リソースの健全性状態。定義された値は次のとおりです：

  • 「不確定」 - リソースの状態を判断できません（例えば、接続不良のため）

  • 「normal」 - リソースに既知の問題はなく、インターフェース仕様に従ってサービスを提供できます。

  • 「警告」：このリソースには既知の問題がありますが、インターフェース仕様に従ってサービスを提供することに支障はありません。

  • 「重大」 - リソースに既知の問題があり、インターフェース仕様に従ってサービスを提供できない

healthStateTransitions

配列["type_astra_stateTransition"]

True

特定の定義済み状態からの許可された状態遷移。このリソースでは、以下の状態遷移が可能です：

  • "indeterminate"："normal"、"warning"、"critical"

  • "normal"："indeterminate"、"warning"、"critical"

  • "warning"："indeterminate"、"normal"、"critical"

  • "critical"："indeterminate"、"normal"、"warning"

healthStateDetails

配列["type_astra_stateDetail"]

True

現在の状態に関する追加の詳細情報（現在の状態に至った理由を含む）。詳細情報が利用できない場合、この配列は空になります。定義された値は次のとおりです：

  • 最小アイテム数：0

メタデータ

"type_astra_metadata_update"

True

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

  • Astra メタデータスキーマに準拠します。作成時に指定しない場合、ラベルのないメタデータオブジェクトが作成されます。更新時に指定されていない場合、メタデータオブジェクトのラベル、creationTimestamp および createdBy は、変更なしで保持されます。
回答例 
{
  "type": "application/astra-appMirror",
  "version": "1.0",
  "id": "c5fbadd4-5d9e-5942-bb7f-f5386b6b6253",
  "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": "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

名前空間が指定されているクラスタの識別子。定義された値は次のとおりです：

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

ネームスペース

array[string]

False

クラスタで使用するネームスペースのリスト。インデックスによって他のクラスタのネームスペースリストと関連付けられます。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：63

  • DNS 1123 Label Schemaに準拠

storageClasses

Name を入力します 必須 説明

clusterID

string

False

ストレージクラスが指定されているクラスタの識別子。定義された値は次のとおりです：

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

storageClassName

string

False

「clusterID」で指定されたクラスタ上でPVCを作成する際に使用するストレージクラスの名前。定義された値は次のとおりです：

  • 最小長さ：1

  • 最大長さ：255

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 を入力します 必須 説明

ラベル

配列["type_astra_label"]

False

作成タイムスタンプ

string

False

modificationTimestamp

string

False

作成者

string

False

modifiedBy

string

False

invalidParams

Name を入力します 必須 説明

名前

string

True

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

理由

string

True

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