REST APIリファレンス

前へ次へ

設定の詳細の取得

特定の設定の詳細を要求できます。

GET要求

設定の詳細を取得するには、次のURIを使用します。

/public/core/v3/ClusterConfig/<config_id>

GET応答

成功した場合、設定に関する次の情報を返します。

フィールド	タイプ	説明
id	文字列	設定ID。
orgId	String	設定が属する組織のID。
infaManaged	Boolean	設定がInformaticaによって管理されているかどうか。
clusterName	String	設定の名前。
description	文字列	設定の説明。
cloudPlatform	文字列	設定をホストするクラウドプラットフォーム。
haEnabled	ブール	高可用性が有効になっているかどうか。
region	文字列	設定が配置されているリージョン。
subnets	配列	ネットワーク内で使用されるサブネット。
masterNodeInstanceType	文字列	マスタノードをホストするインスタンスのタイプ。
maxWorkerNodes	整数	使用するワーカーノードの最大数。
minWorkerNodes	整数	使用するワーカーノードの最小数。
workerNodeIdleTimeout	整数	ワーカーノードがタイムアウトするまでの時間（分単位）。
workerNodeInstanceType	String	ワーカーノードをホストするインスタンスのタイプ。
workerNodeVolumeSize	整数	ワーカーノードのボリュームサイズ。
systemDiskConfig	JSONのエスケープされた文字列表現	システムストレージのプロパティ（設定されている場合）。ファイルシステム、ソースマウント、およびアクセスポイントが含まれます。
dataDisksConfig	JSONのエスケープされた文字列表現	データストレージのプロパティ（設定されている場合）。ファイルシステム、ソースマウント、およびアクセスポイントが含まれます。
initScriptPath	文字列	使用しない。エラスティックランタイム環境では、初期化スクリプトは使用されません。
masterNodeIAMRole	文字列	マスターノードのIAMロール。
workerNodeIAMRole	文字列	ワーカーノードのIAMロール。
imageRegistryHost	文字列	コンテナイメージをホストするレジストリのドメイン名またはIPアドレス。
imageRegistryUser	文字列	イメージレジストリホストにログインするためのユーザー名。
imageRegistryPassword	文字列	イメージレジストリホストにログインするためのパスワード。
dateDeployed	日付	イメージがデプロイされた日付。
miscTags	JSONのエスケープされた文字列表現	クラウドエコシステムに関連付けられたタグ。

GET応答の例

設定の詳細を取得するには、次の要求を使用します。

GET <baseApiUrl>/public/core/v3/ClusterConfig/<config_id>
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

成功した場合、次の例のような応答が返されます。

[
   {
    "id": "5MdLmj0YXoce2osMD2mT0r",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "infaManaged": false,
    "clusterName": "test-cluster",
    "description": "Description of the cluster",
    "cloudPlatform": "AWS",
    "haEnabled": false,
    "region": "us-west-1",
    "subnets": [
        "subnet-1",
        "subnet-2"
    ],
    "masterNodeInstanceType": "m5.large",
    "maxWorkerNodes": 10,
    "minWorkerNodes": 1,
    "workerNodeIdleTimeout": 5,
    "workerNodeInstanceType": "m5.xlarge",
    "workerNodeVolumeSize": 100,
    "systemDiskConfig": "{\"id\": \"\", \"sourceMount\": \"\", \"accessPoint\": \"\"}",
    "dataDisksConfig": "[{\"id\": \"\", \"sourceMount\": \"\", \"targetMount\": \"\", \"accessPoint\": \"\"}]",
    "initScriptPath": "/path/to/script",
    "masterNodeIAMRole": "masterRole",
    "workerNodeIAMRole": "workerRole",
    "imageRegistryHost": "registry.example.com",
    "imageRegistryUser": null,
    "imageRegistryPassword": null,
    "dateDeployed": null,
    "miscTags": "{\"cloudEcosystemTags\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}],\"runtimeProperties\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}]}"
  }
]

エラスティックランタイム環境

ガイドをダウンロード

ページをウォッチ

フィードバックを送信

コミュニティ

Knowledge Base

Success Portal