Deployment Manager API
このセクションでは、以下のDeployment Managerのプロシージャについて説明します。
POST /executeQuery
このAPIは、クエリを実行するために使用されます。
パラメーター:
なし
リクエスト本文
値の例-スキーマ
[
“query”: "string",
“standardSQL”: “string”
]
例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeQuery" -H "accept: application/json" -H "Content-Type: application/x-www-form-urlencoded" -d "query=select * from SYS_SITES&standardSql=true"
POST /executeDDL
このAPIは、DDLコマンドを実行するために使用されます。
パラメーター:
なし
リクエスト本文
値の例-スキーマ
[
"string"
]
サイトを作成する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'CREATE RESOURCE /mySite OF TYPE "site" SET ANNOTATION "my site annotation" SET PROPERTIES { "host" : "localhost", "port": 9400, "user":"admin", "password":"password", "domain":"composite"}'
サイトを更新する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'ALTER RESOURCE /mySite OF TYPE "site" SET ANNOTATION "my site annotation update "'
サイトを削除する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'DROP RESOURCE /mySite OF TYPE "site"'
リソースセットを作成する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'CREATE RESOURCE /mySite/myResourceSet OF TYPE "resource_set" SET ANNOTATION "my resource set annotation" SET PROPERTIES { "definition" : "{\""includeDependencies\"":\""true\"",\""resourceTrees\"":[{\""path\"":\""/shared\"",\""type\"":\""CONTAINER\""}]}"}'
リソースセットを更新する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'ALTER RESOURCE /mySite/myResourceSet OF TYPE "resource_set" SET ANNOTATION "my resource set annotation update" '
リソースセットを削除する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'DROP RESOURCE /mySite/myResourceSet OF TYPE "resource_set"'
リソースセットマッピングを作成する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'CREATE RESOURCE /targetSite/sourceSite/shared/examples/ds_orders#DATA_SOURCE OF TYPE "attribute_mapping" SET PROPERTIES { "definition" : { "urlPort" : "1000"}}'
リソースセットマッピングを更新する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'ALTER RESOURCE /targetSite/sourceSite/shared/examples/ds_orders#DATA_SOURCE OF TYPE "attribute_mapping" SET PROPERTIES { "definition" : { "urlPort" : "2000"}}'
リソースセットマッピングを削除する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'DROP RESOURCE /targetSite/sourceSite/shared/examples/ds_orders#DATA_SOURCE OF TYPE "attribute_mapping"'
プリンシパルセットを作成する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'CREATE RESOURCE /mySourceSite/myPrincipalSet OF TYPE "principal_set" SET PROPERTIES { "definition" : [ "/composite/user/dev"] }'
プリンシパルセットを更新する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'ALTER RESOURCE /mySourceSite/myPrincipalSet OF TYPE "principal_set" SET ANNOTATION "my principal set annotation update"'
プリンシパルセットを削除する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'DROP RESOURCE /mySourceSite/myPrincipalSet OF TYPE "principal_set"'
プリンシパルセットマッピングを作成する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'CREATE RESOURCE /myTargetSite/mySourceSite OF TYPE "principal_set_mapping" SET PROPERTIES { "definition" : { "/composite/user/dev" : "/composite/user/test"}}'
プリンシパルセットマッピングを更新する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'ALTER RESOURCE /myTargetSite/mySourceSite OF TYPE "principal_set_mapping" SET PROPERTIES { "definition" : { "/composite/user/dev" : "/composite/user/dev1"}}'
プリンシパルセットマッピングを削除する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'DROP RESOURCE /myTargetSite/mySourceSite OF TYPE "principal_set_mapping"'
展開計画を作成する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'CREATE RESOURCE /myTargetSite/mySourceSite/MyDeploymentPlan_PrincipalSet_ADD OF TYPE "deployment_plan" SET ANNOTATION "my deployment plan annotation" SET PROPERTIES { "definition" : "{\""operations\"":{\""principalSet\"":\""myPrincipalSet\"",\""targetOperation\"":\""ADD\""}}"}'
展開計画を更新する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'ALTER RESOURCE /myTargetSite/mySourceSite/MyDeploymentPlan_PrincipalSet_ADD OF TYPE "deployment_plan"'
展開計画を削除する例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executeDDL" -H "Content-Type:text/plain" -H "Accept:text/plain" -d 'DROP RESOURCE /myTargetSite/mySourceSite/MyDeploymentPlan_PrincipalSet_ADD OF TYPE "deployment_plan"'
POST /executePlan
このAPIは、デプロイメントプランを実行するために使用されます。
パラメーター:
なし
リクエスト本文
値の例-スキーマ
[
"string"
]
例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/executePlan" -d '/myTargetSite/mySourceSite/DeploymentPlanName'
GET /export_dm_metadata
このAPIは、デプロイメント管理アーティファクトをエクスポートするために使用されます。
パラメーター:
名前 |
説明 |
パラメータータイプ |
データタイプ |
encryptionPassword |
暗号化されたパスワード |
query |
string |
例
curl -X GET -u admin:admin "http://localhost:9400/rest/deploy/export_dm_metadata" -H "Content-Type:application/binary"
GET /export_plan_package
このAPIは、デプロイメントプランをエクスポートするために使用されます。
パラメーター:
名前 |
説明 |
パラメータータイプ |
データタイプ |
plan |
エクスポートされるプラン名 |
query |
string |
encryptionPassword |
暗号化されたパスワード |
query |
string |
例
curl -X GET -u admin:admin "http://localhost:9400/rest/deploy/export_plan_package?plan=planName" -H "Content-Type:application/binary"
POST /import_dm_metadata
このAPIは、デプロイメント管理アーティファクトをインポートするために使用されます。
パラメーター
名前 |
説明 |
パラメータータイプ |
データタイプ |
file |
インポートするファイルの名前。 |
query |
object |
overwrite |
上書きするかどうかを示すオプション。 |
query |
boolean |
encryptionPassword |
Encryption Password(暗号化パスワード) |
query |
string |
ignoreEncryption |
暗号化エラーを無視するかどうかを示すオプション。 |
query |
boolean |
注: ignoreEncryptionオプションを使用すると、有効な暗号化キーが提供されているかどうかに関係なく、すべてのバックアップデータがインポートされます。つまり、インポートは失敗しません。このオプションを使用すると、バックアップされたデータを部分的にインポートできます。ただし、インポートプロセスでは、暗号化されていないデータか、提供された暗号化キーを使用して復号化できるデータのみがインポートされます。復号化できないバックアップデータの暗号化された部分はすべて空の値としてインポートされ、それ以外の部分は正常にインポートされます。
バックアップデータ内のすべての暗号化された値が該当します。これには、データソースやLDAPドメイン接続パスワードも含まれます。
例
curl -X POST -u admin:admin "http://localhost:9400/rest/deploy/import_dm_metadata" -H "Content-Type:multipart/form-data" -v -F 'file=@localfilename' -F “ignoreEncryption=true” -X 'overwrite=true/false'
削除/purgeLog
このAPIは、デプロイメントログをパージするために使用されます。
パラメーター
名前 |
説明 |
パラメータータイプ |
データタイプ |
ids |
プランID |
query |
string |
beginy |
ログの開始時間 |
query |
string |
end |
ログの終了時刻 |
query |
string |
例
curl -X DELETE -u admin:admin "http://localhost:9400/rest/deploy/purgeLog" -H "begin:0" -H "end:2408386295553"
GET /validateSite
このAPIは、サイト情報を検証するために使用されます。
パラメーター:
名前 |
説明 |
パラメータータイプ |
データタイプ |
siteName |
サイトの名前 |
query |
string |
例
curl -X GET -u admin:admin "http://localhost:9400/rest/deploy/validateSite?siteName=sourceSite"