REST APIリファレンス

前へ次へ

設定の更新

管理者特権が付与されている場合は、ClusterConfigリソースを使用して設定を更新できます。

PUT要求

設定を更新するには、次のURIを使用してPUT要求を送信します。

/public/core/v3/ClusterConfig/<advanced_config_ID>

以下の情報を含めます。

フィールド	タイプ	必須	説明
ID	String	○	設定ID。
orgId	String	○	設定が属する組織のID。
infaManaged	Boolean	はい	設定がInformaticaによって管理されているかどうか。falseに設定します。
clusterName	String	○	設定の名前。
description	文字列	-	設定の説明。
cloudPlatform	文字列	○	設定をホストするクラウドプラットフォーム。AWSに設定します。
haEnabled	ブール	はい	高可用性が有効になっているかどうか。
region	文字列	○	設定が配置されているリージョン。
subnets	配列	はい	ネットワーク内で使用されるサブネット。サブネットIDではなく、サブネット名を入力します。サブネットフィールドは、haEnabledフィールドに依存しています。 haEnabled = trueの場合、サブネットには2つの値が必要です。 haEnabled = falseの場合、サブネットは空またはNULLにする必要があります。
masterNodeInstanceType	文字列	○	このフィールドは空のままにします。
maxWorkerNodes	整数	○	使用するワーカーノードの最大数。
minWorkerNodes	整数	○	使用するワーカーノードの最小数。
workerNodeIdleTimeout	整数	○	ワーカーノードがタイムアウトするまでの時間（分単位）。
workerNodeInstanceType	String	○	ワーカーノードをホストするインスタンスのタイプ。
workerNodeVolumeSize	整数	○	ワーカーノードのボリュームサイズ。
systemDiskConfig	JSONのエスケープされた文字列表現	はい	システムストレージのプロパティ。ファイルシステム、ソースマウント、およびアクセスポイントが含まれます。
dataDisksConfig	JSONのエスケープされた文字列表現	はい	データストレージのプロパティ。ファイルシステム、ソースマウント、およびアクセスポイントが含まれます。
initScriptPath	文字列	○	使用しない。エラスティックランタイム環境では、初期化スクリプトは使用されません。
masterNodeIAMRole	String	○	マスターノードのIAMロール。
workerNodeIAMRole	文字列	-	使用しません。
imageRegistryHost	文字列	-	使用しません。
imageRegistryUser	文字列	-	使用しません。
imageRegistryPassword	文字列	-	使用しません。
dateDeployed	日付	-	このフィールドは空のままにします。
miscTags	JSONのエスケープされた文字列表現	はい	クラウドエコシステムのタグとランタイムプロパティ。それぞれのタグカテゴリは必須ですが、その値は空にすることができます。例: "miscTags": "{\"cloudEcosystemTags\":[],\"runtimeProperties\":[]}"

PUT応答

成功した場合、PUT要求でClusterConfigオブジェクトを返します。

PUTの例

設定を更新するには、次の例のような要求を送信します。

POST <baseApiUrl>/public/core/v3/ClusterConfig/<config_ID>
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
    "id": "89Dnw937Al30sN40ia9Oat",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "infaManaged": false,
    "clusterName": "test-cluster-102",
    "description": "Description of the cluster",
    "cloudPlatform": "AWS",
    "haEnabled": false,
    "region": "ap-south-1",
    "subnets": [
        "subnet-name1",
        "subnet-name2"
    ],
    "masterNodeInstanceType": "",
    "maxWorkerNodes": 10,
    "minWorkerNodes": 1,
    "workerNodeIdleTimeout": 5,
    "workerNodeInstanceType": "c4.2xlarge",
    "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\"}]}"
}

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

{
    "id": "89Dnw937Al30sN40ia9Oat",
    "orgId": "dx7DSOIGiiPh6XQoZKpAmC",
    "infaManaged": false,
    "clusterName": "test-cluster-102",
    "description": "Description of the cluster",
    "cloudPlatform": "AWS",
    "haEnabled": false,
    "region": "ap-south-1",
    "subnets": [
        "subnet-name1",
        "subnet-name2"
    ],
    "masterNodeInstanceType": "",
    "maxWorkerNodes": 10,
    "minWorkerNodes": 1,
    "workerNodeIdleTimeout": 5,
    "workerNodeInstanceType": "c4.2xlarge",
    "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