REST APIリファレンス > プラットフォームREST APIバージョン3リソース > エラスティックランタイム環境
  

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

エラスティックランタイム環境の環境設定、画像、関連付け、補足ファイル仕様、トークンなど、エラスティックランタイム環境を管理できます。

環境設定

エラスティックランタイム環境の環境設定を取得、作成、および更新するには、ClusterConfigリソースを使用します。

設定の詳細の取得

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

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\"}]}"
}
]

設定の作成

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

POST要求

設定を作成するには、次のURIを使用してPOST要求を送信します。
/public/core/v3/ClusterConfig
以下の情報を含めます。
フィールド
タイプ
必須
説明
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\":[]}"

POST応答

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

POSTの例

設定を作成するには、次の例のような要求を送信します。
POST <baseApiUrl>/public/core/v3/ClusterConfig
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <sessionId>
{
"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": "user",
"imageRegistryPassword": "password",
"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": "user",
"imageRegistryPassword": "password",
"dateDeployed": null,
"miscTags": "{\"cloudEcosystemTags\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}],\"runtimeProperties\":[{\"key\":\"k1\",\"val\":\"v1\"},{\"key\":\"k2\",\"val\":\"v2\"}]}"
}

設定の更新

管理者特権が付与されている場合は、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\"}]}"
}

画像

エラスティックランタイム環境の画像を一覧表示するには、RuntimeApplicationImageリソースを使用します。

GET要求

使用可能なすべてのイメージを一覧表示するには、次のURIを使用します。
/public/core/v3/ais/RuntimeApplicationImage?runtimeEnvironmentId=<rteId>&includeAllImageStates=<true or false>
次のパラメータを含めます。
パラメータ
タイプ
説明
rteId
文字列
イメージをダウンロードするランタイム環境ID。
includeAllImageStates
ブール
画像のダウンロードの現在のステージを、それが完了するまでの間、返します。
次の表に、要求の潜在的なエラーコードを示します。
HTTPステータスコード
説明
401
未認証、または未承認。
403
このAPIにアクセスするには、特権get.k8s.repository.tokenが必要です。

GET応答

成功すると、使用可能なイメージのリストが返されます。

GET応答の例

ダウンロード可能なイメージを一覧表示するには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/RuntimeApplicationImage?runtimeEnvironmentId=<rteId>&includeAllImageStates=<true or false>
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、次の例のような「200 OK」応答が返されます。
[
{
"appSpecName": "Data_Integration",
"appSpecVersion": "64.0",
"dependencies": "package-Administrator_R1.226",
"imageName": "Data_Integration",
"imageVersion": "64.0",
"imageRepositoryPath": "infacloud-k8s-agent-docker-dev.jfrog.io/3SLs6FMAlJ0lGGyI0pMK0g/rteId1/DataIntegration:64.0",
"rteGroupId": "rteId1",
"orgId": "3SLs6FMAlJ0lGGyI0pMK0g",
"imageState": "IMAGE_BAKE_COMPLETE",
"endTime": "2022-10-31T07:06:59.000Z",
"helmChartPath": "helmChartPath"
},
{
"appSpecName": "Data_Integration",
"appSpecVersion": "64.1",
"dependencies": "package-Administrator_R1.226,
"imageName": "Data_Integration,
"imageVersion": "64.1",
"imageRepositoryPath": "infacloud-k8s-agent-docker-dev.jfrog.io/3SLs6FMAlJ0lGGyI0pMK0g/rteId1/DataIntegration:64.1",
"rteGroupId": "rteId1",
"orgId": "3SLs6FMAlJ0lGGyI0pMK0g",
"imageState": "IMAGE_BAKE_COMPLETE",
"endTime": "2022-10-31T07:06:59.000Z",
"helmChartPath": "helmChartPath"
}
]
付与された特権が不十分である場合は、次の例のような「403 Forbidden」応答を受け取ることがあります。
{
"error": {
"code": "AIS_007",
"message": "Privilege - view.k8s.agent.config required for accessing this API.",
"debugMessage": "Privilege - view.k8s.agent.config required for accessing this API.",
"requestId": "l2EpwkFoqkEjrEJURclPw2",
"details": null
}
}

ランタイム環境associations

環境設定とエラスティックランタイム環境の間の関連付けを管理するには、RuntimeEnvironmentリソースを使用します。

エラスティックランタイム環境IDによるランタイム環境の関連付けの読み取り

ランタイム環境IDを使用して、クラスタとエラスティックランタイム環境間の関連付けに関する詳細を要求できます。

GET要求

設定とランタイム環境間の関連付けを取得するには、次のURIを使用します。
/public/core/v3/RuntimeEnvironment/<rte_id>/Cluster
ここで、<rte_id>はランタイム環境IDです。

GET応答

成功した場合、関連付けに関する次の情報を返します。
フィールド
タイプ
説明
rteId
文字列
ランタイム環境ID。
clusterId
String
設定ID。
名前空間
文字列
使用される名前空間。
createdBy
String
関連付けを作成したユーザーの名前。

GET応答の例

設定とランタイム環境間の関連付けを取得するには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/RuntimeEnvironment/<rte_id>/Cluster
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、次の例のような応答が返されます。
{
"rteId": "01B0IV2500000000035Y",
"clusterId": "5gic8zWc1G7fSDQVJRpUEh",
"namespace": "test-namespace-1",
"createdBy": "test-user-1"
}

クラスタIDによるランタイム環境の関連付けの読み取り

設定IDを使用して、クラスタとエラスティックランタイム環境間の関連付けに関する詳細を要求できます。

GET要求

設定とランタイム環境間の関連付けを取得するには、次のURIを使用します。
/public/core/v3/RuntimeEnvironment/<cluster_id>/Cluster
ここで、<cluster_id>は設定IDです。

GET応答

成功した場合、関連付けに関する次の情報を返します。
フィールド
タイプ
説明
rteId
文字列
ランタイム環境ID。
clusterId
String
設定ID。
名前空間
文字列
使用される名前空間。
createdBy
String
関連付けを作成したユーザーの名前。

GET応答の例

設定とランタイム環境間の関連付けを取得するには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/RuntimeEnvironment/<cluster_id>/Cluster
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、次の例のような応答が返されます。
{
"rteId": "01B0IV2500000000035Y",
"clusterId": "5gic8zWc1G7fSDQVJRpUEh",
"namespace": "test-namespace-1",
"createdBy": "test-user-1"
}

設定とランタイム環境の関連付け

クラスタをランタイム環境に関連付けることができます。

POST要求

設定をランタイム環境に関連付けるには、次のURIを使用します。
/public/core/v3/RuntimeEnvironment/<rte_id>/Cluster/<cluster_id>
ここで、<rte_id>はランタイム環境ID、<cluster_id>は設定IDです。
以下の情報を含めます。
フィールド
タイプ
必須
説明
namespace
文字列
-
設定の名前空間。

POST応答

成功した場合、次の情報を返します。
フィールド
タイプ
説明
rteId
文字列
ランタイム環境ID。
clusterId
String
設定ID。
名前空間
文字列
使用される名前空間。
createdBy
String
関連付けを作成したユーザーの名前。

POST応答の例

設定をランタイム環境と関連付けるには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/RuntimeEnvironment/<rte_id>/Cluster/<cluster_id>
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、次の例のような応答が返されます。
{
"rteId": "01B0IV2500000000035Y",
"clusterId": "5gic8zWc1G7fSDQVJRpUEh",
"namespace": "test-namespace-1",
"createdBy": "test-user-1"
}

補足ファイル

エラスティックランタイム環境の補足ファイル仕様を取得、更新、および削除するには、RuntimeEnvironmentリソースを使用します。

補足ファイル仕様の取得

補足ファイル仕様を取得することで、エラスティックランタイム環境で使用可能な補足ファイルを表示できます。

GET要求

次のURIを使用します。
/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig

GET応答

成功した場合は、補足ファイル仕様を返します。応答には次のフィールドが含まれます。
フィールド
タイプ
説明
rteId
文字列
ランタイム環境ID。
仕様
オブジェクト
補足ファイル仕様。
仕様のフィールドの詳細については、「補足ファイル仕様の更新」を参照してください。
エラスティックランタイム環境に補足ファイル仕様がない場合は、空の仕様が返されます。

GET要求の例

次の要求の例は、エラスティックランタイム環境の補足ファイル仕様を取得するものです。
GET <base URL>/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

補足ファイル仕様の更新

仕様を更新することで、エラスティックランタイム環境で使用可能な補足ファイルを更新します。
補足ファイル仕様を更新すると、影響を受けるすべてのSecure Agentサービスが自動的に再起動され、更新された仕様を使用するようになります。

POST要求

次のURIを使用します。
/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig
ファイルのソースパスを指定する場合は、ファイルシステムのマウントポイントの下にあるサブディレクトリを使用します。例えば、ファイルシステムのマウントポイントとして使用するディレクトリとして/mnt/efsを作成し、JDBCドライバを保存するディレクトリとして/mnt/efs/jdbcを作成する場合は、ソースパスとして/jdbc/<file name>を使用します。
データストレージ用のEFSファイルシステムの作成とマウントの詳細については、管理者ヘルプ内のランタイム環境を参照してください。
要求に次のフィールドを含めます。
フィールド
タイプ
説明
rteId
文字列
ランタイム環境ID。
仕様
オブジェクト
補足ファイル仕様。
エージェント
オブジェクト
Secure Agentの設定。
specification.agent.databaseIngestion
オブジェクト
データ取り込みおよびレプリケーションファイル。各JARファイルを個別にリストします。次の情報を指定します。
  • - jdbcDrivers
  • - oracle
specification.agent.databaseIngestion.jdbcDrivers
オブジェクトの配列
データ取り込みおよびレプリケーション.のためのJDBCドライバ。
specification.agent.databaseIngestion.jdbcDrivers[].sourcePath
文字列
JDBCドライバのJARファイルへのパス。
specification.agent.databaseIngestion.oracle
オブジェクト
データ取り込みおよびレプリケーション.のための、Oracleドライバおよびそのバージョン情報。次の情報を指定します。
  • - jdbcDrivers
  • - ociDrivers
  • - バージョン
specification.agent.databaseIngestion.oracle.jdbcDrivers
オブジェクトの配列
Oracle JDBCドライバ。
specification.agent.databaseIngestion.oracle.jdbcDrivers[].sourcePath
文字列
Oracle JDBCドライバのJARファイルへのパス。
specification.agent.databaseIngestion.oracle.ociDrivers
オブジェクトの配列
Oracle OCIドライバ。
specification.agent.databaseIngestion.oracle.ociDrivers[].sourcePath
文字列
Oracle OCIドライバファイルへのパス。
specification.agent.databaseIngestion.oracle.version
文字列
Oracleのバージョン。
specification.agent.dataIntegrationServer
オブジェクト
データ統合サーバーファイル。次の情報を指定します。
  • - jdbcv2
  • - jdbcDrivers
  • - odbc
  • - odbcInst
  • - mysql
  • - sap
  • - ssls
specification.agent.dataIntegrationServer.jdbcv2
オブジェクト
データ統合サーバー用のJDBC V2ドライバ。各JARファイルを個別にリストします。以下のドライバタイプを指定します。
  • - common
  • - spark
specification.agent.dataIntegrationServer.jdbcv2.common
オブジェクトの配列
一般的なJDBCドライバ。
specification.agent.dataIntegrationServer.jdbcv2.common[].sourcePath
文字列
一般的なJDBCドライバのJARファイルへのパス。
specification.agent.dataIntegrationServer.jdbcv2.spark
オブジェクトの配列
Spark固有のJDBCドライバ。
specification.agent.dataIntegrationServer.jdbcv2.spark[].sourcePath
文字列
Spark固有のJDBCドライバのJARファイルへのパス。
specification.agent.dataIntegrationServer.jdbcDrivers
オブジェクトの配列
データ統合サーバー用の追加JDBCドライバ。各JARファイルを個別にリストします。
specification.agent.dataIntegrationServer.jdbcDrivers.sourcePath
文字列
追加のJDBCドライバのJARファイルへのパス。
specification.agent.dataIntegrationServer.mysql
オブジェクト
データ統合サーバー用のMySQLドライバとそのバージョン情報。各JARファイルを個別にリストします。次の情報を指定します。
  • - jdbcDrivers
  • - odbcDrivers
  • - バージョン
specification.agent.dataIntegrationServer.mysql.jdbcDrivers
オブジェクトの配列
MySQL JDBCドライバ。
specification.agent.dataIntegrationServer.mysql.jdbcDrivers[].sourcePath
文字列
MySQL JDBCドライバのJARファイルへのパス。
specification.agent.dataIntegrationServer.mysql.odbcDrivers
オブジェクトの配列
MySQL ODBCドライバ。
specification.agent.dataIntegrationServer.mysql.odbcDrivers[].sourcePath
文字列
MySQL ODBCドライバファイルへのパス。
specification.agent.dataIntegrationServer.mysql.version
文字列
MySQLバージョン。
specification.agent.dataIntegrationServer.odbc
オブジェクト
データ統合サーバー用のODBCドライバとそのDSN。次の情報を指定します。
  • - ドライバ
  • - dsns
specification.agent.dataIntegrationServer.odbc.drivers
オブジェクトの配列
ODBCドライバ。
specification.agent.dataIntegrationServer.odbc.drivers[].sourcePath
文字列
ODBCドライバファイルへのパス。
specification.agent.dataIntegrationServer.odbc.dsns
オブジェクトの配列
複数のODBC DSNエントリ。各エントリは、odbc.iniファイルに書き込まれるので、必要なすべてのコンポーネントを含めておく必要があります。次の情報を指定します。
  • - name
  • - キーと値のペアとしてのエントリ
specification.agent.dataIntegrationServer.odbc.dsns[].name
文字列
odbc.iniファイルにおけるODBCのDSN名。
specification.agent.dataIntegrationServer.odbc.dsns[].entries
オブジェクトの配列
odbc.iniファイルにおける、キーと値のペアとしてのエントリ。
specification.agent.dataIntegrationServer.odbc.dsns[].entries[].key
文字列
DSNエントリのキー。
specification.agent.dataIntegrationServer.odbc.dsns[].entries[].value
文字列
DSNエントリの値。
specification.agent.dataIntegrationServer.odbcInst
オブジェクト
データ統合サーバー用のODBCINSTドライバとそのDSN。次の情報を指定します。
  • - ドライバ
  • - dsns
specification.agent.dataIntegrationServer.odbcInst.drivers
オブジェクトの配列
ODBCINSTドライバ。
specification.agent.dataIntegrationServer.odbcInst.drivers[].sourcePath
文字列
ODBCINSTドライバファイルへのパス。
specification.agent.dataIntegrationServer.odbcInst.dsns
オブジェクトの配列
ODBCINSTのDSNエントリ。各エントリは、odbcinst.iniファイルに書き込まれるので、必要なすべてのコンポーネントを含めておく必要があります。次の情報を指定します。
  • - name
  • - キーと値のペアとしてのエントリ
specification.agent.dataIntegrationServer.odbcInst.dsns[].name
文字列
odbcinst.iniファイルにおけるODBCINSTのDSN名。
specification.agent.dataIntegrationServer.odbcInst.dsns[].entries
オブジェクトの配列
odbcinst.iniファイルにおける、キーと値のペアとしてのエントリ。
specification.agent.dataIntegrationServer.odbcInst.dsns[].entries[].key
文字列
DSNエントリのキー。
specification.agent.dataIntegrationServer.odbcInst.dsns[].entries[].value
文字列
DSNエントリの値。
specification.agent.dataIntegrationServer.sap
オブジェクト
データ統合サーバー用のSAP詳細。次の情報を指定します。
  • - jcos
  • - nwrfcs
  • - hanas
specification.agent.dataIntegrationServer.sap.jcos
オブジェクトの配列
SAP JCoライブラリファイル。
specification.agent.dataIntegrationServer.sap.jcos[].sourcePath
文字列
SAP JCoライブラリファイルへのパス。
specification.agent.dataIntegrationServer.sap.nwrfcs
オブジェクトの配列
SAP NetWeaver RFCライブラリファイル。
specification.agent.dataIntegrationServer.sap.nwrfcs[].sourcePath
文字列
SAP NetWeaver RFCライブラリファイルへのパス。
specification.agent.dataIntegrationServer.sap.hanas
オブジェクトの配列
SAP HANAライブラリファイル。
specification.agent.dataIntegrationServer.sap.hanas[].sourcePath
文字列
SAP HANAライブラリファイルへのパス。
specification.agent.dataIntegrationServer.ssls
オブジェクトの配列
データ統合サーバー用のSSL詳細。次の情報を指定します。
  • - fileCopy
  • - importCerts
specification.agent.dataIntegrationServer.ssls[].fileCopy
オブジェクト
SSLのキーストア/トラストストアファイル。
specification.agent.dataIntegrationServer.ssls[].fileCopy.sourcePath
文字列
SSLのキーストア/トラストストアファイルへのパス。
specification.agent.dataIntegrationServer.ssls[].importCerts
オブジェクト
証明書のインポートの詳細。次の情報を指定します。
  • - certName
  • - エイリアス
specification.agent.dataIntegrationServer.ssls[].importCerts.certName
文字列
インポートする証明書の名前。
specification.agent.dataIntegrationServer.ssls[].importCerts.alias
文字列
キーストアにインポートする証明書のエイリアス。
specification.agent.elasticServer
オブジェクト
エラスティックサーバーファイル。次の情報を指定します。
  • - javaTxResources
  • - jdbcv2
  • - nativeBinResources
  • - nativeLibResources
specification.agent.elasticServer.javaTxResources
オブジェクトの配列
エラスティックサーバー用のJavaトランスフォーメーションリソースファイル。
specification.agent.elasticServer.javaTxResources[].sourcePath
文字列
Javaトランスフォーメーションリソースファイルへのパス。
specification.agent.elasticServer.jdbcv2
オブジェクト
エラスティックサーバー用のJDBC V2ドライバ。各JARファイルを個別にリストします。以下のドライバタイプを指定します。
  • - common
  • - spark
specification.agent.elasticServer.jdbcv2.common
オブジェクトの配列
一般的なJDBCドライバ。
specification.agent.elasticServer.jdbcv2.common[].sourcePath
文字列
エラスティックサーバー用の一般的なJDBCドライバのJARファイルへのパス
specification.agent.elasticServer.jdbcv2.spark
オブジェクトの配列
Spark固有のJDBCドライバ。
specification.agent.elasticServer.jdbcv2.spark[].sourcePath
文字列
エラスティックサーバー用のSpark固有のJDBCドライバのJARファイルへのパス。
specification.agent.elasticServer.nativeBinResources
オブジェクトの配列
エラスティックサーバー用のネイティブバイナリリソースファイル。
specification.agent.elasticServer.nativeBinResources[].sourcePath
文字列
ネイティブバイナリリソースファイルへのパス。
specification.agent.elasticServer.nativeLibResources
オブジェクトの配列
エラスティックサーバー用のネイティブライブラリリソースファイル。
specification.agent.elasticServer.nativeLibResources[].sourcePath
文字列
ネイティブライブラリリソースファイルへのパス。
specification.agent.executableScript
オブジェクト
実行可能スクリプト。次の情報を指定します。
  • - scriptPath
  • - scriptArgs
  • - currentDirectory
specification.agent.executableScript.scriptPath
文字列
当該スクリプトへのパス。このスクリプトはマスタノードで実行されます。
specification.agent.executableScript.scriptArgs
文字列型配列
当該スクリプトの実行時にそのスクリプトに渡す引数。
specification.agent.executableScript.currentDirectory
文字列
当該スクリプトが実行される作業ディレクトリ。
specification.agent.jdk
オブジェクト
JDKポリシー。
specification.agent.jdk.policyJars
文字列型配列
JDKポリシーのJARファイル。各JARファイルを個別にリストします。
specification.agent.sslStore
オブジェクトの配列
SSLストアファイル。
specification.agent.sslStore[].sourcePath
文字列
SSLストアファイルへのパス。

POST応答

成功した場合は、更新された補足ファイル仕様を返します。

POST要求の例

次のPOST要求の例は、補足ファイル仕様を更新するものです。
POST <base URL>/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

{
"rteId": "rte-12345",
"specification": {
"agent": {
"databaseIngestion": {
"jdbcDrivers": [{"sourcePath": "/dbingest/jdbc1.jar"}],
"oracle": {
"jdbcDrivers": [{"sourcePath": "/oracle/jdbc1.jar"}],
"ociDrivers": [{"sourcePath": "/oracle/oci1.so"}],
"version": "19c"
}
},
"dataIntegrationServer": {
"jdbcv2": {
"common": [{"sourcePath": "/jdbc/common1.jar"}],
"spark": [{"sourcePath": "/jdbc/spark1.jar"}]
},
"jdbcDrivers": [{"sourcePath": "/jdbc/driver1.jar"}],
"mysql": {
"jdbcDrivers": [{"sourcePath": "/mysql/jdbc1.jar"}],
"odbcDrivers": [{"sourcePath": "/mysql/odbc1.so"}],
"version": "8.0"
},
"odbc": {
"drivers": [{"sourcePath": "/odbc/driver1.so"}],
"dsns": [{"name": "dsn1", "entries": [{"key": "Server", "value": "localhost"}]}]
},
"odbcInst": {
"drivers": [{"sourcePath": "/odbcinst/driver2.so"}],
"dsns": [{"name": "dsn2", "entries": [{"key": "Port", "value": "1234"}]}]
},
"sap": {
"jcos": [{"sourcePath": "/sap/jco1"}],
"nwrfcs": [{"sourcePath": "/sap/nwrfc1"}],
"hanas": [{"sourcePath": "/sap/hana1"}]
},
"ssls": [
{
"fileCopy": {"sourcePath": "/ssl/keystore.jks"},
"importCerts": {"certName": "mycert", "alias": "myalias"}
}
]
},
"elasticServer": {
"javaTxResources": [{"sourcePath": "/elastic/javaTxRes.jar"}],
"jdbcv2": {
"common": [{"sourcePath": "/elastic/jdbc/common2.jar"}],
"spark": [{"sourcePath": "/elastic/jdbc/spark2.jar"}]
},
"nativeLibResources": [{"sourcePath": "/elastic/nativeLib.so"}],
"nativeBinResources": [{"sourcePath": "/elastic/nativeBin"}]
},
"executableScript": {
"scriptPath": "/scripts/start.sh",
"scriptArgs": ["--env", "prod"],
"currentDirectory": "/scripts"
},
"jdk": {
"policyJars": [
"/datadisk/jdk/policy/unlimited/US_export_policy.jar",
"/datadisk/jdk/policy/unlimited/local_policy.jar"
]
},
"sslStore": [{"sourcePath": "/ssl/store.jks"}]
}
}
}

補足ファイル仕様の削除

補足ファイル仕様を削除することで、エラスティックランタイム環境で補足ファイルが使用されないようにすることができます。
補足ファイル仕様を削除すると、影響を受けるすべてのSecure Agentサービスが自動的に再起動され、補足ファイルを使用しないようになります。

POST要求

次のURIを使用します。
/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig
要求に次のフィールドを含めます。
フィールド
タイプ
説明
rteId
文字列
ランタイム環境ID。
仕様
オブジェクト
補足ファイル仕様がNULLに設定されています。

POST応答

成功した場合、空の仕様が返されます。

POSTの例

次のPOST要求の例は、補足ファイル仕様を削除するものです。
POST <base URL>/api/v3/RuntimeEnvironment/<runtime environment ID>/ElasticConfig
Content-Type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>

{
"rteId": "<runtime environment ID>",
"specification": null
}

トークン

エラスティックランタイム環境用の組織のトークンを管理するには、containerImageTokenリソースを使用します。

新しいトークンの取得

Kubernetes DevOpsエンジニア特権がある場合は、Artifactoryにアクセスしてイメージをダウンロードするために使用できるトークンを要求できます。

GET要求

新しいトークンを取得するには、次のURIを使用します。
/public/core/v3/containerimagetoken/create
次の表に、要求の潜在的なエラーコードを示します。
HTTPステータスコード
説明
401
未認証、または未承認。
403
権限が不足しています。このAPIにアクセスするには、get.k8s.repository.token特権が必要です。

GET応答

成功した場合、トークンIDとトークン値を返します。

GET応答の例

新しいトークンを取得するには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/containerimagetoken/create
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、次の例のような「200 OK」応答が返されます。
{
"tokenId":"<token ID>",
"tokenValue":"<token value>"
}
付与された特権が不十分である場合は、次の例のような「403 Forbidden」応答を受け取ることがあります。
{
"error": {
"code": "AIS_007",
"message": "Privilege - view.k8s.agent.config required for accessing this API.",
"debugMessage": "Privilege - view.k8s.agent.config required for accessing this API.",
"requestId": "l2EpwkFoqkEjrEJURclPw2",
"details": null
}
}
トークンが取り消された場合は、次の例のような「400 Bad Request」応答を受け取ることがあります。
{
"error": {
"code": "AIS_014",
"message": "Token with id:<token ID> already revoked.",
"debugMessage": "Token with id:<token ID> already revoked.",
"requestId": "iVdlwEoaFiZd3vb0LvLVmp",
"details": null
}
}

トークンの取り消し

Kubernetes DevOpsエンジニア特権が付与されている場合は、トークンを取り消すことができます。

DELETE要求

トークンを取り消すには、次のURIを使用します。
/public/core/v3/containerImageToken/revoke/<tokenId>
次のパラメータを含めます。
パラメータ
タイプ
説明
tokenId
文字列
取り消すトークンのID。
次の表に、要求の潜在的なエラーコードを示します。
HTTPステータスコード
説明
400
ID:{tokenId}のトークンはすでに取り消されています。
400
ユーザー:{0}にはこのトークンを取り消す権限がありません。
401
未認証、または未承認。
403
このAPIにアクセスするには、特権get.k8s.repository.tokenが必要です。

DELETE応答

成功した場合、トークンが取り消されます。

DELETE応答の例

トークンを取り消すには、次の要求を使用します。
DELETE <baseApiUrl>/public/core/v3/containerImageToken/revoke/<tokenId>
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、「200 OK」応答が返されます。
付与された特権が不十分である場合は、次の例のような「403 Forbidden」応答を受け取ることがあります。
{
"error": {
"code": "AIS_007",
"message": "Privilege - view.k8s.agent.config required for accessing this API.",
"debugMessage": "Privilege - view.k8s.agent.config required for accessing this API.",
"requestId": "l2EpwkFoqkEjrEJURclPw2",
"details": null
}
}
}
トークンがすでに取り消されている場合は、次の例のような「400 Bad Request」応答を受け取ることがあります。
{
"error": {
"code": "AIS_014",
"message": "Token with id:<token ID> already revoked.",
"debugMessage": "Token with id:<token ID> already revoked.",
"requestId": "iVdlwEoaFiZd3vb0LvLVmp",
"details": null
}
}
}
トークンを取り消す権限が付与されていない場合は、次の例のような「400 Bad Request」応答を受け取る可能性があります。
{
"error": {
"code": "AIS_013",
"message": "User:k8s is not authorized to revoke this token :<token ID>.",
"debugMessage": "User:k8s is not authorized to revoke this token :<token ID>.",
"requestId": "iLhZ6l6EF6Ddb3jICTGxoj",
"details": null
}
}

組織のすべてのトークンの取得

Kubernetes DevOpsエンジニア特権が付与されている場合は、組織のすべてのトークンを一覧表示できます。

GET要求

組織のすべてのトークンを一覧表示するには、次のURIを使用します。
/public/core/v3/containerImageToken
次のパラメータを含めます。
パラメータ
タイプ
説明
orgId
文字列
生成されたトークンを表示するための組織ID。
次の表に、要求の潜在的なエラーコードを示します。
HTTPステータスコード
説明
401
未認証、または未承認。
403
このAPIにアクセスするには、特権get.k8s.repository.tokenが必要です。

GET応答

成功した場合、組織のすべてのトークンのリストが返されます。

GET応答の例

ダウンロード可能なイメージを一覧表示するには、次の要求を使用します。
GET <baseApiUrl>/public/core/v3/containerImageToken
Content-type: application/json
Accept: application/json
INFA-SESSION-ID: <SessionId>
成功した場合、次の例のような「200 OK」応答が返されます。
[
{
"orgId": "52ZSTB0IDK6dXxaEQLUaQu",
"userId": "admin",
"tokenId": "<token ID>",
"expirationTime": "2022-10-31T07:06:59.000Z"
},
{
"orgId": "52ZSTB0IDK6dXxaEQLUaQu",
"userId": "admin",
"tokenId": "<token ID>",
"expirationTime": "2022-10-31T07:06:59.000Z"
}
]
付与された特権が不十分である場合は、次の例のような「403 Forbidden」応答を受け取ることがあります。
{
"error": {
"code": "AIS_007",
"message": "Privilege - view.k8s.agent.config required for accessing this API.",
"debugMessage": "Privilege - view.k8s.agent.config required for accessing this API.",
"requestId": "l2EpwkFoqkEjrEJURclPw2",
"details": null
}
}