47 SSA管理REST API

この章では、SSA管理機能のためのクラウドREST APIおよびサービス・テンプレートREST APIの詳細について説明します。

この章では、PaasZone管理およびSoftwarePool管理のREST APIに加えて、REST APIカタログ、REST API出力およびメタデータのフェッチに使用するその他のREST APIと、リソースの展開について説明します。

この章ではまた、Enterprise Manager Self Serviceアプリケーションの管理ユーザーによるPaaSインフラストラクチャ・ゾーン操作、ソフトウェア・プール操作およびサービス・テンプレート操作に使用可能な、Enterprise Managerコマンドライン・インタフェース(EMCLI)動詞の詳細も説明します。EMCLIにより、各種オペレーティング・システムのテキスト・ベースのコンソール(シェルおよびコマンド・ウィンドウ)からEnterprise Manager Cloud Control機能にアクセスできます。

セルフ・サービス・ポータル・アプリケーションのREST APIは、一般にSSAユーザーによって使用されます。これらのREST APIは、一般に.../ssa/...の形式です。たとえば、/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/などです。管理機能のREST API (.../admin/...形式)は、ゾーンやテンプレートの作成など、一般にクラウドまたはSSAの管理者によって実行されるSSAポータル設定を構成するREST APIです。この章では、管理REST APIについて説明します。

この章の内容は、次のとおりです。

• V2のSSA管理REST APIのサマリー
• V1のSSA管理REST APIのサマリー
• V1およびV2のカタログAPI
• V2のリソース・プロバイダ
  • リソース・プロバイダ - V2のコレクション・リソース
  • リソース・プロバイダ - V2の単一リソース
• サービス・テンプレート群 - V2のコレクション・リソース
• V2のサービス・タイプ
• V2のサービス・リクエスト
• V2のサービス・インスタンス
• V2のリクエスト設定
• V2のVMアダプタ
• V1のSSA管理リソース
• V1のPaasZones
• V1のPaasZone
• V1のSoftwarePools
• V1のSoftwarePool
• V1のコンポジット・リソース属性
  • V1のValueDescriptor
  • V1のValueEntity
  • V1のEntityValueHolder
  • V1のPoolEntityCapacity
  • V1のResourceTypeCapacity
• V1のサービス・テンプレート管理
  • V1のサービス・テンプレート
  • V1のサービス・テンプレート
  • V1のServiceTemplateUpdate
  • V1のServiceExecutableMetaEntity
  • V1のテンプレート構成パラメータ
  • V1のPayloadDescriptor
  • V1のServiceTemplateメタデータ
  • V1のPayloadMetaData
  • V1のServiceTemplateメタデータ
• セルフ・サービス・アプリケーション用のEM CLI動詞
  • V2のSSA操作用のEM CLI動詞
  • V1のSSA操作用のEM CLI動詞

V2のSSA管理REST APIのサマリー

次の表に、v2フレームワークについてこの章で説明するすべてのユーザー・プリファレンスおよびリクエスト・スケジュールREST APIをまとめています。

表47-1 V2のSSA管理REST APIのサマリー

リソース	データ・モデル	GET	POST	PUT	DELETE
カタログAPI	表47-3	V1およびV2の上位レベルのカタログAPIの表示 V2カタログAPIの表示 V2カタログ・ユーザーAPIの表示 V2カタログ管理APIの表示	サポート対象外	サポート対象外	サポート対象外
リソース・プロバイダ	表47-10	すべてのリソース・プロバイダの表示 リソース・プロバイダのすべてのタイプの表示 リソース・プロバイダ・タイプ・メタデータの表示 PaaSインフラストラクチャ・ゾーンを作成するためのメタデータの表示 スキーマ・プールを作成するためのメタデータの表示 リソース・プロバイダの詳細の表示 リソース・プロバイダの構成の表示 リソース・プロバイダのメトリックの表示	リソース・プロバイダの作成 PaaSインフラストラクチャ・ゾーン・リソース・プロバイダの作成 データベース・スキーマ・プールの作成 アダプタ・インスタンスの作成 リソース・プロバイダ・ターゲットのフィルタ処理 サンプル・アダプタを使用したリソースのプロビジョニング リソース・プロバイダのプロビジョニングに必要なメタデータの表示	リソース・プロバイダの更新	リソース・プロバイダの削除 リソースのプロビジョニング解除
サービス・テンプレート	表47-36	すべてのサービス・テンプレートの表示 すべてのサービス・テンプレート・タイプの表示 サービス・テンプレートの作成に必要なメタデータの表示 サービス・テンプレートの作成に必要なリソース・プロバイダ特性の表示 サービス・テンプレートの作成に必要な構成の表示 特定のサービス・テンプレートの詳細の表示 特定のサービス・テンプレートの構成詳細の表示	サービス・テンプレートの作成	サービス・テンプレートの更新	サービス・テンプレートの削除
サービス・タイプ	表47-57	サービス・タイプの詳細の表示	使用不可	使用不可	使用不可
サービス・リクエスト	表47-59	すべてのサービス・リクエストの詳細の表示 サービス・リクエストの詳細の表示	サポート対象外	サービス・リクエストの再スケジュール	サービス・リクエストの取消し サービス・リクエストのリストの削除
サービス・インスタンス	表47-67	すべてのサービス・インスタンスの詳細の表示 サービス・インスタンスの詳細の表示	サポート対象外	サービス・インスタンスの起動 サービス・インスタンスの停止 サービス・インスタンスの削除 サービス・インスタンスのリストの開始 サービス・インスタンスのリストの停止 サービス・インスタンスのリストの削除	サポート対象外
リクエスト設定	表47-77	グローバル・リクエスト設定の詳細の表示 ロールのコレクションのグローバル・リクエスト設定の詳細の表示 特定のロールのグローバル・リクエスト設定の詳細の表示 サービス・ファミリのリクエスト設定の詳細の表示 ロール別のサービス・ファミリ設定の詳細の表示 特定のロールのサービス・ファミリ・リクエスト設定の詳細の表示 サービス・タイプのリクエスト設定の詳細の表示 ロール別のサービス・タイプ設定の詳細の表示 特定のロールのサービス・タイプ・リクエスト設定の詳細の表示	ロールのグローバル・リクエスト設定の作成 ロールのサービス・ファミリ設定の作成 ロールのサービス・タイプ設定の作成	グローバル・リクエスト設定の更新 特定のロールのグローバル・リクエスト設定の更新 サービス・ファミリのリクエスト設定の更新 特定のロールのサービス・ファミリ・リクエスト設定の更新 サービス・タイプのリクエスト設定の更新 特定のロールのサービス・タイプ・リクエスト設定の更新	特定のロールのグローバル・リクエスト設定の削除 特定のロールのサービス・ファミリ・リクエスト設定の削除 特定のロールのサービス・タイプ・リクエスト設定の削除
VMアダプタ	表47-100	すべての登録済VMアダプタの詳細の表示 特定の登録済VMアダプタの詳細の表示 ステージング・サーバーの詳細の表示	ステージング・サーバーの作成	サポート対象外	サポート対象外

ノート:

この表の「サポート」は、リソースに対してその操作がサポートされていることを示します。ただし、この章には操作の例は含まれません。

V1のSSA管理REST APIのサマリー

次の表に、v2フレームワークについてこの章で説明するすべてのユーザー・プリファレンスおよびリクエスト・スケジュールREST APIをまとめています。

表47-2 V1のSSA管理REST APIのサマリー

リソース	データ・モデル	GET	POST	PUT	DELETE
カタログAPI	表47-3	V1カタログAPIの表示 SSAポータルのV1カタログAPIの表示	サポート対象外	サポート対象外	サポート対象外
APIエントリ・ポイント・リソース	表47-106	REST APIエントリ・ポイント・リソースの詳細の表示	サポート対象外	サポート対象外	サポート対象外
PaaSゾーン群	表47-108	PaaSゾーン群メタデータの表示 PaaSゾーン群のリスト	サポート対象外	サポート対象外	サポート対象外
PaaSゾーン	表47-112	PaasZoneの詳細の表示 PaasZoneからの展開形式の表示	PaaSゾーンの作成	PaaSゾーンの更新	PaaSゾーンの削除
ソフトウェア・プール群	表47-119	ソフトウェア・プール群の詳細の表示 検索問合せパラメータに基づくフィルタリング出力	サポート対象外	サポート対象外	サポート対象外
ソフトウェア・プール	表47-123	ソフトウェア・プールの詳細の表示 問合せパラメータの展開	ソフトウェア・プールの作成	ソフトウェア・プールの更新	ソフトウェア・プールの削除
ソフトウェア・プール・メタデータ	表47-129	ソフトウェア・プール・メタデータREST APIの取得例	サポート対象外	サポート対象外	サポート対象外
ソフトウェア・プール・フィルタ・ターゲット	表47-131	使用可能なフィルタ処理済ターゲット取得 - REST APIの例	サポート対象外	サポート対象外	サポート対象外
ソフトウェア・プール容量	表47-133	ソフトウェア・プール容量の取得	サポート対象外	サポート対象外	サポート対象外
コンポジット・リソース属性	V1のコンポジット・リソース属性	サポート対象外	サポート対象外	サポート対象外	サポート対象外
サービス・テンプレート	表47-140	サービス・テンプレートのメタデータの表示	サービス・テンプレートの構成値の作成	サポート対象外	サポート対象外
サービス・テンプレート	表47-143	サービス・テンプレートの詳細の表示	サービス・テンプレートの作成	サービス・テンプレートの更新	サービス・テンプレートの削除

ノート:

この表の「サポート」は、リソースに対してその操作がサポートされていることを示します。ただし、この章には操作の例は含まれません。

V1およびV2のカタログAPI

カタログAPIは、cfwプラグインに存在するすべてのREST APIの概要を示します。これらすべては、各REST APIに関する説明と情報を含むGET REST APIです。

REST APIは、v1 REST APIとv2 REST APIに大きく分類されています。v1 REST APIは、既存のv1カタログREST APIを意味します。v2 REST APIは、SSAユーザーREST APIと管理者REST APIの両方の概要のサマリーを提供します。

表47-3 Cfw APIカタログ・コレクション・データ・モデル

フィールド	データ型	説明	発生
name	文字列	このコレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプ。	1
hasMore	ブール値	コレクションに他の要素があるかどうかを示します。	1
count	整数	返される要素の数。	1
items	コレクション<CfwRestAPICatalog>	Cfw APIカタログ・リソースのリスト。インスタンスが存在しない場合、itemsフィールドは空になります。	1
totalResults	整数	Cfw APIカタログ・リソースの総数。	1
canonicalLink	URI	このURIに対してGETリクエストを実行すると、このリソースのクライアント表現がリフレッシュされます。	1

CFW APIカタログREST APIの例

この項では、Cfw APIカタログ・リソースのREST APIについて説明します。この項では、次の操作について説明します。

• V1およびV2の上位レベルのカタログAPIの表示

• V1カタログAPIの表示

• V2カタログAPIの表示

• SSAポータルのV1カタログAPIの表示

• V2カタログ・ユーザーAPIの表示

• V2カタログ管理APIの表示

V1およびV2の上位レベルのカタログAPIの表示

上位レベル・カタログAPIを表示するためのGETリクエスト構成を次に示します。

表47-4 上位レベル・カタログAPIを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/cfw/API
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"items":[
{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API/v1",
"description":"API Summary for version V1"
},
{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API/v2",
"description":"API Summary for version V2"
}
],
"totalResults":2
}

V1カタログAPIの表示

v1カタログAPIを表示するためのGETリクエスト構成を次に示します。

表47-5 V1カタログAPIを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/cfw/API/v1
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"items":[
{
"href":"cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/API",
"description":"APIs for Self Service Application for version V1",
"type":"SSA"
},
{
"href":"cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/API",
"description":"APIs for Administrative functions for version V1",
"type":"Admin"
}
],
"goBack":"cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API",
"totalResults":2
}

V2カタログAPIの表示

v2カタログAPIを表示するためのGETリクエスト構成を次に示します。

表47-6 V2カタログAPIを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/API/v2
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"items":[{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/API",
"description":"APIs for Self Service Application for version V2",
"type":"SSA"
},
{
"href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/API",
"description":"APIs for administrative functions for version V2",
"type":"Admin"
} ],
"goBack":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/cfw/API",
"totalResults":2
}

SSAポータルのV1カタログAPIの表示

SSAポータルのv1カタログAPIを表示するためのGETリクエスト構成を次に示します。

表47-7 SSAポータルのV1カタログAPIを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/API/
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"v1":{
"canonicalLink":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1",
"serviceRequests":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1
/servicerequests",
"userPreferences":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1
/mypreferences"
}
}

V2カタログ・ユーザーAPIの表示

v2エンドポイントは、エンティティに応じてグループ化されるv2側ユーザーREST APIのさらに調整された概要を提供します。たとえば、REST APIに関連するすべてのサービス・インスタンスは、entity=serviceinstancesに対してまとめてリストされます。

変数入力を持つREST APIは、属性templatedと中カッコでマークされます。

v2カタログ・ユーザーAPIを表示するためのGETリクエスト構成を次に示します。

表47-8 V2カタログ・ユーザーAPIを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/user/ssa/v2/API
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"items": [
{
"totalResults": 5,
"resource": "services",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services",
"method": "GET",
"description": "Get all the service offerings"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services",
"method": "POST",
"description": "Create a service"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{
id}",
"method": "GET",
"templated": true,
"description": "Get details of a service"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{
id}/metadata",
"method": "GET",
"templated": true,
"description": "Get the metadata for a service"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{
id}/metrics",
"method": "PUT",
"templated": true,
"description": "Get the metrics for a service"
}
]
},
{
"totalResults": 11,
"resource": "userpreferences",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences",
"method": "GET"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/general",
"method": "GET",
"description": "Get the general user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/general/metadata",
"method": "GET",
"description": "Get the metadata for general user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services",
"method": "GET",
"description": "Get the service user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}",
"method": "GET",
"templated": true,
"description": "Get the user preferences for a service family"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/metadata",
"method": "GET",
"templated": true,
"description": "Get the metadata for user preference at family level"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/{service-type}",
"method": "GET",
"templated": true,
"description": "Get the user preferences for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/{service-type}/metadata",
"method": "GET",
"templated": true,
"description": "Get the metadata for user preference at service type level"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/general",
"method": "PUT",
"description": "Update general user preference"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{service-family}",
"method": "PUT",
"templated": true,
"description": "Update family level user preferences"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userprefer
ences/services/{service-family}/{service-type}",
"method": "PUT",
"templated": true,
"description": "Update service type level user preferences"
}
]
},
{
"totalResults": 4,
"resource": "servicerequests",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests",
"method": "GET",
"description": "Get service requests"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests/{id}",
"method": "PUT",
"templated": true,
"description": "Reschedule the request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests/{id}",
"method": "GET",
"templated": true,
"description": "Get the details of request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicereq
uests/{id}",
"method": "DELETE",
"templated": true,
"description": "Delete the request"
}
]
},
{
"totalResults": 5,
"resource": "serviceinstances",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances",
"method": "GET",
"description": "Get the service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}/actions",
"method": "GET",
"templated": true,
"description": "Get actions for a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}/actions/{action-id}",
"method": "GET",
"templated": true,
"description": "Get metadata details of action"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceins
tances/{id}/actions/{action-id}",
"method": "PUT",
"templated": true,
"description": "Perform the action on the service instance"
}
]
}
],
"goBack": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/API",
"totalResults": 4
}

V2カタログ管理APIの表示

v2エンドポイントは、エンティティに応じてグループ化されるv2側管理REST APIのさらに調整された概要を提供します。たとえば、REST APIに関連するすべてのサービス・インスタンスは、entity=serviceinstancesに対してまとめてリストされます。

変数入力を持つREST APIは、属性templatedと中カッコでマークされます。

v2カタログ管理APIを表示するためのGETリクエスト構成を次に示します。

表47-9 V2カタログ管理APIを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/API
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"items": [
{
"totalResults": 6,
"resource": "resourceproviders",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers",
"method": "GET",
"description": "Get all the resource providers"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers",
"method": "POST",
"description": "Create/Add a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}",
"method": "DELETE",
"templated": true,
"description": "Delete/Remove a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}",
"method": "PUT",
"templated": true,
"description": "Edit a resource provider"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resource
providers/{id}/metrics",
"method": "GET",
"templated": true,
"description": "Get metrics for a resource provider"
}
]
},
{
"totalResults": 3,
"resource": "servicetemplates",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicet
emplates",
"method": "GET",
"description": "Get all service templates"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicet
emplates",
"method": "POST",
"description": "Create a service template"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicet
emplates/{id}",
"method": "PUT",
"templated": true,
"description": "Edit a service template"
}
]
},
{
"totalResults": 4,
"resource": "settings",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/general",
"method": "GET",
"description": "Get all general settings"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/general",
"method": "PUT",
"description": "Update general settings"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/service/{service-type}",
"method": "GET",
"templated": true,
"description": "Get all settings for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/settings
/service/{service-type}",
"method": "PUT",
"templated": true,
"description": "Update settings for a service type"
}
]
},
{
"totalResults": 5,
"resource": "instancesizes",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes",
"method": "GET",
"description": "Get all instance sizes"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}",
"method": "GET",
"templated": true,
"description": "Get all instance sizes for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}/metadata",
"method": "GET",
"templated": true,
"description": "Get metada for instance sizes for a service type"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}/{instance-name}",
"method": "GET",
"templated": true,
"description": "Get details of an instance size"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/instance
sizes/service/{service-type}/{instance-name}",
"method": "PUT",
"templated": true
}
]
},
{
"totalResults": 5,
"resource": "servicerequests",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests",
"method": "GET",
"description": "Get all requests"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests/{id}",
"method": "PUT",
"templated": true,
"description": "Reschedule a request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests/{id}",
"method": "DELETE",
"templated": true,
"description": "Delete a request"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicer
equests",
"method": "DELETE",
"description": "Delete bulk requests"
}
]
},
{
"totalResults": 12,
"resource": "serviceinstances",
"APIs": [
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances",
"method": "GET",
"description": "Get all service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}",
"method": "GET",
"templated": true,
"description": "Get details of a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/actions",
"method": "GET",
"templated": true,
"description": "Get all the actions on a service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/actions/{action-id}",
"method": "GET",
"templated": true,
"description": "Get the details of action"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/actions/{action-id}",
"method": "PUT",
"templated": true,
"description": "Perform the action on the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/start",
"method": "PUT",
"templated": true,
"description": "Start the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/stop",
"method": "PUT",
"templated": true,
"description": "Stop the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/{id}/delete",
"method": "PUT",
"templated": true,
"description": "Delete the service instance"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances",
"method": "DELETE",
"description": "Delete service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/start",
"method": "PUT",
"description": "Start multiple service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/stop",
"method": "PUT",
"description": "Stop multiple service instances"
},
{
"href":
"https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicei
nstances/delete",
"method": "PUT",
"description": "Delete multiple service instances"
}
]
}
],
"goBack": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/API",
"totalResults": 6
}

V2のリソース・プロバイダ

リソース・プロバイダは、管理を簡単にするためのリソース・グループを提供します。

リソース・プロバイダは、サービス・タイプのサービス・インスタンスのプロビジョニングに必要なリソースのタイプを表す、コンポジット・ターゲットです。たとえば、データベース・サービス・タイプはそのリソース・プロバイダにoracle_homeターゲットを必要とし、スキーマ・サービス・タイプはそのリソース・プロバイダにoracle_databaseおよびoracle_racターゲットを必要とします。

リソース・プロバイダ - V2のコレクション・リソース

リソース・プロバイダは、すべてのアクセス可能なリソース・プロバイダ・リソースのクラウド管理者ビューを表すコレクション・リソースです。次の表では、リソース・プロバイダ・データ・モデルについて説明します。

表47-10 リソース・プロバイダ・データ・モデル

フィールド	データ型	説明	発生
name	文字列	このコレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプ。	1
hasMore	ブール値	コレクションに他の要素があるかどうかを示します。	1
count	整数	返される要素の数。	1
items	コレクション<ResourceProvider>	リソース・プロバイダ・リソースのリスト。インスタンスが存在しない場合、itemsフィールドは空になります。	1
totalCount	整数	リソース・プロバイダ・リソースの総数。	1
canonicalLink	URI	このURIに対してGETリクエストを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

リソース・プロバイダ - V2の単一リソース

リソース・プロバイダ・クラウド・リソースは、リソース・プロバイダのインスタンスを表します。次の表では、リソース・プロバイダ・データ・モデルについて説明します。

表47-11 リソース・プロバイダ・データ・モデル

フィールド	データ型	説明	発生
name	文字列	リソース・プロバイダに指定された判読可能な名前。このフィールドは編集できません。	1
displayName	文字列	リソース・プロバイダの表示名。	0..1
guid	文字列	リソースを識別するリソース・プロバイダの一意のGUID。	1
説明	文字列	リソースの短い説明。	0..1
targetType	文字列	作成するリソース・プロバイダのターゲット・タイプ。例: サンプルのxaasリソース・プロバイダの場合はcfw_samplexaas_rsrc_provider。	1
Members		リソース・プロバイダのメンバー。これらは、あらかじめEMターゲットとして追加する必要があります。	1
credentials	コレクション<ResourceProviderCredential>	リソース・プロバイダに関連付けられている資格証明。	1
placementConstraints	コレクション<EntityValueHolder>	クラウド管理者がリソース使用率の上限を設定できるようにする、リソース・プロバイダの配置制約。	0..1
characteristics	コレクション<EntityValueHolder>	リソース・プロバイダに関連付けられている特性。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1

リソース・プロバイダ・リソースでサポートされるメソッド

次の表に、リソース・プロバイダの単一リソースでサポートされるメソッドを示します。

表47-12 リソース・プロバイダでサポートされるメソッド

リクエスト・メソッド	正規のリンク	説明
GET	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders	リソース・プロバイダのリストを返します。
GET	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/types	リソース・プロバイダ・タイプを返します。
POST	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders	リソース・プロバイダのインスタンスを作成します。
POST	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/filteredtargets	フィルタを適用したターゲットを返します。 表47-13および表47-14を参照してください。
GET	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/types/{resourceprovidertype}	リソース・プロバイダ・タイプ・メタデータを返します。 表47-15を参照してください
GET	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}	指定されたリソース・プロバイダの詳細を返します。 表47-16および表47-17を参照してください。
PUT	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}	指定されたリソース・プロバイダを更新します。
DELETE	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}	指定されたリソース・プロバイダを削除します。
GET	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceprovderid}/configuration	リソース・プロバイダの保存済構成を返します。
GET	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}/metrics	指定されたリソース・プロバイダのメトリックを返します。
POST	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}/members	リソースをプロビジョニングします。
DELETE	em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}/members	リソースをプロビジョニング解除します。
POST	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}/members/metadata	リソースのプロビジョニングに必要なプロビジョニング・メタデータを返します。

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/filteredtargetsに対するPOSTリクエストでサポートされる、フィルタ処理されたターゲット・リクエスト・データ・モデルを示します。

表47-13 フィルタ処理されたターゲット・リクエスト・データ・モデル

フィールド	データ型	説明	出現回数
type	文字列	リソース・プロバイダのタイプ。	1
membertargetType	文字列	メンバーのターゲット・タイプ。	0..1
parentResourceProviderId	文字列	親リソース・プロバイダのタイプ。	0..1

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/filteredtargetsに対するPOSTリクエストでサポートされる、フィルタ処理されたターゲット・レスポンス・データ・モデルを示します。

表47-14 フィルタ処理されたターゲット・レスポンス・データ・モデル

フィールド	データ型	説明
membertargetType	文字列	メンバーのターゲット・タイプ。
リスト<文字列>	文字列	ターゲットのリスト。

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/types/{resourceprovidertype}に対するGETリクエストでサポートされるリソース・プロバイダ・メタデータ・データ・モデルを示します。

表47-15 リソース・プロバイダ・メタデータ・データ・モデル

フィールド	データ型	説明
type	文字列	リソース・プロバイダのタイプ。
memberTargetTypes	リスト<文字列>	メンバー・ターゲット・タイプのリスト。
parentResourceProviderType	文字列	親リソース・プロバイダ・タイプ。
isInfrastructureProvider	ブール値	インフラストラクチャ・プロバイダが存在するかどうか。
placementPolicyName	文字列	配置ポリシーを示します。
credentials	リスト<Credential>	資格証明を示します。
placementConstraints	リスト<CfwSimpleValueEntity>	配置制約を示します。
characteristics	リスト<CfwSimpleValueEntity>	特性を示します。

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}に対するGETリクエストでサポートされる資格証明データ・モデルを示します。

表47-16 資格証明データ・モデル

フィールド	データ型	説明
name	文字列	資格証明の名前。
value	文字列	資格証明のタイプ。

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}に対するGETリクエストでサポートされるCFW単純値エンティティ・データ・モデルを示します。

表47-17 CFW単純値エンティティ・データ・モデル

フィールド	データ型	説明
name	文字列	名前。
value	リスト<文字列>	文字列のリスト。

リソース・プロバイダREST APIの例

この項では、リソース・プロバイダに対する操作について説明します。この項では、次の操作について説明します。

• すべてのリソース・プロバイダの表示

• リソース・プロバイダのすべてのタイプの表示

• リソース・プロバイダの作成

• PaaSインフラストラクチャ・ゾーン・リソース・プロバイダの作成

• データベース・スキーマ・プールの作成

• アダプタ・インスタンスの作成

• リソース・プロバイダ・ターゲットのフィルタ処理

• リソース・プロバイダ・タイプ・メタデータの表示

• PaaSインフラストラクチャ・ゾーンを作成するためのメタデータの表示

• スキーマ・プールを作成するためのメタデータの表示

• リソース・プロバイダの詳細の表示

• リソース・プロバイダの更新

• リソース・プロバイダの削除

• リソース・プロバイダの構成の表示

• リソース・プロバイダのメトリックの表示

• サンプル・アダプタを使用したリソースのプロビジョニング

• リソースのプロビジョニング解除

• リソース・プロバイダのプロビジョニングに必要なメタデータの表示

すべてのリソース・プロバイダの表示

すべてのリソース・プロバイダを表示するには、GET操作を発行します。

表47-18 すべてのリソース・プロバイダを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"name": "Resource Providers",
"type": "Resource Provider",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/"
},
"cfwItems": [
{
"id": "1",
"name": "MyPaasZone",
"type": "self_service_zone",
"guid": "AC3D1D12E0A0AB1B28C377ED691E9E98",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/1"
}
},
{
"id": "2",
"name": "MyXaasProvider",
"type": "cfw_samplexaas_rsrc_provider",
"guid": "20CC7F446482F477BED8336489852A4B",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/2"
}
},
{
"id": "3",
"name": "MyXaasPool",
"type": "cfw_samplexaas_rsrc_pool",
"guid": "FEF39B5F2A0C518283F7A5E781EE8C8B",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/3"
}
},
{
"id": "4",
"name": "MyWebLogicProvider",
"type": "mwaas_zone",
"guid": "425AA08582AD7AE95D52C24662867315",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/4"
}
},
{
"id": "21",
"name": "MySchemaPool",
"type": "schaas_pool",
"guid": "446AD900E64F525149A3B1D79E0037AC",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/21"
}
}
],
"totalResults": 5
}

リソース・プロバイダのすべてのタイプの表示

リソース・プロバイダのすべてのタイプを表示するには、GET操作を発行します。

表47-19 リソース・プロバイダのすべてのタイプを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/types
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"name" : "Resource Provider Types",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s"
},
"cfwItems" : [ {
"type" : "cfw_samplexaas_rsrc_pool",
"displayName" : "CFW XaaS Test Rsrc Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/cfw_samplexaas_rsrc_pool"
}
}, {
"type" : "cfw_samplexaas_rsrc_provider",
"displayName" : "CFW XaaS Test Rsrc Provider",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/cfw_samplexaas_rsrc_provider"
}
}, {
"type" : "cfw_samplexaas_rsrcprov_no_member",
"displayName" : "CFW XaaS Test Rsrc With No Member",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/cfw_samplexaas_rsrcprov_no_member"
}
}, {
"type" : "mwaas_zone",
"displayName" : "Middleware Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/mwaas_zone"
}
}, {
"type" : "oracle_cloud_zone",
"displayName" : "Database Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/oracle_cloud_zone"
}
}, {
"type" : "oracle_nimbula_site",
"displayName" : "Oracle Nimbula Site",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
5.6 67
s/oracle_nimbula_site"
}
}, {
"type" : "pdbaas_pool",
"displayName" : "Pluggable Database Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/pdbaas_pool"
}
}, {
"type" : "schaas_pool",
"displayName" : "Schema Pool",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/schaas_pool"
}
}, {
"type" : "self_service_zone",
"displayName" : "PaaS Infrastructure Zone",
"canonicalLink" : {
"href" :
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/type
s/self_service_zone"
}
} ],
"totalResults" : 0
}

リソース・プロバイダの作成

次の表に、リソース・プロバイダを作成するためのPOST構成を示します。

表47-20 リソース・プロバイダを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "My Xaas Provider_200", "characteristics": [ { "name": "example.sysman.cfw.samplexaas.storagetype", "value": [ "file", "db" ] } ], "memberTargetType": "cfw_samplexaas_rsrc", "members": [ "Sample7" ], "placementConstraints": [ { "name": "NUMBER_OF_SERVICE_INSTANCES", "value": "20" } ], "type": "cfw_samplexaas_rsrc_provider", "useExistingTarget": false, "memberConstraints": [ { "name": "ORACLE.SYSMAN.CFW.LOCATION", "values": [ "us-east" ] }, { "name": "ORACLE.SYSMAN.SAMPLEXAAS.STORAGETYPE", "values": [ "file" ] } ] }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"message": "Resource Provider with name \"My Xaas Provider_200\" and type
\"cfw_samplexaas_rsrc_provider\" created successfully.",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/24"
}
}

PaaSインフラストラクチャ・ゾーン・リソース・プロバイダの作成

次の表に、PaaSインフラストラクチャ・ゾーン・リソース・プロバイダを作成するためのPOST構成を示します。

表47-21 PaaSインフラストラクチャ・ゾーン・リソース・プロバイダを作成するためのPOSTリクエスト構成

機能	仕様
URI	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "useExistingTarget" :false, "name" :"MyPaasZone02", "type" :"self_service_zone", "memberTargetType" :"host", "members": [ "yourhost1.yourcompany.com" ], "credentials": [ { "name": "normal_credential_guid", "value": "VGSINGH" } ], "placementConstraints": [ { "name": "MAX_CPU_UTILIZATION", "value": [ "80" ] }, { "name": "MAX_MEMORY_ALLOCATION", "value": [ "80" ] } ], "memberConstraints": [] }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{ "message" : "ResourceProvider with name \"MyPaasZone02\" and type \"self_service_zone\" created successfully.",
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/41" }}

データベース・スキーマ・プールの作成

次の表に、データベース・スキーマ・プールを作成するためのPOST構成を示します。

表47-22 データベース・スキーマ・プールを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name" : "MyDBSchemaPool", "useExistingTarget" : false, "type" : "schaas_pool", "description" : "MyDatabaseSchemaPool", "memberTargetType" : "oracle_database", "members" : [ "Oemrep_Database" ], "parentResourceProviderId" : "1", "credentials" : [ { "name" : "host_credential_guid", "value" : "VGSINGH" } ], "placementConstraints" : [ { "name" : "MAX_SERVICES", "value" : [ "100" ] }, { "name" : "MAX_CPU_USAGE", "value" : [ "0" ] }, { "name" : "MAX_MEMORY_USAGE", "value" : [ "0" ] }, { "name" : "USE_WORKLOAD", "value" : [ "false" ] }, { "name" : "ENFORCE_CPU", "value" : [ "false" ] } ], "memberConstraints" : [ { "name" : "ORACLE.SYSMAN.SSA.CONFIGURATION", "value" : [ "oracle_database" ] }, { "name" : "ORACLE.SYSMAN.CFW.PLATFORM", "value" : [ "226" ] }, { "name" : "ORACLE.SYSMAN.CFW.VERSION", "value" : [ "11.2.0.3.0" ] } ], "characteristics" : [ { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_CONTACT", "value" : [ "[e-mail]" ] }, { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER", "value" : [ "GTB" ] }, { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT", "value" : [ "ST" ] }, { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS", "value" : [ "Development" ] }, { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS", "value" : [ "LOB" ] }, { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_LOCATION", "value" : [ "EAST" ] }, { "name" : "ORACLE.SYSMAN.CFW.ORCL_GTP_SITE", "value" : [ "LOCAL" ] } ]}
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{ "message" : "ResourceProvider with name \"MyDBSchemaPool\" and type \"schaas_pool\" created successfully.",
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/61" }}

アダプタ・インスタンスの作成

次の表に、サンプル・アダプタ・インスタンスを作成するためのPOST構成を示します。

表47-23 アダプタ・インスタンスを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ name" : "MySmplVMAdapter_0409123048", "type" : "iaas_adapter", "placementConstraints" : [ { "name" : "MAX_VM_INSTANCES", "value" : "10" } ], "vmadapter" : { "name" : "SAMPLEADAPTER", "paaszone" : "MyPaasZone", "connection" : { "endpoints" : [ { "purpose" : "login_url", "url" : "/login_url/example", "username" : "ssa_user", "password" : "ssa_passwd", "domain" : "domain", "custom" : [ { "name" : "CloudType", "value" : "CloudTypeVal" }, { "name" : "custom_param1", "value" : "custom_param1Val" } ] } ], "virtualizationContainers" : [ { "name" : "Zone" } ] }, "useproxies" : [ "testnm" ], "stagingservers" : { "location" : "script/location", "credentialGuid" : "25D30ADD427484310DBC8CF6211A383B" } }}
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{ "message" : "ResourceProvider with name \"MySmplVMAdapter_0409123047\" and type \"iaas_adapter\" created successfully.",
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/63" }}

リソース・プロバイダ・ターゲットのフィルタ処理

システム内のリソース・プロバイダ・ターゲットをフィルタ処理するには、リソース・プロバイダ・コレクション・リソースに対してPOST操作を発行します。

表47-24 リソース・プロバイダ・ターゲットをフィルタ処理するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/filteredtargets
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "type": "self_service_zone", "memberTargetType": "cfw_samplexaas_rsrc" }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/filt
eredtargets"
},
"targets": [
"Sample10",
"Sample1",
"Sample3",
"Sample2",
"Sample5",
"Sample4",
"Sample7",
"Sample6",
"Sample9",
"Sample8"
],
"memberTargetType": "cfw_samplexaas_rsrc"
}

リソース・プロバイダ・タイプ・メタデータの表示

リソース・プロバイダ・タイプ・メタデータを表示するには、GET操作を発行します。

表47-25 リソース・プロバイダ・タイプ・メタデータを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/types/{resourceprovidertype}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"type" : "mwaas_zone",
"memberTargetTypes" : [ "host" ],
"parentResourceProviderType" : "self_service_zone",
"placementPolicyName" : "First_Pick",
"placementConstraints" : [ {
"name" : "MAX_INSTANCES",
"displayName" : "Maximum Number of WebLogic Servers (per host)",
"description" : "Maximum Number of WebLogic Servers (per host)",
"valueType" : "INTEGER",
"operator" : "eq"
} ],
"characteristics" : [ {
"name" : "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.BASEINSTALLDIR",
"displayName" : "Middleware Home Base Directory",
"description" : "All Oracle Homes would be created from this Base Install Directory.",
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : false
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_CONTACT",
"displayName" : "Contact",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER",
"displayName" : "Cost Center",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT",
"displayName" : "Department",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS",
"displayName" : "Lifecycle Status",
"description" : null,
"isComposite" : false,
"possibleValues" : [ "Development", "MissionCritical", "Production", "Stage", "Test" ],
5.15 76
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS",
"displayName" : "Line of Business",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LOCATION",
"displayName" : "Location",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : false,
"isUnique" : true
}, {
"name" : "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ASHAREDHOME",
"displayName" : "Shared Oracle Home",
"description" : "When set to Yes, all Hosts in this MW Pool would use this Shared Home even if
other Oracle Homes present on these Hosts. Otherwise, Oracle Home on each Host will be used.",
"isComposite" : false,
"possibleValues" : [ "0", "1" ],
"isMandatory" : false,
"isUnique" : false
}, {
"name" : "EXAMPLE.SYSMAN.EMAS.MWAAS_ZONE",
"displayName" : "oracle.sysman.emas.mwaas_zone",
"description" : null,
"isComposite" : false,
"possibleValues" : [ ],
"isMandatory" : true,
"isUnique" : true
} ],
"memberConstraints" : [ {
"name" : "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.PLATFORM",
"displayName" : "Operating System and Platform",
"description" : null,
"isComposite" : false,
"possibleValues" : [ "197", "59", "212", "209", "46", "226", "912", "208", "233", "23", "267" ]
} ]
}

PaaSインフラストラクチャ・ゾーンを作成するためのメタデータの表示

PaaSインフラストラクチャ・ゾーンを作成するためのメタデータを表示するには、GET操作を発行します。

表47-26 PaaSインフラストラクチャ・ゾーン作成用のメタデータを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/self_service_zone
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{ "type": "self_service_zone",
"memberTargetTypes": [ "host" ], 
"placementConstraints": [
 { "name": "MAX_MEMORY_ALLOCATION",
 "displayName": "MaximumMemoryAllocation(%)",
 "description": "MaximumMemoryAllocation constraint per host in a paas infrastructure zone",
 "valueType": "INTEGER",
 "operator": "eq" },
 { "name": "MAX_CPU_UTILIZATION",
 "displayName": "MaximumCPUUtilization(%)", 
 "description": "MaximumCPU utilization(%) constraint for a physical resource 
provider",
 "valueType": "INTEGER",
 "operator": "eq" } ],
"characteristics": [ { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_CONTACT",
"displayName": "Contact", 
"description": null,
"isComposite": false,
"possibleValues": [],
"isUnique": true, 
"isMandatory": false },
{ "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER",
"displayName": "CostCenter",
"description": null,
"isComposite": false, 
"possibleValues": [],
"isUnique": true, 
"isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT",
 "displayName": "Department", 
"description": null, 
"isComposite": false,
 "possibleValues": [],
 "isUnique": true, 
"isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS", 
"displayName": "LifecycleStatus",
 "description": null,
 "isComposite": false, 
"possibleValues": [ "Development", "MissionCritical",
 "Production", "Stage", "Test" ],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS",
 "displayName": "Line ofBusiness", 
"description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LOCATION",
 "displayName": "Location",
 "description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_SITE",
 "displayName": "Site",
 "description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.SELF_SERVICE_ZONE",
 "displayName": "oracle.sysman.cfw.self_service_zone",
 "description": null,
 "isComposite": false,
 "possibleValues": [],
 "isUnique": true,
 "isMandatory": true } ],
 "credentials": [ { "name": "normal_credential_guid",
 "displayName": "Host credentials", 
"description": "HostCredentials to be used for provisioning in thisPaaSInfrastructureZone.The credentials provided should be of global credential type (valid across the members in the zone) and owned by the current user",
 "authenticatingTargetType":
 "host", "isMandatory": true } ],
 "memberConstraints": []}

スキーマ・プールを作成するためのメタデータの表示

スキーマ・プールを作成するためのメタデータを表示するには、GET操作を発行します。

表47-27 スキーマ・プール作成用のメタデータを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/schaas_pool
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{ "type": "schaas_pool",
 "memberTargetTypes": [ "oracle_database", "rac_database" ],
 "parentResourceProviderType": "self_service_zone",
 "placementPolicyName": "First_Pick",
 "placementConstraints": [ { "name": "ENFORCE_CPU", "displayName": "EnableResourceManager forCPU", "description": "Whether to enable resource manager which can be used to createConsumerGroups.", "valueType": "BOOLEAN", "operator": "eq" },
 { "name": "MAX_CPU_USAGE", "displayName": "MaximumCPU allocation (%)", "description": "Defines the maximum limit of theCPU permissible for each database, beyond which a service request can not be placed.", "valueType": "INTEGER", "operator": "eq" },
 { "name": "USE_WORKLOAD", "displayName": "Associate workload with the request", "description": "Whether to associate workload with the request which represents the expectedCPU, memory and storage requirements for each service.", "valueType": "BOOLEAN", "operator": "eq" },
 { "name": "MAX_SERVICES", "displayName": "MaximumNumber of database services", "description": "Maximum number of services per database.", "valueType": "INTEGER", "operator": "eq" },
 { "name": "MAX_MEMORY_USAGE", "displayName": "Maximum memory allocation (%)", "description": "Memory represents the summation ofSystemGlobalArea (SGA) allocated for each database.", "valueType": "INTEGER", "operator": "eq" } ],
 "characteristics": [ { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_CONTACT", "displayName": "Contact", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER", "displayName": "CostCenter", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT", "displayName": "Department", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS", "displayName": "LifecycleStatus", "description": null, "isComposite": false, "possibleValues": [ "Development", "MissionCritical", "Production", "Stage", "Test" ], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS", "displayName": "Line ofBusiness", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_LOCATION", "displayName": "Location", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.CFW.ORCL_GTP_SITE", "displayName": "Site", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": false },
 { "name": "ORACLE.SYSMAN.SSA.SCHAAS_POOL", "displayName": "oracle.sysman.ssa.schaas_pool", "description": null, "isComposite": false, "possibleValues": [], "isUnique": true, "isMandatory": true } ],
 "credentials": [ { "name": "gi_credential_guid", "displayName": "GridInfrastructureCredentials", "description": "GridInfrastructure credentials are optional.", "authenticatingTargetType": "host", "isMandatory": false },
 { "name": "database_credential_guid", "displayName": "DatabaseCredentials", "description": "The database credentials that will be used for performing database operations like schema creation.The database credentials requireSYSDBA privileges.", "authenticatingTargetType": "oracle_database", "isMandatory": false },
 { "name": "host_credential_guid", "displayName": "HostCredentials", "description": "Host credentials to be specified that will be used to perform instance creation operations.", "authenticatingTargetType": "host", "isMandatory": true } ],
 "memberConstraints": [ { "name": "ORACLE.SYSMAN.SSA.CONFIGURATION", "displayName": "DatabaseConfiguration", "description": "DatabaseConfiguration of the resource provider member.", "isComposite": false, "possibleValues": [ "rac_database", "oracle_database" ] },
 { "name": "ORACLE.SYSMAN.CFW.PLATFORM", "displayName": "Platform", "description": "Platform", "isComposite": false, "possibleValues": [ "197", "59", "212", "209", "46", "226", "912", "208", "233", "23", "267" ] },
 { "name": "ORACLE.SYSMAN.CFW.VERSION", "displayName": "Version", "description": "Version", "isComposite": false, "possibleValues": [ "10.2.0.1.0", "10.2.0.2.0", "10.2.0.3.0", "10.2.0.4.0", "10.2.0.5.0", "11.1.0.6.0", "11.1.0.7.0", "11.2.0.1.0", "11.2.0.2.0", "11.2.0.3.0", "11.2.0.4.0", "12.1.0.1.0", "12.1.0.2.0" ] } ]}

リソース・プロバイダの詳細の表示

リソース・プロバイダの詳細を表示するには、GET操作を発行します。

表47-28 リソース・プロバイダの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"name": "My Xaas Provider_001",
"type": "cfw_samplexaas_rsrc_provider",
"memberTargetType": "cfw_samplexaas_rsrc",
"members": [
"Sample2"
],
"credentials": [],
"placementConstraints": [
{
"name": "NUMBER_OF_SERVICE_INSTANCES",
"value": [
"20"
]
},
{
"name": "TEST_CONSTRAINT_WITH_STRING_VALUE",
"value": [
"\"string_value\""
]
}
],
"memberConstraints": [],
"characteristics": [
{
"name": "ORACLE.SYSMAN.SXAAS.CFW_SAMPLEXAAS_RSRC_PROVIDER",
"value": [
"C277DA7F0CB329507172B4C44E0A6DF9"
]
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/22"
}
}

リソース・プロバイダの更新

システム内のリソース・プロバイダの既存のインスタンスを更新するには、リソース・プロバイダ・リソースに対してPUT操作を発行します。

表47-29 リソース・プロバイダを更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "placementConstraints": [{"name": " NUMBER_OF_SERVICE_INSTANCES ", "value": "70"}], }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

Status 200 OK
{
message: "Resource Provider with ID "121" updated successfully."
}

リソース・プロバイダの削除

DELETEリクエスト構成を次の表に示します。

表47-30 リソース・プロバイダを削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"message":"Resource Provider with ID \"21\" deleted successfully."
}

リソース・プロバイダの構成の表示

リソース・プロバイダの構成を表示するためのGETリクエスト構成を次に示します。

表47-31 リソース・プロバイダの構成を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/4/configurations
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
  "hosts" : {
    "configurations" : [ {
      "name" : "vm_networks",
      "type" : "VECTOR",
      "description" : "Network.",
      "displayName" : "vm_networks",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "platform",
      "type" : "STRING",
      "value" : "",
      "displayName" : "platform",
      "required" : false,
      "secret" : false
    }, {
      "name" : "hostPrefix",
      "type" : "STRING",
      "description" : "Host Name Prefix.",
      "value" : "rest_",
      "displayName" : "Host Name Prefix",
      "required" : false,
      "secret" : false
    }, {
      "name" : "postInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "cluster_storages",
      "type" : "VECTOR",
      "description" : "Cluster Storage.",
      "displayName" : "cluster_storages",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_base",
      "type" : "STRING",
      "description" : "Agent Install Base Directory Location",
      "value" : "bsl",
      "displayName" : "Installation Base Directory",
      "required" : false,
      "secret" : false
    }, {
      "name" : "cluster_networks",
      "type" : "VECTOR",
      "description" : "Cluster Network",
      "displayName" : "cluster_networks",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "resourceProviderId",
      "type" : "STRING",
      "value" : "1",
      "displayName" : "resourceProviderId",
      "required" : false,
      "secret" : false
    }, {
      "name" : "postInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_install_creds",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "15513B9C0C6E4EB9E053CE74B10A171B",
      "displayName" : "Named Credential",
      "required" : false,
      "secret" : false
    }, {
      "name" : "priv_delegation_setting",
      "type" : "STRING",
      "value" : "/usr/bin/sudo -u %RUNAS% %COMMAND%",
      "displayName" : "priv_delegation_setting",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_instance_sizes",
      "type" : "VECTOR",
      "description" : "Instance Size.",
      "displayName" : "vm_instance_sizes",
      "values" : [ "EXTRA_LARGE" ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_port",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "3872",
      "displayName" : "Port",
      "required" : false,
      "secret" : false
    }, {
      "name" : "preInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "custom_params",
      "type" : "VECTOR",
      "description" : "Custom parameters for VM configuration.",
      "displayName" : "custom_params",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_server_templates",
      "type" : "VECTOR",
      "description" : "Server Template.",
      "displayName" : "vm_server_templates",
      "values" : [ "paas-tmpl" ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "preInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "numberOfHost",
      "type" : "STRING",
      "description" : "Number Of Host",
      "value" : "3",
      "displayName" : "Number Of Host",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_storages",
      "type" : "VECTOR",
      "description" : "Storage.",
      "displayName" : "vm_storages",
      "values" : [ ],
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPreInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPreInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPostInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPostInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    } ]
  },
  "swprovisioning" : {
    "configurations" : [ {
      "name" : "resourceProviderId",
      "type" : "STRING",
      "value" : "1",
      "displayName" : "resourceProviderId",
      "required" : false,
      "secret" : false
    } ]
  }
}

リソース・プロバイダのメトリックの表示

リソース・プロバイダのメトリックを表示するためのGETリクエスト構成を次に示します。

表47-32 リソース・プロバイダのメトリックを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/21/metrics
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
count: "0"
hasMore: "false"
limit: "0"
offset: "0"
totalResults: "0"
metricColumns: [6]
0: {
name: "services"
}-
1: {
name: "sample"
}-
2: {
name: "memory"
}-
3: {
name: "storageStatus"
}-
4: {
name: "cpu"
}-
5: {
name: "storage"
}-
}

サンプル・アダプタを使用したリソースのプロビジョニング

次の表に、リソースをプロビジョニングするためのPOST構成を示します。

表47-33 サンプル・アダプタを使用してリソースをプロビジョニングするためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}/members
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "saveOnly" : false, "setDefault" : true, "hosts" : { "templateGuid" : "13462942A66F0B2DE053CE74B10AFCC2", "configurations" : [ { "name" : "hostPrefix", "value" : "rest_" }, { "name" : "numberOfHost", "value" : "5" }, { "name" : "agent_install_creds", "value" : "131EFD3114423E7AE053CE74B10A5A76" }, { "name" : "agent_base", "value" : "bsl" }, { "name" : "priv_delegation_setting", "value" : "/usr/bin/sudo -u %RUNAS% %COMMAND%" }, { "name" : "agent_port", "value" : "3872" }, { "name" : "priv_delegation_setting_template_name", "value" : "" }, { "name" : "network_purpose_vm", "subvalues" : [ { "name" : "Public", "value" : "192.168.1.0/24" } ] }, { "name" : "storage_purpose_cluster", "subvalues" : [ { "name" : "Shared", "value" : "smisko_0" } ] }, { "name" : "storage_purpose_vm", "subvalues" : [ { "name" : "Dedicated", "value" : "smisko_0" } ] }, { "name" : "network_purpose_cluster", "subvalues" : [ { "name" : "ClusterPrivate", "value" : "192.168.1.0/24" }, { "name" : "ClusterPublic", "value" : "192.168.1.0/24" } ] }, { "name" : "vm_instance_sizes", "values" : [ "EXTRA_LARGE" ] }, { "name" : "vm_server_templates", "values" : [ "paas-tmpl" ] } ] }, "swprovisioning" : { "configurations" : [ { "name" : "param01", "value" : "param_01_val" }, { "name" : "param01", "value" : "param_02_val" } ] }}
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{ "status" : "SCHEDULED", "details" : "134821EBDA7472BFE053CE74B10A11B8"}

リソースのプロビジョニング解除

リソースをプロビジョニング解除するためのDELETEリクエスト構成を次に示します。

表47-34 リソースをプロビジョニング解除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/{resourceproviderid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{"members":["rest_-bf51c965-fff0-400c-a982-2c71b2afb150","rest_-13ce4c70-e1b4-4bd9-8b43-6952d619e674"]}
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

{ "details": "133C8EC6EAC86122E053CE74B10A4DEF", "status": "SCHEDULED"}

リソース・プロバイダのプロビジョニングに必要なメタデータの表示

リソース・プロバイダのプロビジョニングに必要なメタデータを表示するためのPOSTリクエスト構成を次に示します。

表47-35 リソース・プロバイダのプロビジョニングに必要なメタデータを表示するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/4/members/metadata
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "hosts" : { "templateGuid" : "1552104D74F47F29E053CE74B10A08D9" }}
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
  "hosts" : {
    "templateGuid" : "1552104D74F47F29E053CE74B10A08D9",
    "configurations" : [ {
      "name" : "platform",
      "type" : "STRING",
      "value" : "",
      "displayName" : "platform",
      "required" : false,
      "secret" : false
    }, {
      "name" : "hostPrefix",
      "type" : "STRING",
      "description" : "Host Name Prefix.",
      "value" : "MySmplAdptr0505013358",
      "displayName" : "Host Name Prefix",
      "required" : false,
      "secret" : false
    }, {
      "name" : "network_purpose_vm",
      "type" : "VECTOR",
      "description" : "Purpose Network Instance",
      "displayName" : "network_purpose_vm",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "192.168.1.0/25",
        "displayName" : "192.168.1.0/25"
      }, {
        "value" : "192.168.1.0/24",
        "displayName" : "192.168.1.0/24"
      }, {
        "value" : "192.168.1.0/26",
        "displayName" : "192.168.1.0/26"
      }, {
        "value" : "192.168.1.0/27",
        "displayName" : "192.168.1.0/27"
      } ],
      "subvalues" : [ {
        "name" : "Public",
        "type" : "STRING",
        "displayName" : "Public",
        "required" : true,
        "secret" : false
      } ]
    }, {
      "name" : "postInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "storage_purpose_cluster",
      "type" : "VECTOR",
      "description" : "Purpose Storage Cluster",
      "displayName" : "storage_purpose_cluster",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "smisko_3",
        "displayName" : "smisko_3"
      }, {
        "value" : "smisko_2",
        "displayName" : "smisko_2"
      }, {
        "value" : "smisko_1",
        "displayName" : "smisko_1"
      }, {
        "value" : "smisko_0",
        "displayName" : "smisko_0"
      } ],
      "subvalues" : [ ]
    }, {
      "name" : "network_purpose_cluster",
      "type" : "VECTOR",
      "description" : "Purpose Network Cluster",
      "displayName" : "network_purpose_cluster",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "192.168.1.0/25",
        "displayName" : "192.168.1.0/25"
      }, {
        "value" : "192.168.1.0/24",
        "displayName" : "192.168.1.0/24"
      }, {
        "value" : "192.168.1.0/26",
        "displayName" : "192.168.1.0/26"
      }, {
        "value" : "192.168.1.0/27",
        "displayName" : "192.168.1.0/27"
      } ],
      "subvalues" : [ ]
    }, {
      "name" : "agent_base",
      "type" : "STRING",
      "description" : "Agent Install Base Directory Location",
      "value" : "/scratch/oracle/",
      "displayName" : "Installation Base Directory",
      "required" : false,
      "secret" : false
    }, {
      "name" : "resourceProviderId",
      "type" : "STRING",
      "value" : "1",
      "displayName" : "resourceProviderId",
      "required" : false,
      "secret" : false
    }, {
      "name" : "postInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "postInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "agent_install_creds",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "15513B9C0C6E4EB9E053CE74B10A171B",
      "displayName" : "Named Credential",
      "required" : false,
      "secret" : false
    }, {
      "name" : "storage_purpose_vm",
      "type" : "VECTOR",
      "description" : "Purpose Storage Instance",
      "displayName" : "storage_purpose_vm",
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "smisko_3",
        "displayName" : "smisko_3"
      }, {
        "value" : "smisko_2",
        "displayName" : "smisko_2"
      }, {
        "value" : "smisko_1",
        "displayName" : "smisko_1"
      }, {
        "value" : "smisko_0",
        "displayName" : "smisko_0"
      } ],
      "subvalues" : [ {
        "name" : "Dedicated",
        "type" : "STRING",
        "displayName" : "Dedicated",
        "required" : true,
        "secret" : false
      } ]
    }, {
      "name" : "priv_delegation_setting",
      "type" : "STRING",
      "value" : "/usr/bin/sudo -u %RUNAS% %COMMAND%",
      "displayName" : "priv_delegation_setting",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_instance_sizes",
      "type" : "VECTOR",
      "description" : "Instance Size.",
      "displayName" : "vm_instance_sizes",
      "values" : [ "EXTRA_LARGE", "TINY", "SMALL" ],
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "TINY",
        "displayName" : "TINY"
      }, {
        "value" : "EXTRA_LARGE",
        "displayName" : "EXTRA_LARGE"
      }, {
        "value" : "SMALL",
        "displayName" : "SMALL"
      } ]
    }, {
      "name" : "agent_port",
      "type" : "STRING",
      "description" : "Agent Port",
      "value" : "3872",
      "displayName" : "Port",
      "required" : false,
      "secret" : false
    }, {
      "name" : "preInstallScript",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScript",
      "required" : false,
      "secret" : false
    }, {
      "name" : "vm_server_templates",
      "type" : "VECTOR",
      "description" : "Server Template.",
      "displayName" : "vm_server_templates",
      "values" : [ "paas-tmpl", "paas-tmpl2" ],
      "required" : false,
      "secret" : false,
      "possibleValues" : [ {
        "value" : "paas-tmpl",
        "displayName" : "paas-tmpl"
      }, {
        "value" : "paas-tmpl2",
        "displayName" : "paas-tmpl2"
      } ]
    }, {
      "name" : "preInstallScriptOnOMS",
      "type" : "STRING",
      "value" : "",
      "displayName" : "preInstallScriptOnOMS",
      "required" : false,
      "secret" : false
    }, {
      "name" : "numberOfHost",
      "type" : "STRING",
      "description" : "Number Of Host",
      "value" : "",
      "displayName" : "Number Of Host",
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPreInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPreInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    }, {
      "name" : "runPostInstallScriptAsRoot",
      "type" : "STRING",
      "value" : "",
      "displayName" : "runPostInstallScriptAsRoot",
      "required" : false,
      "secret" : false
    } ]
  },
  "swprovisioning" : {
    "configurations" : [ ]
  }
}

サービス・テンプレート群 - V2のコレクション・リソース

サービス・テンプレートは、すべてのアクセス可能なサービス・テンプレート・リソースのSSA管理者ビューを表すコレクション・リソースです。次の表では、サービス・テンプレート・データ・モデルについて説明します。

表47-36 サービス・テンプレート群コレクション・リソース・データ・モデル

フィールド	データ型	説明	発生
name	文字列	コレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプを示します。	0..1
hasMore	ブール値	コレクションに他の要素があるかどうかを示します。	1
count	整数	返される要素の数。	1
items	コレクション<ServiceTemplate>	サービス・テンプレート・リソースのリスト。インスタンスが存在しない場合、itemsフィールドは空になります。	1
totalCount	整数	サービス・テンプレート・リソースの合計数。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

サポートされる操作

次の表に、サービス・テンプレート群に対してサポートされる操作を示します。

表47-37 サービス・テンプレートでサポートされるメソッド

リクエスト・メソッド	正規のリンク	説明
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates	サービス・テンプレート群のリストを返します。
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/templatetypes	サービス・テンプレート・タイプを返します。 表47-38を参照してください。
POST	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadata	サービス・テンプレートの作成に必要なメタデータを返します。 関連項目: 表47-39 表47-40 表47-41 表47-42 表47-43
POST	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/resourceproviders	サービス・テンプレートの作成に必要なリソース・プロバイダ特性を返します。 表47-44および表47-45を参照してください。
POST	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/configurations	サービス・テンプレートの作成に必要な構成を返します。 表47-46を参照してください。
POST	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates	サービス・テンプレートを作成します。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}	サービス・テンプレートを更新します。
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}	指定されたサービス・テンプレートの詳細を返します。
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}/configurations	指定されたサービス・テンプレートの構成詳細を返します。
DELETE	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}	指定されたサービス・テンプレートを削除します。

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/templatetypesに対するGETリクエストでサポートされるSRVCテンプレート・タイプ・データ・モデルを示します。

表47-38 SRVCテンプレート・タイプ・データ・モデル

フィールド	データ型	説明
serviceTemplateTypeId	文字列	サービス・テンプレート・タイプのID。
serviceType	文字列	サービス・タイプの名前。
name	文字列	サービス・テンプレート・タイプの名前。
displayName	文字列	サービス・テンプレート・タイプの表示名

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadataに対するPOSTリクエストでサポートされるSRVCテンプレート・メタデータ・リクエスト・データ・モデルを示します。

表47-39 SRVCテンプレート・メタデータ・リクエスト・データ・モデル

フィールド	データ型	説明	発生
serviceTemplateTypeId	文字列	サービス・テンプレート・タイプのID。	1
serviceType	文字列	サービス・タイプの名前。	1

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadataに対するPOSTリクエストでサポートされるSRVCテンプレート・メタデータ・レスポンス・データ・モデルを示します。

表47-40 SRVCテンプレート・メタデータ・レスポンス・データ・モデル

フィールド	データ型	説明
serviceTemplateTypeId	文字列	サービス・テンプレート・タイプのID。
rscProvAssocOption	リスト<文字列>	リソース・プロバイダ・アソシエーション。
payloads	リスト<Payload>	サービス・テンプレートのペイロード。
selectedExecutableName	CfwValueDescriptor	サービス・テンプレート・タイプ詳細。
characteristics	リスト<Characteristic>	サービス・テンプレートの特性のリスト。

次の表に、v2フレームワークのURI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadataに対するPOSTリクエストでサポートされるペイロード・データ・モデルを示します。

表47-41 ペイロード・データ・モデル

フィールド	データ型	説明
name	文字列	ペイロードの名前。
value	リスト<文字列>	値リスト。
required	ブール値	必須かどうか。

次の表に、v2フレームワークのURI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadataに対するPOSTリクエストでサポートされる特性データ・モデルを示します。

表47-42 特性データ・モデル

フィールド	データ型	説明
name	文字列	特性の名前。
displayName	文字列	特性の表示名。
values	リスト<文字列>	値リスト。
required	ブール値	必須かどうか。
editable	ブール値	編集可能かどうか。
visible	ブール値	表示可能かどうか。
targetType	TargetType	特性がTarget Characteristicsの場合、このフィールドにはターゲット・タイプの詳細が含まれます。

次の表に、v2フレームワークのURI - /em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadataに対するPOSTリクエストでサポートされるターゲット・タイプ・データ・モデルを示します。

表47-43 ターゲット・タイプ・データ・モデル

フィールド	データ型	説明
targetType	文字列	ターゲット・タイプ。
targetTypeName	文字列	ターゲット・タイプの名前。
parentTargetType	文字列	親ターゲット・タイプ。
parentTargetTypeName	文字列	親ターゲット・タイプの名前。

次の表に、v2フレームワークのURI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/resourceprovidersに対するPOSTリクエストでサポートされるSrvcTemplateRscPrvdrRequestデータ・モデルを示します。

表47-44 SrvcTemplateRscPrvdrRequestデータ・モデル

フィールド	データ型	説明	発生
serviceTemplateTypeId	文字列	サービス・テンプレート・タイプのID。	1
serviceType	文字列	サービス・タイプの名前。	1
rscProvAssocOption	リスト<文字列>	リソース・プロバイダ・アソシエーション。	1
payloads	リスト<Payload>>	サービス・テンプレートのペイロード。	0..1
characteristics	リスト<Characteristic>>	サービス・テンプレートの特性。	0..1

次の表に、v2フレームワークのURI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/resourceprovidersに対するPOSTリクエストでサポートされるSrvcTemplateRscPrvdrレスポンス・データ・モデルを示します。

表47-45 SrvcTemplateRscPrvdrレスポンス・データ・モデル

フィールド	データ型	説明
lookupCharacteristics	リスト<SrvcTemplatePurpose>	目的特性のリスト。

次の表に、v2フレームワークのURI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/configurationsに対するPOSTリクエストでサポートされるSrvcTemplateConfigRequestデータ・モデルを示します。

表47-46 SrvcTemplateConfigRequestデータ・モデル

フィールド	データ型	説明	発生
serviceTemplateTypeId	文字列	サービス・テンプレート・タイプのID。	1
serviceType	文字列	サービス・タイプの名前。	1
rscProvAssocOption	リスト<文字列>	リソース・プロバイダ・アソシエーション。	1
payloads	リスト<Payload>>	サービス・テンプレートのペイロード。	0..1
characteristics	リスト<Characteristic>>	サービス・テンプレートの特性。	0..1
resourceProvider	SrvcTemplateRscprvdr	リソース・プロバイダ。	1

V2のサービス・テンプレートREST APIの例

この項では、サービス・テンプレート・リソースでサポートされるREST API操作について説明します。次の操作について説明します。

• すべてのサービス・テンプレートの表示

• すべてのサービス・テンプレート・タイプの表示

• サービス・テンプレートの作成に必要なメタデータの表示

• サービス・テンプレートの作成に必要なリソース・プロバイダ特性の表示

• サービス・テンプレートの作成に必要な構成の表示

• サービス・テンプレートの作成

• サービス・テンプレートの更新

• 特定のサービス・テンプレートの詳細の表示

• 特定のサービス・テンプレートの構成詳細の表示

• サービス・テンプレートの削除

すべてのサービス・テンプレートの表示

すべてのサービス・テンプレートを表示するには、GET操作を発行します。

表47-47 すべてのサービス・テンプレートを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"name": "Service Templates",
"type": "Service Template",
"totalResults": 3,
"cfwItems": [
{
"id": "1",
"name": "Orchestration",
"guid": "06F28ABA2E0178CBE053CE74B10AAC2D",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/1"
},
"description": "Create a set of Oracle VM instances with customized configuration for multitier
applications"
},
{
"id": "2",
"name": "Simple Orchestration",
"guid": "06F28ABA2E0478CBE053CE74B10AAC2D",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/2"
},
"description": "Create one or more Oracle VM instances with default configuration and minimum
inputs"
},
{
"id": "3",
"name": "VM Instance",
"guid": "06F28ABA2E0778CBE053CE74B10AAC2D",
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/3"
},
"description": "Create an Oracle VM Instance"
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/"
},
"selfLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/"
}
}

すべてのサービス・テンプレート・タイプの表示

すべてのサービス・テンプレート・タイプを表示するには、GET操作を発行します。

表47-48 すべてのサービス・テンプレート・タイプを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/templatetypes
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

[
{
"name": "SCHEMA",
"displayName": "SchaaS Create Executable",
"serviceType": "SCHEMA",
"serviceTemplateTypeId": "61"
},
{
"name": "MW_SOAAAS_CREATE_INSTANCE",
"displayName": "SOAaaS Orchestration",
"serviceType": "SOA_SERVICE",
"serviceTemplateTypeId": "24"
},
{
"name": "MW_WLAAS_EXECUTABLE_CREATE",
"displayName": "WebLogic Service - Physical",
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28"
},
{
"name": "MW_OSBAAS_CREATE_INSTANCE",
"displayName": "OSBaaS Orchestration",
"serviceType": "OSB_SERVICE",
"serviceTemplateTypeId": "21"
},
{
"name": "DB",
"displayName": "DbaaS Create Executable",
"serviceType": "DB",
"serviceTemplateTypeId": "41"
},
{
"name": "PDB",
"displayName": "PdbaaS Create Executable",
"serviceType": "PDB",
"serviceTemplateTypeId": "54"
},
{
"name": "ORACLE_NIMBULA_CREATE_SIMPLE_ORCHESTRATION_EXECUTABLE",
"displayName": "Simple Orchestration Custom Service Template",
"serviceType": "ORACLE_NIMBULA_ORCHESTRATION_SERVICE",
"serviceTemplateTypeId": "3"
},
{
"name": "ORACLE_NIMBULA_CREATE_ORCHESTRATION_EXECUTABLE",
"displayName": "Orchestration Custom Service Template",
"serviceType": "ORACLE_NIMBULA_ORCHESTRATION_SERVICE",
"serviceTemplateTypeId": "1"
},
{
"name": "ORACLE_NIMBULA_CREATE_VIRTUAL_MACHINE_EXECUTABLE",
"displayName": "ORACLE_NIMBULA_CREATE_VIRTUAL_MACHINE_EXECUTABLE",
"serviceType": "ORACLE_NIMBULA_VIRTUAL_MACHINE_SERVICE",
"serviceTemplateTypeId": "11"
}
]

サービス・テンプレートの作成に必要なメタデータの表示

サービス・テンプレートの作成に必要なメタデータを表示するには、POST操作を発行します。

表47-49 サービス・テンプレートの作成に必要なメタデータを表示するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadata
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "serviceType": "WLAAS", "serviceTemplateTypeId": "28" }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"serviceType": "WLAAS",
"serviceTemplateTypeId": "28",
"rscProvAssocOption": [
"byRscLookupChars"
],
"selectedExecutableName": {
"name": "MW_WLAAS_EXECUTABLE_CREATE",
"type": "STRING",
"value": "MwaaS_Setup_Domain_Deploy_App",
"defaultValue": "MwaaS_Setup_Domain_Deploy_App",
"required": true,
"secret": false
},
"payloads": [
{
"name": "DEFAULT_PAYLOAD",
"value": "<user_input>",
"required": true
}
],
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLEHA",
"displayName": "Distribute WebLogic Servers on Available Hosts?",
"values": [
"No",
"Yes"
],
"required": false,
"visible": true,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLELBR",
"displayName": "Enable Load Balancer?",
"values": [
"No",
"Yes"
],
"required": false,
"visible": true,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.EXPOSEADMINURLS",
"displayName": "Expose WebLogic Admin Console and Fusion Middleware Control to SSA
User?",
"values": [
"No",
"Yes"
],
"required": false,
"visible": true,
"editable": true
}
]
}

サービス・テンプレートの作成に必要なリソース・プロバイダ特性の表示

サービス・テンプレートの作成に必要なリソース・プロバイダ特性を表示するには、POST操作を発行します。

表47-50 サービス・テンプレートの作成に必要なリソース・プロバイダ特性を表示するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/resourceproviders
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "serviceType": "WLAAS", "serviceTemplateTypeId": "28", "rscProvAssocOption": [ "byRscLookupChars" ], "payloads": [ { "name": "DEFAULT_PAYLOAD", "value": "test" } ], "characteristics": [ { "name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLEHA", "value":"Yes" }, { "name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.ENABLELBR", "value":"Yes" }, { "name": "EXAMPLE.SYSMAN.EMAS.MWC.WLAAS.EXPOSEADMINURLS", "value": "Yes" } ] }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"lookupCharacteristics": [
{
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.EMAS.MWAAS_ZONE",
"displayName": "example.sysman.emas.mwaas_zone",
"targetType": {
"targetType": "mwaas_zone",
"parentTargetType": "self_service_zone",
"targetTypeName": "Middleware Pool",
"parentTargetTypeName": "PaaS Infrastructure Zone"
}
}
],
"purposeId": 1
}
]
}

サービス・テンプレートの作成に必要な構成の表示

サービス・テンプレートの作成に必要な構成を表示するには、POST操作を発行します。

表47-51 サービス・テンプレートの作成に必要な構成を表示するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/configurations
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "serviceType": "WLAAS", "serviceTemplateTypeId": "28", "rscProvAssocOption": [ "byRscLookupChars" ], "payloads": [ { "name": "DEFAULT_PAYLOAD", "value": "test" } ], "characteristics": [ { "name": "ORACLE.SYSMAN.EMAS.MWC.WLAAS.ENABLEHA", "value": "Yes" }, { "name": "ORACLE.SYSMAN.EMAS.MWC.WLAAS.ENABLELBR", "value": "Yes" }, { "name": "ORACLE.SYSMAN.EMAS.MWC.WLAAS.EXPOSEADMINURLS", "value": "Yes" } ], "resourceprovider": { "lookupCharacteristics": [ { "characteristics": [ { "name": "ORACLE.SYSMAN.EMAS.MWAAS_ZONE", "value": "425AA08582AD7AE95D52C24662867315" } ], "purposeId": 1 } ] } }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

[
{
"name": "agentInstallUserPwd",
"type": "STRING",
"description": "Agent Install User Password to override",
"required": false,
"secret": true
},
{
"name": "hostForResourceProvisioningScript",
"type": "STRING",
"description": "Resource management script will be executed on this host.",
"required": false,
"secret": false
},
{
"name": "portRangeStart",
"type": "STRING",
"description": "Lower Bound for choosing Free Ports",
"required": false,
"secret": false
},
{
"name": "wlsUserPassword",
"type": "STRING",
"description": "Password for the WebLogic Server",
"required": false,
"secret": true
},
{
"name": "rootPwd",
"type": "STRING",
"description": "Root Password to override",
"required": false,
"secret": true
},
{
"name": "wlsUserName",
"type": "STRING",
"description": "Username for the WebLogic Server",
"required": false,
"secret": false
},
{
"name": "wlsUserPassword2",
"type": "STRING",
"description": "Re-enter Password for the WebLogic Server",
"required": false,
"secret": true
},
{
"name": "namedHostCredForVirtualFlow",
"type": "STRING",
"description": "Enter name of the host credential to use for provisioning operations",
"required": false,
"secret": false
},
{
"name": "startupArguments",
"type": "STRING",
"description": "Enter memory and java arguments to start the server. Example: -Xms1280m -
Xmx1280m -XX:PermSize=128m -XX:MaxPermSize=256m -
Dweblogic.security.SSL.ignoreHostnameVerification=true",
"required": false,
"secret": false
},
{
"name": "namedCredforHostList",
"type": "STRING",
"description": "This will be used for the above hosts",
"required": false,
"secret": false
},
{
"name": "serviceName",
"type": "STRING",
"description": "Service Instance Name",
"required": true,
"secret": true
},
{
"name": "cpuUsagePerInstance",
"type": "STRING",
"description": "CPU required by each additional instance in percentage",
"required": false,
"secret": false
},
{
"name": "portRangeEnd",
"type": "STRING",
"description": "Upper Bound for choosing Free Ports",
"required": false,
"secret": false
},
{
"name": "memoryUsagePerInstance",
"type": "STRING",
"description": "Memory required by each additional instance in GB",
"required": false,
"secret": false
},
{
"name": "hostListForScripts",
"type": "STRING",
"description": "Use ',' to separate multiple target hosts",
"required": false,
"secret": false
},
{
"name": "topology",
"type": "STRING",
"description": "For physical provisioning it is auto populated based on the profile
selected. For virtual provisioning it is defaulted to 'Single Cluster'. Please change based on the
actual topology of the assembly. ",
"required": false,
"secret": false
},
{
"name": "namedCredforRsrcProvHost",
"type": "STRING",
"description": "Enter the EM Named Credentials to be used for the above host in the \"Host
for Executing Resource Management Script\" field.",
"required": false,
"secret": false
},
{
"name": "isScriptExecuteOnAdminServer",
"type": "STRING",
"description": "Choose 'Yes' to execute scripts on Admin Server host besides the hosts
entered above",
"required": false,
"secret": false
}
]

サービス・テンプレートの作成

サービス・テンプレートを作成するには、POST操作を発行します。

表47-52 サービス・テンプレートを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "SampleXaas Template", "description": "Xaas template", "serviceType": "CFW_SAMPLEXAAS_SERVICE", "serviceTemplateTypeId": "82", "rscProvAssocOption": [ "byRscLookupChars" ], "roles": [ "SSA01", "SSA02", "SSA03", "SSA04", "SSA05" ], "characteristics": [ { "name": "ORACLE.SYSMAN.SAMPLEXAAS.SAMPLEINSTANCETYPE", "values": [ "Cfw_Xaas_DB_Service" ] }, { "name": "ORACLE.SYSMAN.SAMPLEXAAS.STORAGE_OP_BW", "values": [ "10" ] } ], "resourceproviders": { "lookupCharacteristics": [ { "characteristics": [ { "name": "ORACLE.SYSMAN.SAMPLEXAAS.STORAGETYPE", "displayName": "storage_type", "value": "db" } ], "purposeId": 1 } ] }, "configurations": [ { "name": "service_instance_name", "value": "xaas_inst_name" }, { "name": "service_type", "value": "CFW_SAMPLEXAAS_SERVICE" }, { 4.22 48 "name": "service_param2", "value": "p2" }, { "name": "service_param1", "value": "p1" }, { "name": "storage_type", "value": "file" } ] }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

Status 200 OK
{"message": "Service template with id \"0780653DF4C64F83E053CE74B10ABD91\" created successfully."
}

サービス・テンプレートの更新

サービス・テンプレートを更新するには、PUT操作を発行します。

表47-53 サービス・テンプレートを更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "displayName": "updatedDisplayName", "description": "updated via API", "rolesToAdd": [ "SSA04", "SSA05", "SSA06", ], "rolesToRemove": [ "SSA01", "SSA02", "SSA03", ], "configurations": [ { "name": "service_instance_name", "value": "inst_name_${tstmp}" }, { "name": "service_type", "value": "CFW_SAMPLEXAAS_SERVICE" }, { "name": "service_param2", "value": "sp2_up" }, { "name": "service_param1", "value": "sp1_up" }, { "name": "storage_type", "value": "file_up" } ] }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"message": " Service template with id "1" updated successfully."
}

特定のサービス・テンプレートの詳細の表示

特定のサービス・テンプレートの詳細を表示するには、GET操作を発行します。

表47-54 特定のサービス・テンプレートの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"id": "63",
"guid": "0780653DF4C94F83E053CE74B10ABD91",
"name": "SampleXaas Template",
"displayName": "SampleXaas Template",
"description": "Xaas template",
"serviceType": "CFW_SAMPLEXAAS_SERVICE",
"serviceTemplateTypeId": "82",
"createdOn": "2014-11-10T16:52:18Z",
"createdBy": "SYSMAN",
"modifiedOn": "2014-11-10T16:52:18Z",
"owner": "SYSMAN",
"lastModified": "2014-11-10T16:52:18Z",
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_CONTACT",
"displayName": "Contact",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER",
"displayName": "Cost Center",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT",
"displayName": "Department",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.SAMPLEXAAS.SAMPLEINSTANCETYPE",
"displayName": "Instance Type",
"values": [
"Cfw_Xaas_DB_Service"
],
"required": true,
"visible": true,
"editable": false
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS",
"displayName": "Lifecycle Status",
"values": [
"Development",
"MissionCritical",
"Production",
"Stage",
"Test"
],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS",
"displayName": "Line of Business",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.CFW.ORCL_GTP_LOCATION",
"displayName": "Location",
"values": [],
"required": false,
"visible": false,
"editable": true
},
{
"name": "EXAMPLE.SYSMAN.SAMPLEXAAS.STORAGE_OP_BW",
"displayName": "Operation Bandwidth",
"values": [
"10"
],
"required": false,
"visible": true,
"editable": true
}
],
"resourceProvider": {
"lookupCharacteristics": [
{
"characteristics": [
{
"name": "EXAMPLE.SYSMAN.SAMPLEXAAS.STORAGETYPE",
"displayName": "storage_type",
"values": [
"db"
]
}
],
"purposeId": 1
}
]
},
"configurations": [
{
"name": "service_instance_name",
"type": "STRING",
"description": "Specify Instance Name",
"value": "xaas_inst_name",
"required": true,
"secret": false
},
{
"name": "service_type",
"type": "STRING",
"description": "Specify Service type",
"value": "CFW_SAMPLEXAAS_SERVICE",
"required": true,
"secret": false
},
{
"name": "service_param2",
"type": "STRING",
"description": "Service param 2",
"value": "p2",
"required": false,
"secret": false
},
{
"name": "service_param1",
"type": "STRING",
"description": "Service param 1",
"value": "p1",
"required": false,
"secret": false
},
{
"name": "storage_type",
"type": "STRING",
"description": "Specify Storage type",
"value": "file",
"required": true,
"secret": false
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/63"
},
"selfLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/63"
}
}

特定のサービス・テンプレートの構成詳細の表示

特定のサービス・テンプレートの構成詳細を表示するには、GET操作を発行します。

表47-55 特定のサービス・テンプレートの構成詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}/configurations
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

[
{
"name": "service_instance_name",
"type": "STRING",
"description": "Specify Instance Name",
"value": "xaas_inst_name",
"required": true,
"secret": false
},
{
"name": "service_type",
"type": "STRING",
"description": "Specify Service type",
"value": "CFW_SAMPLEXAAS_SERVICE",
"required": true,
"secret": false
},
{
"name": "service_param2",
"type": "STRING",
"description": "Service param 2",
"value": "p2",
"required": false,
"secret": false
},
{
"name": "service_param1",
"type": "STRING",
"description": "Service param 1",
"value": "p1",
"required": false,
"secret": false
},
{
"name": "WorkLoads",
"type": "VECTOR",
"description": "WorkLoad Values",
"required": false,
"secret": false,
"subvalues": [
{
"name": "Small",
"type": "VECTOR",
"description": "Configuration Values for Small WorkLoad",
"required": false,
"secret": false,
"subvalues": [
{
"name": "DEPL_SIZE_IS_DEFAULT_KEY",
"type": "STRING",
"value": "Y",
"required": false,
"secret": false
},
{
"name": "CPU",
"type": "STRING",
"value": "60",
"required": false,
"secret": false
},
{
"name": "MEMORY",
"type": "STRING",
"value": "4048",
"required": false,
"secret": false
},
{
"name": "STORAGE",
"type": "STRING",
"value": "500",
"required": false,
"secret": false
},
{
"name": "XAAS_TEST",
"type": "STRING",
"value": "NONE",
"required": false,
"secret": false
}
]
},
{
"name": "Medium",
"type": "VECTOR",
"description": "Configuration Values for Medium WorkLoad",
"required": false,
"secret": false,
"subvalues": [
{
"name": "DEPL_SIZE_IS_DEFAULT_KEY",
"type": "STRING",
"value": "N",
"required": false,
"secret": false
},
{
"name": "CPU",
"type": "STRING",
"value": "80",
"required": false,
"secret": false
},
{
"name": "MEMORY",
"type": "STRING",
"value": "8088",
"required": false,
"secret": false
},
{
"name": "STORAGE",
"type": "STRING",
"value": "750",
"required": false,
"secret": false
}
]
},
{
"name": "Large",
"type": "VECTOR",
"description": "Configuration Values for Large WorkLoad",
"required": false,
"secret": false,
"subvalues": [
{
"name": "DEPL_SIZE_IS_DEFAULT_KEY",
"type": "STRING",
"value": "Y",
"required": false,
"secret": false
},
{
"name": "CPU",
"type": "STRING",
"value": "60",
"required": false,
"secret": false
},
{
"name": "MEMORY",
"type": "STRING",
"value": "40448",
"required": false,
"secret": false
},
{
"name": "STORAGE",
"type": "STRING",
"value": "500",
"required": false,
"secret": false
}
]
}
]
},
{
"name": "storage_type",
"type": "STRING",
"description": "Specify Storage type",
"value": "file",
"required": true,
"secret": false
}
]

サービス・テンプレートの削除

DELETEリクエスト構成を次の表に示します。

表47-56 サービス・テンプレートを削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/{servicetemplateid}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

{
"message": "Service template with id \"62\" deleted successfully."
}

V2でのサービス・テンプレートの作成

この項では、REST APIを使用してサービス・テンプレートを作成する手順を示します。

次のステップに従って、サービス・テンプレートを作成します。

1. サービス・テンプレート・タイプを識別します。

   URI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/templatetypes/に対してGET操作を実行します。「すべてのサービス・テンプレート・タイプの表示」を参照してください。

   GET操作は、管理者が使用可能なサービス・テンプレート・タイプのリストを返します。必要なサービス・テンプレートのserviceTypeおよびserviceTemplateTypeIdフィールドをノートにとります。

2. 選択したサービス・テンプレート・タイプのメタデータを取得します。

   前のステップのserviceTypeおよびserviceTemplateTypeIdフィールドを使用して、URI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/metadataに対してPOST操作を実行します。「サービス・テンプレートの作成に必要なメタデータの表示」を参照してください。

   POST操作は、サービス・テンプレート特性およびペイロードに関する情報を含むレスポンスを返します。これらのフィールドをノートにとります。次のステップで値を設定する必要があります。

3. 選択したサービス・テンプレート・タイプのリソース・プロバイダ特性を取得します。

   メタデータ・フィールドの値を提供することで、URI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/resourceprovidersに対してPOST操作を実行します。「サービス・テンプレートの作成に必要なリソース・プロバイダ特性の表示」を参照してください。

   POST操作はresourceProvider検索特性を含むレスポンスを返します。詳細をノートにとります。

4. 選択したサービス・テンプレート・タイプの構成詳細を取得します。

   これまでに収集したすべてのフィールドの値とともにペイロードを提供することで、URI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplates/configurationsに対してPOST操作を実行します。「サービス・テンプレートの作成に必要な構成の表示」を参照してください。

   POST操作は、サービス・テンプレートの構成のリストを含むレスポンスを返します。詳細をノートにとります。

5. サービス・テンプレートを作成します。

   これまでに収集したすべてのフィールドの値とともにペイロードを提供することで、URI - https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetemplatesに対してPOST操作を実行します。「サービス・テンプレートの作成」を参照してください。

   POST操作は、構成された値でサービス・テンプレートを作成します。

V2のサービス・タイプ

この項では、v2フレームワークのサービス・タイプについて説明します。

表47-57 サービス・タイプ・リソース・データ・モデル

フィールド	データ型	説明	発生
name	文字列	コレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプ。	1
totalResults	整数	アイテムの総数。	1
cfwItems	リスト<ServiceType>	サービス・タイプのリスト。
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

V2のサービス・タイプREST APIの例

この項では、サービス・タイプ・リソースのREST APIについて説明します。

サービス・タイプの詳細の表示

サービス・タイプ・リソースの詳細を表示するためのGETリクエスト構成。

表47-58 サービス・タイプの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetypes
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"name": "Service Types",
"type": "Service Types Collection",
"totalResults": 3,
"cfwItems": [
{
"name": "CFW_SAMPLEXAAS_REMOTESERVER_SERVICE",
"displayName": "Cfw Sample RemoteServer XaaS",
"serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY",
"targetTypes": [
"Cfw_Xaas_DB_Service"
]
},
{
"name": "CFW_SAMPLEXAAS_SERVICE",
"displayName": "Cfw Sample XaaS",
"serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY",
"targetTypes": [
"Cfw_Xaas_DB_Service",
"cfw_xaas_storage_service"
]
},
{
"name": "CFW_SAMPLEXAAS_SERVICE_FOR_NOMEM",
"displayName": "Cfw Sample XaaS - Other Service",
"serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY",
"targetTypes": [
"Cfw_Xaas_DB_Service_for_nomem"
]
}
],
"canonicalLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetypes"
},
"selfLink": {
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicetypes"
}
}

V2のサービス・リクエスト

この項では、v2フレームワークのサービス・リクエストについて説明します。

表47-59 リクエスト・コレクション・リソース・データ・モデル

フィールド	データ型	説明	発生
name	文字列	コレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプ。	1
hasMore	ブール値	コレクションに他の要素があるかどうかを示します。	1
count	整数	返される要素の数。	1
cfwItems	コレクション<リクエスト>	リクエスト・リソースのリスト。リクエストが存在しない場合、アイテムは空です。	1
totalResults	整数	リクエストの合計数。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

サポートされる操作

次の表に、サービス・リクエスト・リソースでサポートされる操作を示します。

表47-60 サービス・リクエストに対してサポートされるメソッド

リクエスト・メソッド	正規のリンク	説明
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests	すべてのサービス・リクエストのリストを返します。
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/{servicerequestis}	指定されたサービス・リクエストの詳細を返します。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/{servicerequestid}	指定されたサービス・リクエストを再スケジュールします。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests	リクエストのコレクションをクリアします。
DELETE	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/{servicerequestid}	指定されたサービス・リクエストを取り消します。
DELETE	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests	サービス・リクエストのリストを削除します。

V2のサービス・リクエストREST APIの例

この項では、サービス・リクエスト・リソースのREST APIについて説明します。次の操作について説明します。

• すべてのサービス・リクエストの詳細の表示

• サービス・リクエストの詳細の表示

• サービス・リクエストの再スケジュール

• サービス・リクエストのコレクションのクリア

• サービス・リクエストの取消し

• サービス・リクエストのリストの削除

すべてのサービス・リクエストの詳細の表示

すべてのサービス・リクエストの詳細を表示するには、GET操作を発行します。

表47-61 すべてのサービス・リクエストの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
name: "Service Requests"
type: "Service Request"
hasMore: false
count: 1
cfwItems: [
{
name: "Request1_21-Dec-13 17:37:34"
id: 27
startDate: "2013-12-22T01:37:34'Z'PDT"
status: "SCHEDULED"
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts/27"
} ]
totalCount: 1
canonicalLink: {
href:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts"
}
selfLink: {
ref:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts"
}}

サービス・リクエストの詳細の表示

サービス・リクエストの詳細を表示するには、GET操作を発行します。

表47-62 サービス・リクエストの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/27
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
id: "27"
name: "Request1_21-Dec-13 17:37:34"
startDate: "2013-12-22T01:37:34'Z'PDT"
status: "SUCCESS"
serviceFamily:"CFW_SAMPLEXAAS_SERVICEFAMILY"
canonicalLink:
{
href:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicereques
ts/27"
}
}

サービス・リクエストの再スケジュール

サービス・リクエストを再スケジュールするには、PUT操作を発行します。

表47-63 サービス・リクエストを再スケジュールするためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/27
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "startDate":"2014-01-19T08:06:39ZPDT" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"message": "Request 27 rescheduled successfully"
}

サービス・リクエストのコレクションのクリア

サービス・リクエストのコレクションをクリアするには、PUT操作を発行します。

表47-64 サービス・リクエストのコレクションをクリアするためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "action": "cleanup", "ids": [ "22,23" ] }
リクエスト・メソッド	PUT

サービス・リクエストの取消し

サービス・リクエストを取り消すには、DELETE操作を発行します。

表47-65 サービス・リクエストを取り消すためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests/27
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

Status 200 OK
{
"message": "Request 27 cancelled successfully"
}

サービス・リクエストのリストの削除

サービス・リクエストのリストをクリアするには、DELETE操作を発行します。

表47-66 サービス・リクエストをクリアするためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servicerequests
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "ids": [ "2", "4" ] }
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

{
"message": "[\"Request 32 deleted successfully\",\"Request 31 deleted successfully\",\"Request
30 deleted successfully\"]"
}

V2のサービス・インスタンス

サービス・インスタンスは、すべてのアクセス可能なサービス・インスタンスのユーザーのビューを表すコレクション・リソースです。

次の表に、サービス・インスタンス・データ・モデルを示します。

表47-67 サービス・インスタンス・データ・モデル

フィールド	データ型	説明	発生
name	文字列	コレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプ。	1
hasMore	ブール値	コレクションに他の要素があるかどうかを示します。	1
count	整数	返される要素の数。	1
cfwItems	コレクション<ServiceInstances>	サービス・インスタンス・リソースのリスト。サービス・インスタンスが存在しない場合、アイテムは空です。	1
totalResults	整数	サービス・インスタンスの合計数。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

サポートされる操作

次の表に、サービス・インスタンス・リソースでサポートされる操作を示します。

表47-68 サービス・インスタンスに対してサポートされるメソッド

リクエスト・メソッド	正規のリンク	説明
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances	すべてのサービス・インスタンスを返します。
GET	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{serviceinstanceid}	指定されたサービス・インスタンスの詳細を返します。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{instanceguid}/start	指定されたサービス・インスタンスを起動します。
PUT	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{instanceguid}/stop	指定されたサービス・インスタンスを停止します。
PUT	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{instanceguid}/delete	指定されたサービス・インスタンスを削除します。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/start	サービス・インスタンスのリストを開始します。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/stop	サービス・インスタンスのリストを停止します。
PUT	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/delete	サービス・インスタンスのリストを削除します。

V2のサービス・インスタンスREST APIの例

この項では、サービス・インスタンス・リソースのREST APIについて説明します。次の操作について説明します。

• すべてのサービス・インスタンスの詳細の表示

• サービス・インスタンスの詳細の表示

• サービス・インスタンスの起動

• サービス・インスタンスの停止

• サービス・インスタンスの削除

• サービス・インスタンスのリストの開始

• サービス・インスタンスのリストの停止

• サービス・インスタンスのリストの削除

すべてのサービス・インスタンスの詳細の表示

すべてのサービス・インスタンスの詳細を表示するには、GET操作を発行します。

表47-69 すべてのサービス・インスタンスの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
selfLink:
{
href: "em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances"
}
CfwItems: [1]
0: {
guid: "92EB43C3F773F3DF3973C1005C54DC43"
status: "SUCCESS"
serviceType: "CFW_SAMPLEXAAS_SERVICE"
serviceFamily: "CFW_SAMPLEXAAS_SERVICEFAMILY"
name: "dfgdfddd"
canonicalLink: {
href:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/servic
einstances/92EB43C3F773F3DF3973C1005C54DC43"
rel: "Canonical"
templated: false
}
hasMore: false
totalResults: 9
}

サービス・インスタンスの詳細の表示

サービス・インスタンスの詳細を表示するには、GET操作を発行します。

表47-70 サービス・インスタンスの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/92EB43C3F773F3DF3973C1005C54DC43
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
{
guid: "92EB43C3F773F3DF3973C1005C54DC43"
serviceType: "CFW_SAMPLEXAAS_SERVICE"
serviceFamily: "CFW_SAMPLEXAAS_SERVICEFAMILY"
name: "dfgdfddd"
canonicalLink: {
href:
"em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/92EB43C3F773
F3DF3973C1005C54DC43"
}
}

サービス・インスタンスの起動

サービス・インスタンスを起動するには、PUT操作を発行します。

表47-71 サービス・インスタンスを起動するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{instanceguid}/start
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

[
"Request submitted with Request ID : 43"
]

サービス・インスタンスの停止

サービス・インスタンスを停止するには、PUT操作を発行します。

表47-72 サービス・インスタンスを停止するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{instanceguid}/stop
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

[
"Request submitted with Request ID : 44"
]

サービス・インスタンスの削除

サービス・インスタンスを削除するには、PUT操作を発行します。

表47-73 サービス・インスタンスを削除するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/{instanceguid}/delete
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

[
"Request submitted with Request ID : 45"
]

サービス・インスタンスのリストの開始

サービス・インスタンスのリストを開始するには、PUT操作を発行します。

表47-74 サービス・インスタンスのリストを開始するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/start
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "ids": [ "20E46B615DC70027F76A86FEDAC06D17", "8EAF6A882337F154A1B6D890AF00999B", "637B0CE930E36BE5EFFF306BE3E57EFA" ] }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

[
"Request submitted with Request ID : 34",
"Request submitted with Request ID : 35",
"Request submitted with Request ID : 36"
]

サービス・インスタンスのリストの停止

サービス・インスタンスのリストを停止するには、PUT操作を発行します。

表47-75 サービス・インスタンスのリストを停止するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/stop
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "ids": [ "20E46B615DC70027F76A86FEDAC06D17", "8EAF6A882337F154A1B6D890AF00999B", "637B0CE930E36BE5EFFF306BE3E57EFA" ] }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

[
"Request submitted with Request ID : 37",
"Request submitted with Request ID : 38",
"Request submitted with Request ID : 39"
]

サービス・インスタンスのリストの削除

サービス・インスタンスのリストを削除するには、PUT操作を発行します。

表47-76 サービス・インスタンスを削除するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/serviceinstances/delete
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "ids": [ "20E46B615DC70027F76A86FEDAC06D17", "8EAF6A882337F154A1B6D890AF00999B", "637B0CE930E36BE5EFFF306BE3E57EFA" ] }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

[
"Request submitted with Request ID : 40",
"Request submitted with Request ID : 41",
"Request submitted with Request ID : 42"
]

V2のリクエスト設定

設定はSSA管理者によって適用され、リクエスト処理に使用できます。設定は、次のカテゴリに分類されます。

• グローバル設定 - これらは、すべてのサービス・タイプに対して適用できる一般設定です。

• サービス・ファミリ設定 - これらの設定は、サービス・ファミリに固有です。

• サービス・タイプ設定 - これらの設定は、サービス・タイプに固有です。

リクエスト設定データ・モデル

次の表に、リクエスト設定データ・モデルを示します。

表47-77 リクエスト設定データ・モデル

フィールド	データ型	説明	発生
requestSettings	RequestSettings	すべてのサービス・タイプに対して適用できるリクエスト設定。	1
swLibDefaultLocation	文字列	ソフトウェア・ライブラリのデフォルトの場所。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

リクエスト設定コンポジット属性データ・モデル

次の表に、リクエスト設定コンポジット属性データ・モデルを示します。

表47-78 リクエスト設定コンポジット属性データ・モデル

フィールド	データ型	説明	発生
futureReservationPolicy	RequestPolicy	セルフ・サービス・ユーザーがあらかじめリクエストをスケジュールできる日数。	1
requestDurationPolicy	RequestPolicy	セルフ・サービス・ユーザーがサービス・インスタンスを保持できる最長期間(日数)。	1
RequestArchivePolicy	RequestPolicy	セルフ・サービスの作成リクエストが、「完了済」となった後、リポジトリからパージされるまでの期間(日数)。	1

V2のリクエスト設定REST APIの例

この項では、リクエスト設定リソースのREST APIについて説明します。次の操作について説明します。

• グローバル・リクエスト設定の詳細の表示

• グローバル・リクエスト設定の更新

• ロールのコレクションのグローバル・リクエスト設定の詳細の表示

• ロールのグローバル・リクエスト設定の作成

• 特定のロールのグローバル・リクエスト設定の詳細の表示

• 特定のロールのグローバル・リクエスト設定の更新

• 特定のロールのグローバル・リクエスト設定の削除

• サービス・ファミリのリクエスト設定の詳細の表示

• サービス・ファミリのリクエスト設定の更新

• ロール別のサービス・ファミリ設定の詳細の表示

• ロールのサービス・ファミリ設定の作成

• 特定のロールのサービス・ファミリ・リクエスト設定の詳細の表示

• 特定のロールのサービス・ファミリ・リクエスト設定の更新

• 特定のロールのサービス・ファミリ・リクエスト設定の削除

• サービス・タイプのリクエスト設定の詳細の表示

• サービス・タイプのリクエスト設定の更新

• ロール別のサービス・タイプ設定の詳細の表示

• ロールのサービス・タイプ設定の作成

• 特定のロールのサービス・タイプ・リクエスト設定の詳細の表示

• 特定のロールのサービス・タイプ・リクエスト設定の更新

• 特定のロールのサービス・タイプ・リクエスト設定の削除

グローバル・リクエスト設定の詳細の表示

グローバル・リクエスト設定リソースの詳細を表示するには、GET操作を発行します。

表47-79 グローバル・リクエスト設定リソースの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

グローバル・リクエスト設定の更新

グローバル・リクエスト設定リソースを更新するには、PUT操作を発行します。

表47-80 グローバル・リクエスト設定リソースを更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Weeks", "value": "4" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

{
"message": "\"Global\" settings updated successfully."
}

ロールのコレクションのグローバル・リクエスト設定の詳細の表示

ロールのコレクションのグローバル・リクエスト設定の詳細を表示するには、GET操作を発行します。

表47-81 ロールのコレクションに対するグローバル・リクエスト設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global/roles
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"items": [
{
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/
global/roles/SSA01",
"name": "SSA01"
},
{
"href":
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/
global/roles/SSA05",
"name": "SSA05"
}
],
"totalResults": 2
}

ロールのグローバル・リクエスト設定の作成

ロールのグローバル・リクエスト設定を作成するには、POST操作を発行します。

表47-82 ロールのグローバル・リクエスト設定を作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global/roles
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "SERVICE_INSTANCE_USER_SHARE_ALLOWED": { "value": "true" }, "requestSettings": [ { "name": "REQUEST_DURATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Weeks", "value": "4" }, { "name": "REQUEST_ARCHIVE_RETENTION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Hours", "value": "23" }, { "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Days", "value": "21" } ], "role": "TVMCFW_R1" }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"message": "\"Global role \" settings created successfully."
}

特定のロールのグローバル・リクエスト設定の詳細の表示

特定のロールのグローバル・リクエスト設定の詳細を表示するには、GET操作を発行します。

表47-83 特定のロールに対するグローバル・リクエスト設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R1",
"unitOfMeasurement": "Days",
"value": "21"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R1",
"unitOfMeasurement": "Weeks",
"value": "4"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R1",
"unitOfMeasurement": "Hours",
"value": "23"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "true"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "true"
}
]
}

特定のロールのグローバル・リクエスト設定の更新

特定のロールのグローバル・リクエスト設定を更新するには、PUT操作を発行します。

表47-84 特定のロールに対するグローバル・リクエスト設定を更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Years", "value": "75" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

{
"message": "\"Global role \" settings updated successfully."
}

特定のロールのグローバル・リクエスト設定の削除

特定のロールのグローバル・リクエスト設定を削除するには、DELETE操作を発行します。

表47-85 特定のロールに対するグローバル・リクエスト設定を削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/global/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

{
"message": "\"Global role \" settings deleted successfully."
}

サービス・ファミリのリクエスト設定の詳細の表示

サービス・ファミリのリクエスト設定の詳細を表示するには、GET操作を発行します。

表47-86 サービス・ファミリに対するリクエスト設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"family": "cfw_samplexaas_servicefamily",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"unitOfMeasurement": "Days",
"value": "25"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
for which requests can be made",
"displayName": "Request Duration Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
after which archived requests will be automatically deleted by the system",
"displayName": "Request Archive Retention Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "No Restriction"
},
{
"displayName": "Service Instance Sharing With Users Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"displayName": "Service Instance Sharing With Roles Restricted",
"family": "cfw_samplexaas_servicefamily",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

サービス・ファミリのリクエスト設定の更新

サービス・ファミリのリクエスト設定を更新するには、PUT操作を発行します。

表47-87 サービス・ファミリに対するリクエスト設定を更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Weeks", "value": "4" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

{
"message": "\"Family \" settings updated successfully."
}

ロール別のサービス・ファミリ設定の詳細の表示

ロール別のサービス・ファミリ設定の詳細を表示するには、GET操作を発行します。

表47-88 ロール別のサービス・ファミリ設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}/roles
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"items": [
{
"href":
"https://xx.idc.example.com:34518/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/r
equestsettings/servicefamily/cfw_samplexaas_servicefamily/roles/TVMCFW_R2",
"name": "TVMCFW_R2"
}
],
"totalResults": 1
}

ロールのサービス・ファミリ設定の作成

ロールのサービス・ファミリ設定を作成するには、POST操作を発行します。

表47-89 ロールのサービス・ファミリ設定を作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}/roles
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "SERVICE_INSTANCE_USER_SHARE_ALLOWED": { "value": "true" }, "requestSettings": [ { "name": "REQUEST_DURATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Weeks", "value": "14" }, { "name": "REQUEST_ARCHIVE_RETENTION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Hours", "value": "123" }, { "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Days", "value": "121" } ], "role": "TVMCFW_R2" }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"message": "\"Family role \" settings created successfully."
}

特定のロールのサービス・ファミリ・リクエスト設定の詳細の表示

特定のロールのサービス・ファミリ・リクエスト設定の詳細を表示するには、GET操作を発行します。

表47-90 特定のロールに対するサービス・ファミリ・リクエスト設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"family": "cfw_samplexaas_servicefamily",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R2",
"unitOfMeasurement": "Days",
"value": "121"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R2",
"unitOfMeasurement": "Weeks",
"value": "14"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"family": "cfw_samplexaas_servicefamily",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R2",
"unitOfMeasurement": "Hours",
"value": "123"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

特定のロールのサービス・ファミリ・リクエスト設定の更新

特定のロールのサービス・ファミリ・リクエスト設定を更新するには、PUT操作を発行します。

表47-91 特定のロールに対するサービス・ファミリ・リクエスト設定を更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Years", "value": "75" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

{
"message": "\"Family role\" settings updated successfully."
}

特定のロールのサービス・ファミリ・リクエスト設定の削除

特定のロールのサービス・ファミリ・リクエスト設定を削除するには、DELETE操作を発行します。

表47-92 特定のロールに対するサービス・ファミリ・リクエスト設定を削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicefamily/{servicefamily}/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

{
"message": "\"Family role \" settings deleted successfully."
}

サービス・タイプのリクエスト設定の詳細の表示

サービス・タイプのリクエスト設定の詳細を表示するには、GET操作を発行します。

表47-93 サービス・タイプに対するリクエスト設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"requestSettings": [
{
"description": "This setting controls if there is a restriction on how far a user can
make a request",
"displayName": "Future Reservation Restricted",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "No Restriction",
"serviceType": "cfw_samplexaas_service"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
for which requests can be made",
"displayName": "Request Duration Restricted",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "No Restriction",
"serviceType": "cfw_samplexaas_service"
},
{
"description": "This setting controls if there is a restriction on the maximum duration
after which archived requests will be automatically deleted by the system",
"displayName": "Request Archive Retention Restricted",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "No Restriction",
"serviceType": "cfw_samplexaas_service"
},
{
"displayName": "Service Instance Sharing With Users Restricted",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"serviceType": "cfw_samplexaas_service",
"value": "false"
},
{
"displayName": "Service Instance Sharing With Roles Restricted",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"serviceType": "cfw_samplexaas_service",
"value": "false"
}
]
}

サービス・タイプのリクエスト設定の更新

サービス・タイプのリクエスト設定を更新するには、PUT操作を発行します。

表47-94 サービス・タイプに対するリクエスト設定を更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Weeks", "value": "4" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

{
"message": "\"Servicetype \" settings updated successfully."
}

ロール別のサービス・タイプ設定の詳細の表示

ロール別のサービス・タイプ設定の詳細を表示するには、GET操作を発行します。

表47-95 ロール別のサービス・タイプ設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}/roles
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"items": [
{
"href":
"https://xx.idc.example.com:34518/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/r
equestsettings/servicetype/cfw_samplexaas_service/roles/TVMCFW_R3",
"name": "TVMCFW_R3"
}
],
"totalResults": 1
}

ロールのサービス・タイプ設定の作成

ロールのサービス・タイプ設定を作成するには、POST操作を発行します。

表47-96 ロールのサービス・タイプ設定を作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}/roles
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "SERVICE_INSTANCE_USER_SHARE_ALLOWED": { "value": "true" }, "requestSettings": [ { "name": "REQUEST_DURATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Weeks", "value": "14" }, { "name": "REQUEST_ARCHIVE_RETENTION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Hours", "value": "123" }, { "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Days", "value": "121" } ], "role": "TVMCFW_R3" }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{
"message": "\"Servicetype role \" settings created successfully."
}

特定のロールのサービス・タイプ・リクエスト設定の詳細の表示

特定のロールのサービス・タイプ・リクエスト設定の詳細を表示するには、GET操作を発行します。

表47-97 特定のロールに対するサービス・タイプ・リクエスト設定の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
"requestSettings": [
{
"description": "This setting controls how far a user can make a request",
"displayName": "Future Reservation Length",
"name": "FUTURE_RESERVATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R3",
"serviceType": "cfw_samplexaas_service",
"unitOfMeasurement": "Days",
"value": "121"
},
{
"description": "This setting controls the maximum duration for which a user can make a
request",
"displayName": "Request duration Length",
"name": "REQUEST_DURATION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R3",
"serviceType": "cfw_samplexaas_service",
"unitOfMeasurement": "Weeks",
"value": "14"
},
{
"description": "This setting controls the maximum duration after which archived requests
will be automatically deleted by the system",
"displayName": "Request Archive Retention Length",
"name": "REQUEST_ARCHIVE_RETENTION_LENGTH",
"restrictionPolicy": "Restricted",
"role": "TVMCFW_R3",
"serviceType": "cfw_samplexaas_service",
"unitOfMeasurement": "Hours",
"value": "123"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_USER_SHARE_ALLOWED",
"value": "false"
},
{
"description": "Sharing enabled/disabled",
"name": "SERVICE_INSTANCE_ROLE_SHARE_ALLOWED",
"value": "false"
}
]
}

特定のロールのサービス・タイプ・リクエスト設定の更新

特定のロールのサービス・タイプ・リクエスト設定を更新するには、PUT操作を発行します。

表47-98 特定のロールに対するサービス・タイプ・リクエスト設定を更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "FUTURE_RESERVATION_LENGTH", "restrictionPolicy": "Restricted", "unitOfMeasurement": "Years", "value": "75" }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

{
"message": "\"Servicetype role \" settings updated successfully."
}

特定のロールのサービス・タイプ・リクエスト設定の削除

特定のロールのサービス・タイプ・リクエスト設定を削除するには、DELETE操作を発行します。

表47-99 特定のロールに対するサービス・タイプ・リクエスト設定を削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/setup/requestsettings/servicetype/{servicetype}/roles/{role}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

{
"message": "\"Servicetype role \" settings deleted successfully."
}

V2のVMアダプタ

この項では、VMアダプタREST APIについて説明します。

VMアダプタ・データ・モデル

次の表に、VMアダプタ・データ・モデルを示します。

表47-100 VMアダプタ・データ・モデル

フィールド	データ型	説明
name	文字列	リソースの名前。
type	文字列	リソースのタイプ。
totalResults	int	合計結果。
items	リスト<VMAdapter>	VMアダプタのリスト
canonicalLink	CfwLink	このURIに対してGETリクエストを実行すると、このリソースのクライアント表現がリフレッシュされます。
selfLink	CfwLink	これを含む要素と同等のリソースを参照します。

サポートされる操作

次の表に、VMアダプタ・リソースでサポートされる操作を示します。

表47-101 VMアダプタでサポートされるメソッド

リクエスト・メソッド	正規のリンク	説明
GET	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters	すべての登録済VMアダプタを返します。
GET	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/{name}	登録済VMアダプタの詳細を返します。
GET	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/stagingservers	ステージング・サーバーを返します。
POST	/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/stagingservers	ステージング・サーバーを作成します。

V2のVMアダプタREST APIの例

この項では、VMアダプタ・リソースのREST APIについて説明します。次の操作について説明します。

• すべての登録済VMアダプタの詳細の表示

• 特定の登録済VMアダプタの詳細の表示

• ステージング・サーバーの詳細の表示

• ステージング・サーバーの作成

すべての登録済VMアダプタの詳細の表示

すべての登録済VMアダプタの詳細を表示するには、GET操作を発行します。

表47-102 すべての登録済VMアダプタの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{ "name":"VMAdapters",
"type":"VMAdaptersCollection",
"totalResults":1, 
"items":[ { "id":"1",
"name":"SAMPLEADAPTER", 
"displayName":"SampleAdapter", 
"description":"SampleStand alone adapter",
"instances":{ "count":0, "href":"https://cloudcompany.com/em/websvcs/restful//extws/cloudservices/admin/cfw/v2/resourceproviders/?propertyname=adaptertype&propertyvalue=SAMPLEADAPTER" },
 "canonicalLink":{ "href":"https://cloudcompany.com/em/websvcs/restful//extws/cloudservices/admin/cfw/v2/vmadapters/SAMPLEADAPTER" } } ],
"canonicalLink":{ "href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/" }}

特定の登録済VMアダプタの詳細の表示

登録済VMアダプタの詳細を表示するには、GET操作を発行します。

表47-103 特定の登録済VMアダプタの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/{name}
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{ "name": "SAMPLEADAPTER", 
"connection": { "endpoints": [ { "purpose": "login_url", "custom": [ { "name": "CloudType", "type": "STRING", "description": "CoudType, e.g. openstack, ec2, etc", "displayName": "CoudType", "required": false, "secret": false }, 
{ "name": "custom_param1", "type": "STRING", "description": "Custom parameter", "displayName": "Custom parameter", "required": false, "secret": false } ] } ], "virtualizationContainers": [ { "name": "Zone" } ] }, "proxies": [ {} ]}

ステージング・サーバーの詳細の表示

ステージング・サーバーの詳細を表示するには、GET操作を発行します。

表47-104 ステージング・サーバーの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/stagingservers
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{ "name" : "StagingServers", "totalResults" : 1, "items" : [ { "location" : "script/location", "targetName" : "blr2223141.yourcompany.com",
"targetGuid" : "5BC2376B484BC065B6661458DAF1F56D", "credentialGuid" : "25D30ADD427484310DBC8CF6211A383B" } ],
"canonicalLink" : { "href" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/stagingservers" }}

ステージング・サーバーの作成

ステージング・サーバーを作成するには、POST操作を発行します。

表47-105 ステージング・サーバーを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/vmadapters/stagingservers
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "targetName" : "blr2223141.yourcompany.com", "location" : "script/location", "credentialGuid" : "25D30ADD427484310DBC8CF6211A383B"}
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

{ "message" : "StagingServer created successfully."}

V1のSSA管理リソース

クラウドREST APIは次のように分類できます。

• コレクション・リソース

  • V1のPaasZones

  • V1のSoftwarePools

  • V1のサービス・テンプレート管理

• 単一リソース

  • V1のPaasZone

  • V1のSoftwarePool

  • V1のサービス・テンプレート管理

すべての単一リソースには、独自の属性とサポートされるメソッドがありますが、一般的に、すべての単一リソースには、次の表で説明する、いくつかの共通属性があります。

表47-106 単一リソースの共通リソース属性

フィールド	データ型	サポートされるメソッド	説明	発生
name	文字列	Any	リソース名。	1
type	文字列	Any	リソース・タイプ。	1
説明	文字列	Any	説明	0..1
id	文字列	GET	リソース識別子。	0..1
createdOn	タイムスタンプ	GET	リソースが作成された日付と時刻(W3C形式)。	0..1
createdBy	文字列	GET	リソースを作成したユーザー。	0..1
modifiedOn	タイムスタンプ	GET	リソースが最後に変更された日付と時刻(W3C形式)。	0..1
ModifiedBy	日付	GET	リソースを最後に変更したユーザー。	0..1
owner	文字列	GET	リソースを所有するユーザー。	0..1
etag	文字列	GET	HTTPエンティティ・タグの値。	0..1
lastModified	文字列	GET	HTTP Last-Modifiedの値。	0..1
canonicalLink	URI	GET	優先リソース・バージョン。	1
selfLink	URI	GET	これを含む要素と同等のリソースを参照します。	1

説明:

• サポートされるメソッド: この属性が有効なメソッド・タイプ。

• サポートされるメソッド・タイプ、Any: GET、PUTまたはPOSTメソッドが使用でき、DELETEは使用できないことを意味します。

• 発生: 0..1は、オプションのパラメータであることを示します。1は、このパラメータが必須であることを意味します。

REST APIエントリ・ポイント・リソースの詳細の表示

次の表に、REST APIリソースの詳細を表示するためのGET構成を示します。

表47-107 REST APIリソースの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/API
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
v1: 
{
canonicalLink:   
"https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1"
paasZones: "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones"
softwarePools: "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools"
}
}

V1のPaasZones

PaasZonesは、すべてのアクセス可能なPaasZoneリソースのクラウド管理者ビューを表すコレクション・リソースです。次の表では、PaaSZones [application/oracle.com.cloud.common.PaaSZones+json]のデータ・モデルについて説明します。

表47-108 PaasZonesデータ・モデル

フィールド	データ型	説明	発生
name	文字列	このコレクション・リソースの名前を表示します。	1
type	文字列	このコレクション・リソースのタイプ。	1
hasMore	ブール値	コレクションに他の要素があることを示します。	1
count	整数	返される要素の数。	1
items	コレクション<PaasZone>	Paasゾーン・リソースのリスト。 インスタンスがない場合、itemsは空で表示されます。	1
totalCount	整数	Paasゾーン・リソースの合計数。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

次の表では、PaaSZonesでサポートされるメソッドについて説明します。

表47-109 PaasZonesでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	URI	説明
GET	該当なし	該当なし	em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/	PaasZonesコレクション・リソースの詳細を返します。
GET/metadata	該当なし	該当なし	em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/metadata	PaasZoneメタデータを返します。
PUT	該当なし	PaasZone (Jsonペイロード)	em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/	PaasZoneリソースを更新します。
POST	該当なし	PaasZone (Jsonペイロード)	em/websvcs/restful//extws/cloudservices/admin/cfw/v1/paaszones/	PaasZoneリソースを作成します。

PaasZones REST APIの例

次の項に、PaasZones REST API操作の例を示します。EMCLIコマンドを使用して、様々な操作(作成、更新、削除操作など)を実行することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

この項では、次の操作について説明します。

• PaaSゾーン群メタデータの表示

• PaaSゾーン群のリスト

PaaSゾーン群メタデータの表示

次の表に、メタデータを表示するためのGET構成を示します。

表47-110 メタデータを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/metadata
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json
{
  "constraints" : [ {
    "name" : "MAX_CPU_UTILIZATION",
    "description" : "Maximum CPU Utilization (%)",
    "value" : "80"
  }, {
    "name" : "MAX_MEMORY_ALLOCATION",
    "description" : "Maximum Memory Allocation (%)",
    "value" : "80"
  } ],
  "memberTargetTypes" : [ "oracle_vm_zone", "host" ],
  "message" : "When creating Paas Infrastructure zone: (1) member_type should be set to one of the values shown in member target types. All Zone members have to be of the same type. (2) Please change the value of the constraints as required."
}

PaaSゾーン群のリスト

次の表に、PaaSゾーン群をリストするためのGET構成を示します。

表47-111 PaaSゾーン群を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json	
{
  "name" : "Paas Zones",
  "type" : "Paas Infrastructure Zone",
  "hasMore" : false,
  "count" : 4,
  "items" : [ {
    "name" : "pzone1",
    "id" : "A3CF2D49CFF3F3E664D073303EA51F8E",
    "type" : "self_service_zone",
    "canonicalLink" : 
"https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E"
  }, {
    "name" : "Test Zone 2",
    "id" : "EF3830C71CC54B50B963376F9217AB95",
    "type" : "self_service_zone",
    "description" : "with MAX_CPU_UTILIZATION ",
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/EF3830C71CC54B50B963376F9217AB95"
  }, {
    "name" : "test paas zone",
    "id" : "5D7548C1B879A51CFD894CEA8D5FB19B",
    "type" : "self_service_zone",
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/5D7548C1B879A51CFD894CEA8D5FB19B"
  }, {
    "name" : "Test Zone",
    "id" : "CACBB07A674F280DF84FC4CBFA76DFA7",
    "type" : "self_service_zone",
    "description" : "with MAX_CPU_UTILIZATION ",
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/CACBB07A674F280DF84FC4CBFA76DFA7"
  } ],
  "totalCount" : 4,
  "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones",
  "selfLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones"
}

V1のPaasZone

このリソースは、PaaSインフラストラクチャ・ゾーンを表します。次の表では、PaaSZone [application/oracle.com.cloud.common.PaaSZone+json]のデータ・モデルについて説明します。

表47-112 PaaSZoneデータ・モデル

フィールド	データ型	サポートされるメソッド	説明	発生
name	文字列	Any	PaaSゾーンのユーザー用の名前。 これは編集できません。	1
id	文字列	GET	ゾーンID。GETメソッドに、この要素の値を含めます。	1
説明	文字列	Any	ゾーンの簡単な説明。	0..1
credential	文字列	Any	このPaaSインフラストラクチャ・ゾーンでプロビジョニングに使用するグローバル名前付き資格証明。	1
members	コレクション<文字列>	GET POST	PaaSゾーンのメンバー。ホスト・メンバーまたはOracle VMゾーン・メンバーにできます。	1
memberType	文字列	GET POST	PaaSゾーンのメンバーのターゲット・タイプ。ホスト・メンバーの場合は「host」、Oracle VMゾーン・メンバーの場合は「oracle_vm_zone」にできます。	1
constraints	コレクション<EntityValueHolder>	Any	配置ポリシー制約を使用すると、クラウド管理者はどのホストにも最大しきい値を設定できます。 詳細は、ゾーン・メタデータREST APIを参照してください。	0..1
roles	コレクション<文字列>	GET POST	このPaaSインフラストラクチャ・ゾーンにアクセス可能なSSAロール。	0..1
pools	コレクション<SoftwarePool>	GET	このPaaSゾーンに関連付けられたソフトウェア・プール。	0..1
membersToAdd	コレクション<文字列>	PUT	編集時に既存のPaaSゾーンに追加するホスト・ターゲットまたはOracle VMゾーン・ターゲット。	0..1
membersToRemove	コレクション<文字列>	PUT	編集時に既存のPaaSゾーンから削除するホスト・ターゲットまたはOracle VMゾーン・ターゲット。	0..1
rolesToAdd	コレクション<文字列>	PUT	PaaSゾーンの編集時に追加するSSAロール。	0..1
rolesToRemove	コレクション<文字列>	PUT	PaaSゾーンの編集時に削除するSSAロール。	0..1

説明:

• サポートされるメソッド: 値「Any」は、GET、POSTまたはPUTを意味します。

  「サポートされるメソッド」列の値によっては、リクエスト・ペイロードで関連の属性を指定する必要があるか、または操作の完了後にレスポンス・ペイロードで有効になります。

  たとえば、PUT操作を実行する場合、name、description、credential、membersToAdd、membersToRemove、constraints、rolesToAddおよびrolesToRemove属性をリクエスト・ペイロードで指定できます。

• PaasZoneのメンバー・タイプがoracle_vm_zoneの場合、constraints属性は定義しません。

• メンバー・タイプが「ホスト」の場合、MAX_CPU_UTILIZATIONおよびMAX_MEMORY_ALLOCATIONの2つ配置制約がPaasゾーンでサポートされます。これらを指定しない場合、デフォルト値は、80パーセントになります。

次の表では、PaaSZoneリソースでサポートされるメソッドについて説明します。

表47-113 PaaSZoneリソースでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	レスポンス・ペイロード	URI	説明
GET	このオプションの問合せパラメータで使用可能な値は次のとおりです。 constraints pools members roles	該当なし	PaasZone (Jsonペイロード)	em/websvcs/restful//extws/cloudservices/admin/cfw/v1/paaszones/{zoneId}	PaaSインフラストラクチャ・ゾーンの詳細を取得します。
DELETE	該当なし	該当なし	ステータス・メッセージ(Jsonペイロード)	em/websvcs/restful//extws/cloudservices/admin/cfw/v1/paaszones/{zoneId}	PaaSインフラストラクチャ・ゾーンを削除します。

PaaSゾーンREST APIの例

次の項に、PaasゾーンREST API操作の例を示します。EMCLIコマンドを使用して、PaaSゾーンに対する様々な操作(作成、更新、削除など)を実行することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

この項では、次の操作について説明します。

• PaaSゾーンの作成

• PaaSゾーンの更新

• PaaSゾーンの削除

• PaasZoneの詳細の表示

• PaasZoneからの展開形式の表示

PaaSゾーンの作成

次の表に、PaaSゾーンを作成するためのPOST構成を示します。

表47-114 PaaSゾーンを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name":"My Test Zone", "description":"This is a TestZone", "credential":"NCAIME", "memberType":"host", "members":[ "slc05gvt.us.example.com" ], "constraints":[ { "name":"MAX_CPU_UTILIZATION", "value":"85" }, { "name":"MAX_MEMORY_ALLOCATION", "value":"95" } ], "roles":[ "SSACOREROLE1", "SSACOREROLE2" ], }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

Status 201 Created 
Content-Type: application/json
{
  "name" : "My Test Zone",
  "description" : "This is a TestZone",
  "type" : "PaaS Infrastructure Zone",
  "id" : "DDBFEFDAD2AE6490E040F00AA37D4C67",
  "credential" : "NCAIME",
  "members" : {
    "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/members",
    "memberType" : "host",
    "numberOfHostMembers" : "1"
  },
  "constraints" : {
    "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/constraints",
    "numberOfConstraints" : "2"
  },
  "roles" : {
    "canonicalLink" : 
"https://cloudcompany.com.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/roles",
    "numberOfUserRoles" : "2"
  },
  "pools" : {
    "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/pools",
    "numberOfSoftwarePools" : "0"
  },
  "createdOn" : "2013-05-27 20:57:18",
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67",
  "selfLink" : 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67"
}

PaaSゾーンの更新

次の表に、PaaSゾーンを更新するためのPUT構成を示します。

表47-115 PaaSゾーンを更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name":"My Test Zone", "credential":"NCAIME2", "description":"Description_01", "membersToAdd":[ "somehost.com", "someotherhost.com" ], "membersToRemove":[ "removehost.com", "removeotherhost2.com" ] , "rolesToAdd":[ "ROLE_1", "ROLE_2" ], "rolesToRemove":[ "ROLE_1_1", "ROLE_2_1" ], "constraints":[ { "name":"MAX_MEMORY_ALLOCATION", "value":"80" }, { "name":"MAX_CPU_UTILIZATION", "value":"80" } ] }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json
{
  "message" : "PaaS Infrastructure Zone "My Test Zone" updated successfully."
}

PaaSゾーンの削除

次の表に、PaaSゾーンを削除するためのDELETE構成を示します。

表47-116 PaaSゾーンを削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/DDBFEFDAD2AE6490E040F00AA37D4C67
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json
{
  "message" : "PaaS Infrastructure Zone  "DDBFEFDAD2AE6490E040F00AA37D4C67" deleted    successfully."
}

ノート:

PaaSインフラストラクチャ・ゾーンは、関連付けられているソフトウェア・プールがある場合、削除できません。

PaasZoneの詳細の表示

次の表に、PaaSゾーンの詳細を表示するためのGET構成を示します。

表47-117 PaaSゾーンの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/A3CF2D49CFF3F3E664D073303EA51F8E
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json
{
  "name" : "pzone1",
  "description" : "This zone contains Host members",
  "type" : "PaaS Infrastructure Zone",
  "id" : "A3CF2D49CFF3F3E664D073303EA51F8E",
  "credential" : "SXAASJUNITHOSTCRED",
  "members" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/members",
    "memberType" : "host",
    "numberOfHostMembers" : "2"
  },
  "constraints" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/constraints",
    "numberOfConstraints" : "2"
  },
  "roles" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/roles",
    "numberOfUserRoles" : "1"
  },
  "pools" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E/pools",
    "numberOfSoftwarePools" : "0"
  },
  "createdOn" : "2013-05-22 01:50:30",
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E",
  "selfLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/A3CF2D49CFF3F3E664D073303EA51F8E"
}

PaasZoneからの展開形式の表示

Getリクエストは、問合せパラメータの展開をサポートしています。この問合せパラメータに基づき、PaasZoneの関連属性が展開されます。

次の問合せパラメータがサポートされています。

• members

• role

• constraints

• pools

次の表に、PaaSゾーンの展開されたビューに対するGET構成を示します。

表47-118 PaaSゾーンの展開されたビューに対するGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/passzones/{zone_id}/?expands=<param_name>
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

{
  "name" : "My Test Zone",
  "description" : "Description_02",
  "type" : "PaaS Infrastructure Zone",
  "id" : "DDBFEFDAD2AE6490E040F00AA37D4C67",
  "credential" : "C",
  "members" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/members",
    "memberType" : "host",
    "numberOfHostMembers" : "1"
  },
  "constraints" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/constraints",
    "items" : [ {
      "name" : "MAX_MEMORY_ALLOCATION",
      "value" : "25"
    }, {
      "name" : "MAX_CPU_UTILIZATION",
      "value" : "25"
    } ]
  },
  "roles" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/roles",
    "numberOfUserRoles" : "0"
  },
  "pools" : {
    "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67/pools",
    "numberOfSoftwarePools" : "0"
  },
  "createdOn" : "2013-05-27 20:57:18",
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67",
  "selfLink" : "https://example.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/paaszones/DDBFEFDAD2AE6490E040F00AA37D4C67"
}

V1のSoftwarePools

SoftwarePoolsは、すべてのアクセス可能なSoftwarePoolリソースのSSA管理者ビューを表すコレクション・リソースです。次の表では、SoftwarePools [application/oracle.com.cloud.common.SoftwarePools+json]のデータ・モデルについて説明します。

表47-119 SoftwarePoolsデータ・モデル

フィールド	データ型	説明	発生
name	文字列	このコレクション・リソースの名前を表示します。	1
type	文字列	このコレクション・リソースのタイプ。	1
hasMore	ブール値	コレクションに他の要素があることを示します。	1
count	整数	返される要素の数。	1
items	コレクション<SoftwarePools>	このコレクションの要素。	1
totalCount	整数	このコレクションの要素の合計数。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

次の表では、SoftwarePoolsリソースでサポートされるメソッドについて説明します。

表47-120 SoftwarePoolsリソースでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	URI	説明
GET	zonename pooltype	該当なし	em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/	既存のソフトウェア・プールのコレクションを返します。
PUT	該当なし	SoftwarePool (Jsonペイロード)	em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/	既存のソフトウェア・プールのリソースを更新します。
POST	該当なし	SoftwarePool (Jsonペイロード)	em/websvcs/restful//extws/cloudservices/admin/cfw/v1/softwarepools/	ソフトウェア・プールを作成します。

ソフトウェア・プール群REST APIの例

次の項に、SoftwarePools REST API操作の例を示します。EMCLIコマンドを使用して、ソフトウェア・プール群に対する様々な操作(作成、更新、削除など)を実行することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

この項では、次の操作について説明します。

• ソフトウェア・プール群の詳細の表示

• 検索問合せパラメータに基づくフィルタリング出力

ソフトウェア・プール群の詳細の表示

次の表に、ソフトウェア・プール群の詳細を表示するためのGET構成を示します。

表47-121 ソフトウェア・プール群の詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json 
{
name: "Software Pools"
type: "Software Pool"
hasMore: false
count: 2
items: [2]
0:  {
name: "IT_MW_Pool_2"
type: "mwaas_zone"
id: "E284FAAA7FBA6A06F7090115A3E07299"
zoneName: "IT_MW_Zone1"
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/E284FAAA7FBA6A06F7090115A3E07299"
description: "Middleware Pool of Oracle Homes of Version 10.3.5.0"
}-
1:  {
name: "IT_MW_Pool1"
type: "mwaas_zone"
id: "DD73A46E9E3C9866E040F00AE5235A7F"
zoneName: "IT_MW_Zone1"
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/DD73A46E9E3C9866E040F00AE5235A7F"
description: "Middleware Pool of Oracle Homes"
}-
-
totalCount: 2
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
selfLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
}

検索問合せパラメータに基づくフィルタリング出力

ソフトウェア・プールの検索は、次の項目について、次の問合せパラメータによりサポートされます。

• zonename

• pooltype

一度に、単一または複数の検索パラメータを指定できます。「%」文字を使用するワイルド・カード検索もサポートされます。

次の表に、ソフトウェア・プール群をフィルタするためのGET構成を示します。

表47-122 ソフトウェア・プール群をフィルタするためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools?zonename=IT_MW%&pooltype=mwaas_zone
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json 
{
name: "Software Pools"
type: "Software Pool"
hasMore: false
count: 1
items: [1]
0:   {
name: "IT_MW_Pool1"
type: "mwaas_zone"
id: "DD73A46E9E3C9866E040F00AE5235A7F"
zoneName: "IT_MW_Zone1"
canonicalLink: 
"https://cloudcompany/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/DD73A46E9E3C9866E040F00AE5235A7F"
description: "Middleware Pool of Oracle Homes"
}
 
totalCount:1 
canonicalLink: 
"https:// cloudcompany/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
selfLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/"
}

V1のSoftwarePool

SoftwarePoolリソースは、PaaSインフラストラクチャ・ゾーン内のサービス・リクエストに使用される同種のサーバーまたはクラスタのコレクションを表します。ソフトウェア・プール内のすべてのメンバーが、同一のタイプで、同一のPaaSインフラストラクチャ・ゾーンに属している必要があります。

また、同種性を維持するために、各メンバーは、ソフトウェア・プールへのメンバーの追加を制限する一連のフィルタ基準を満たす必要があります。次の表では、SoftwarePool [application/oracle.com.cloud.common.SoftwarePool+json]のデータ・モデルについて説明します。

表47-123 SoftwarePoolデータ・モデル

フィールド	データ型	サポートされるメソッド	説明	発生
name	文字列	Any	ソフトウェア・プールのユーザー用の名前。 これは編集できません。	1
id	文字列	GET	リソースを一意に識別するプールGUID。	1
説明	文字列	Any	サービス・テンプレートの簡単な説明。	0..1
poolTargetType	文字列	Any	作成するソフトウェア・プールのターゲット・タイプ。たとえば、ミドルウェア・プールの場合は"mwaas_zone"、データベース・プールの場合は"oracle_cloud_zone"、スキーマ・プールの場合は"schaas_pool"。	1
paasZone	文字列	GET POST	このソフトウェア・プールに関連付けられているPaaSゾーンの名前。	1
members	コレクション<文字列>	GET POST	PaaSゾーンのメンバー。ホスト・メンバーまたはOracle VMゾーン・メンバーにできます。	1
constraints	コレクション<EntityValueHolder>	Any	セルフ・サービス管理者がリソース使用率の上限を設定できるようにする、ソフトウェア・プールの配置制約。	0..1
filters	コレクション< EntityValueHolder >	GET POST	設定条件によってソフトウェア・プールへのメンバー・ターゲットの追加を制限する、ソフトウェア・プール上のフィルタ。	1
properties	コレクション< EntityValueHolder >	Any	特定のプール・ターゲット・タイプで指定する必要がある追加プロパティ。	1
membersToAdd	コレクション<文字列>	PUT	編集時に既存のソフトウェア・プールに追加するターゲット。	0..1
membersToRemove	コレクション<文字列>	PUT	編集時に既存のソフトウェア・プールから削除するターゲット。	0..1
canonicalLink	URI	GET	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1

ノート:

サポートされるメソッドの値「Any」は、GET、POSTまたはPUTを意味します。

次の表では、ソフトウェア・プールのリソースでサポートされるメソッドについて説明します。

表47-124 ソフトウェア・プールのリソースでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	レスポンス・ペイロード	URI	説明
GET	param-name : expandsparam-value : members/ filters/ constraints/all 特定の属性を展開して、そのデータを表示します。 「all」ですべての属性が展開されます。	該当なし	SoftwarePool (Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful//extws/cloudservices/admin/cfw/v1/softwarepool/{poolId}	ソフトウェア・プール詳細を取得します。
DELETE	該当なし	該当なし	ステータス・メッセージ(Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful//extws/cloudservices/admin/cfw/v1/softwarepool/{poolId}	ソフトウェア・プールを削除します。

SoftwarePool REST APIの例

次の項に、SoftwarePool REST API操作の例を示します。EMCLIコマンドを使用して、ソフトウェア・プールに対する様々な操作(作成、更新、削除操作など)を実行することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

この項では、次の操作について説明します。

• ソフトウェア・プールの作成

• ソフトウェア・プールの更新

• ソフトウェア・プールの削除

• ソフトウェア・プールの詳細の表示

• 問合せパラメータの展開

ソフトウェア・プールの作成

ソフトウェア・プールを作成するには、ソフトウェア・プール・コレクション・リソースに対しPOST操作を発行します。

次の表に、ソフトウェア・プールを作成するためのPOST構成を示します。

表47-125 ソフトウェア・プールを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "IT_MW_Pool1", "poolTargetType": "mwaas_zone", "description": "Middleware Pool of Oracle Homes", "paasZone": "IT_MW_Zone1", "members": ["WebLogicServer10_3_6_0_slc01afx_6775","WebLogicServer10_3_6_0_adc2201439_4731"], "constraints": {"items": [{"name": "MAX_INSTANCES", "value": "10"}]}, "filters": {"items": [{"name": "VERSION","value": "10.3.6.0"}]} }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

Status 201 Created 
Content-Type: application/json
{
name: "IT_MW_Pool1"
description: "Middleware Pool of Oracle Homes"
type: "Middleware Pool"
id: "687FE169ED3556CED38D11DC9BDD5CCD"
zoneName: "IT_MW_Zone1"
members: {
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/members"
numberOfPoolMembers: "2"
}-
constraints: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/constraints"
numberOfConstraints: "1"
}-
filters: {
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/filters"
numberOfFilters: "1"
}-
properties: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/properties"
numberOfPropertiess: "0"
}-
createdOn: "2013-05-24 00:26:42"
createdBy: null
modifiedOn: null
modifiedBy: null
owner: "CLOUD_ADMIN1"
etag: null
lastModified: null
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
selfLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
}

ソフトウェア・プールの更新

次の表に、ソフトウェア・プールを更新するためのPUT構成を示します。

表47-126 ソフトウェア・プールを更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "name": "IT_MW_Pool1", "poolTargetType": "mwaas_zone", "description": "Middleware Pool of Oracle Homes Updated", "membersToAdd": ["WebLogicServer10_3_6_0_slc01afx_6776","WebLogicServer10_3_6_0_adc2201439_4732"], "constraints": {"items": [{"name": "MAX_INSTANCES", "value": "10"}]}, }
リクエスト・メソッド	PUT

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json 
{
message: "Software Pool  " IT_MW_Pool1" updated successfully."
}

ソフトウェア・プールの削除

次の表に、ソフトウェア・プールを削除するためのDELETE構成を示します。

表47-127 ソフトウェア・プールを削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	DELETE

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json 
{
message: "Software Pool "687FE169ED3556CED38D11DC9BDD5CCD" deleted successfully."
}

ノート:

ソフトウェア・プールは、そのプールに関連付けられているサービス・テンプレートがある場合、削除できません。

ソフトウェア・プールの詳細の表示

次の表に、ソフトウェア・プールの詳細を表示するためのGET構成を示します。

表47-128 ソフトウェア・プールの詳細を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json 
{
name: "IT_MW_Pool1"
description: "Middleware Pool of Oracle Homes"
type: "Middleware Pool"
id: "687FE169ED3556CED38D11DC9BDD5CCD"
zoneName: "IT_MW_Zone1"
members: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/members"
numberOfPoolMembers: "2"
}-
constraints: {
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/constraints"
numberOfConstraints: "1"
}-
filters: {
canonicalLink:
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/filters"
numberOfFilters: "1"
}-
properties: {
canonicalLink: https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/properties"
numberOfPropertiess: "0"
}-
createdOn: "2013-05-24 00:26:42"
createdBy: null
modifiedOn: null
modifiedBy: null
owner: "CLOUD_ADMIN1"
etag: null
lastModified: null
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
selfLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD"
}

問合せパラメータの展開

SoftwarePoolリソースに対するGET操作では、次のリンク・リソース属性を展開する展開問合せパラメータがサポートされます。

• members: メンバー属性を展開して、このソフトウェア・プールのすべてのメンバーを表示します。

• filters: フィルタ属性を展開して、このソフトウェア・プールのメンバーのフィルタ基準を表示します。

• constraints: 制約属性を展開して、このソフトウェア・プールに関連付けられた配置制約を表示します。

• all : ソフトウェア・プール詳細が返される際、ソフトウェア・プールのすべての属性が展開されます。

URIの書式は、次のとおりです。

https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/{poolid}/?expands=<paramname>

例:

https://hostname/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD?expands=members

問合せパラメータを指定しない場合、ソフトウェア・プール詳細データは属性を展開せずにユーザーに返されます。

V1のSoftwarePoolMetadata

ソフトウェア・プールの作成時に必要なすべてのソフトウェア・プール・ターゲット・タイプのメタデータ情報を示します。次の表では、SoftwarePoolMetadata [application/oracle.com.cloud.common.SoftwarePools+json]のデータ・モデルについて説明します。

表47-129 SoftwarePoolMetadataデータ・モデル

フィールド	データ型	説明	発生
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
poolType	文字列	ソフトウェア・プールのターゲット・タイプ。	1
poolTypeDisplayName	文字列	ソフトウェア・プールのターゲット・タイプの名前を示します。	0..1
poolTypeDescription	文字列	ソフトウェア・プールのターゲット・タイプの説明。	0..1
serviceFamily	文字列	このプール・タイプが属するサービス・ファミリを表します。	1
serviceType	文字列	このプール・タイプが属するサービス・タイプを表します。	1
constraints	コレクション<ValueDescriptor>	このプール・タイプに使用可能な配置制約に関するメタデータ情報を表します。	0..1
filters	コレクション< ValueDescriptor >	このプール・タイプに使用可能なフィルタ(メンバー制約)に関するメタデータ情報を表します。	0..1

SupportedPoolMetadataリソースのGETメソッドには次の特性があります。

• レスポンス・ペイロード:

  SoftwarePoolMetadata (Jsonペイロード)

• URI:

  em/websvcs/restful//extws/cloudservices/admin/cfw/v1/softwarepools/metadata

• 説明:

  サービス・タイプ、サービス・ファミリ、使用可能な制約および使用可能なフィルタなど、すべてのソフトウェア・プール・タイプのメタデータ情報を取得します。

ソフトウェア・プール・メタデータREST APIの取得例

SoftwarePoolMetadata URIを取得するためにGETリクエストが発行され、このURIは、その後、すべてのソフトウェア・プール・タイプのメタデータ情報を取得するために使用されます。EMCLIコマンドを使用して、ソフトウェア・プール情報を取得することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

次の表に、ソフトウェア・プール群のメタデータを表示するためのGET構成を示します。

表47-130 ソフトウェア・プール群のメタデータを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/metadata
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json 
 
{
softwarePoolsMetadata: 
{
items: [1]
0:  
{
poolType: "mwaas_zone"
poolTypeDisplayName: "Middleware Pool"
poolTypeDescription: "Middleware Pool is a set of homogeneous Middleware Oracle Homes."
serviceFamily: "MWAAS"
serviceType: "PhysicalWLS"
constraints: 
{
items: [1]
0:  
{
name: "MAX_INSTANCES"
description: "Maximum Number of Java Servers (per host)"
defaultValue: "1"
isRequiredValue: true
}
}
filters: 
{
items: [1]
0:  
{
name: "VERSION"
description: "Version"
defaultValue: "10.3.5.0"
isRequiredValue: true
possibleValues: [7]
0:  
{value: "12.1.1.0"
description: "12.1.1.0"}
1:  
{
value: "10.3.6.0"
description: "10.3.6.0"
}
2:  
{
value: "10.3.5.0"
description: "10.3.5.0"
}
3:  
{
value: "10.3.4.0"
description: "10.3.4.0"
}
4:  
{
value: "10.3.3.0"
description: "10.3.3.0"
}
5:  
{
value: "10.3.2.0"
description: "10.3.2.0"
}
6:  
{
value: "10.3.1.0"
description: "10.3.1.0"
}
}
}
}
}
canonicalLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/metadata"
}

V1のSoftwarePoolFilteredTargets

指定されたフィルタ基準に基づき、指定されたPaaSインフラストラクチャ・ゾーン内の有効なターゲットを表示します。これは、SoftwarePoolリソースへのPOST操作では使用できません。次の表では、SoftwarePoolFilteredTargets [application/oracle.com.cloud.common.SoftwarePoolFilteredTargets+json]のデータ・モデルについて説明します。

表47-131 SoftwarePoolFilteredTargetsデータ・モデル

フィールド	データ型	説明	発生
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
targetType	文字列	ソフトウェア・プールのターゲット・タイプ。例: ミドルウェア・プールの場合は"mwaas_zone"、データベース・プールの場合は"oracle_cloud_zone"、スキーマ・プールの場合は"schaas_pool"。プール・ターゲット・タイプで使用可能なフィルタを取得する場合は、SoftwarePoolsMetadataリソースを参照してください。[POST]	1
paasZone	文字列	フィルタ基準を表すPaaSゾーンの名前。 [POST]	1
targets	マップ<文字列, リスト<文字列>>	フィルタ基準適用後のフィルタ処理済ターゲット。	1
filters	コレクション<フィルタ>	フィルタ処理済ターゲットを取得するために適用する必要があるフィルタ基準。プール・ターゲット・タイプで使用可能なフィルタを取得する場合は、SoftwarePoolsMetadataリソースを参照してください。[POST]	1

フィルタ処理済ターゲットは、次の条件を満たします。

• 指定されたPaaSインフラストラクチャ・ゾーンの一部です。

• 渡されたフィルタ基準を満たしています。

• 他のソフトウェア・プールに属していません。

SupportedPoolFilteredTargetsリソースのPOSTメソッドには次の特性があります。

• リクエスト・ペイロード:

  SoftwarePoolFilteredTargets (Jsonペイロード)

• レスポンス・ペイロード

  SoftwarePoolFilteredTargets (Jsonペイロード)

• URI:

  em/websvcs/restful//extws/cloudservices/admin/cfw/v1/softwarepools/filteredtargets

• 説明:

  サービス・タイプ、サービス・ファミリ、使用可能な制約および使用可能なフィルタなど、すべてのソフトウェア・プール・タイプのメタデータ情報を取得します。

使用可能なフィルタ処理済ターゲット取得 - REST APIの例

指定したPaasゾーンおよびフィルタに基づいてフィルタ処理済ターゲットをフェッチするには、SoftwarePoolFilteredTargetsリソースに対しPOST操作を発行します。EMCLIコマンドを使用して、フィルタ処理済ターゲット情報を取得することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

次の表に、ソフトウェア・プール群のフィルタ処理済ターゲットを表示するためのPOST構成を示します。

表47-132 ソフトウェア・プール群のメタデータを表示するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: applicaiton/json
本文	{ "targetType": "mwaas_zone", "paasZone": "IT_MW_Zone1", "filters": {"items": [{"name": "VERSION", "value": "10.3.6.0"}]} }
リクエスト・メソッド	POST

受け取るレスポンスの例を次に示します。

Status 201 Created 
Content-Type: application/json 
 
{
targets: {
oracle_home: [2]
0:  "WebLogicServer10_3_6_0_slc01afx_6775"
1:  "WebLogicServer10_3_6_0_adc2201439_4731"
}
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/filteredtargets"
}

V1のSoftwarePoolCapacity

このリソースは、プール・エンティティのCPU使用率、メモリー割当て、インスタンス数などの、ソフトウェア・プール容量の詳細を取得します。次の表では、SoftwarePoolCapacity [application/oracle.com.cloud.common.SoftwarePoolCapacity+json]のデータ・モデルについて説明します。

表47-133 SoftwarePoolCapacityデータ・モデル

フィールド	データ型	説明	発生
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
name	文字列	ソフトウェア・プールの名前。 [POST]	1
type	文字列	ソフトウェア・プールのターゲット・タイプ。例: ミドルウェア・プールの場合は"mwaas_zone"、データベース・プールの場合は"oracle_cloud_zone"、スキーマ・プールの場合は"schaas_pool"。	1
capacity	コレクション<フィルタ>	フィルタ処理済ターゲットを取得するために適用する必要があるフィルタ基準。プール・ターゲット・タイプで使用可能なフィルタを取得する場合は、SoftwarePoolsMetadataリソースを参照してください。[POST]	1

SupportedPoolCapacityリソースのGETメソッドには次の特性があります。

• レスポンス・ペイロード

  SoftwarePoolCapacity (Jsonペイロード)

• URI:

  https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful//extws/cloudservices/admin/cfw/v1/softwarepools/{poolId}/capacity

• 説明:

  ソフトウェア・プール容量の詳細を取得します。

ソフトウェア・プール容量の取得

ソフトウェア・プール容量の詳細を取得するには、SoftwarePoolCapacityリソースに対しGETを発行します。EMCLIコマンドを使用して、ソフトウェア・プール容量情報を取得することもでき、これらのコマンドについては、「V2のSSA操作用のEM CLI動詞」で説明されています。

次の表に、ソフトウェア・プール容量を表示するためのGET構成を示します。

表47-134 ソフトウェア・プール容量を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/687FE169ED3556CED38D11DC9BDD5CCD/capacity
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK 
Content-Type: application/json
{
name: "mySchemaPool"
type: "schaas_pool"
capacity: {
items: [1]
0:  {
entityName: "Oemrep_Database"
entityType: "oracle_database"
entityCapacity: {
items: [4]
0:  {
resourceType: "Storage Utilization"
resourceUsed: "64.74"
resourceThreshold: "100.0"
resourceUnit: "%"
}-
1:  {
resourceType: "CPU Utilization"
resourceUsed: "0.0"
resourceThreshold: "0.0"
resourceUnit: "%"
}-
2:  {
resourceType: "Memory Utilization"
resourceUsed: "0.0"
resourceThreshold: "0.0"
resourceUnit: "%"
}-
3:  {
resourceType: "Instances"
resourceUsed: "0"
resourceThreshold: "100"
}-
-
}-
}-
-
}-
canonicalLink: 
"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/softwarepools/2E7C9C632B18C3FEB4FEA5A614E51BE7/capacity"
}

V1のコンポジット・リソース属性

この仕様のいくつかのリソース・エンティティには、次のコンポジット・リソース属性が含まれています。

• V1のValueDescriptor

• V1のValueEntity

• V1のEntityValueHolder

• V1のPoolEntityCapacity

• V1のResourceTypeCapacity

V1のValueDescriptor

関連付けられたオブジェクトに設定可能な値のタイプに関するメタデータを説明します。次の表で、このデータ・モデルについて説明します。

表47-135 ValueDescriptorデータ・モデル

フィールド	データ型	説明	発生
name	文字列	記述するデータの名前	1
説明	文字列	記述するデータの説明	1
defaultValue	文字列	記述するデータのデフォルト値	1
isRequiredValue	ブール値	値が必要な場合はTRUE	1
possibleValues	コレクション<ValueEntity>	記述するデータの有効な値のリスト(オプション)	0..1

V1のValueEntity

値(文字列表現)およびその説明(キャプション)を表します。次の表で、このデータ・モデルについて説明します。

表47-136 ValueEntityデータ・モデル

フィールド	データ型	説明	発生
value	文字列	エンティティの実際値の文字列表現	1
説明	文字列	エンティティを説明するエンティティのキャプション	0..1

V1のEntityValueHolder

名前、値および説明を持つ単一のエントリを表します。次の表で、このデータ・モデルについて説明します。

表47-137 EntityValueHolderデータ・モデル

フィールド	データ型	説明	発生
name	文字列	エンティティの名前	1
value	文字列	エンティティの実際値の文字列表現	1
説明	文字列	エンティティを説明するエンティティのキャプション	0..1

V1のPoolEntityCapacity

ソフトウェア・プールの個別のエンティティの容量の詳細を表します。次の表で、このデータ・モデルについて説明します。

表47-138 PoolEntityCapacityデータ・モデル

フィールド	データ型	説明	発生
entityName	文字列	エンティティの名前	1
entityType	文字列	エンティティのターゲット・タイプ	1
entityCapacity	コレクション<ResourceTypeCapacity>	記憶域使用率、CPU使用率など、特定のリソース・タイプの容量の詳細のコレクション	1

V1のResourceTypeCapacity

記憶域使用率、CPU使用率など、特定のリソース・タイプの容量の詳細を表します。次の表で、このデータ・モデルについて説明します。

表47-139 ResourceTypeCapacityデータ・モデル

フィールド	データ型	説明	発生
resourceType	文字列	記憶域使用率などのリソースのタイプ	1
resourceUsed	文字列	使用済リソースの文字列表現	1
resourceThreshold	文字列	リソースしきい値の文字列表現	0..1
resourceUnit	文字列	リソースの使用率を測定する単位の文字列表現	0..1

V1のサービス・テンプレート管理

この項では、サービス・テンプレートを管理するために使用できるリソースおよびREST APIについて説明します。

V1のサービス・テンプレート群

サービス・テンプレート群は、すべてのアクセス可能なサービス・テンプレート・リソースのクラウド管理者ビューを表すコレクション・リソースです。次の表では、サービス・テンプレート・データ・モデルについて説明します。

表47-140 サービス・テンプレート・データ・モデル

フィールド	データ型	説明	発生
name	文字列	このコレクション・リソースの名前を表示します。	1
type	文字列	コレクション・リソースのタイプ。	1
hasMore	ブール値	このコレクション・リソースに他の要素があるかどうかを示します。	1
count	整数	コレクション・リソースの要素数。	1
items	コレクション<整数>	サービス・テンプレート・リソースのリスト。サービス・テンプレートが存在しない場合、このフィールドは空白になります。	1
totalCount	整数	サービス・テンプレート・リソースの合計数。	1
canonicalLink	URI	このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。	1
selfLink	URI	これを含む要素と同等のリソースを参照します。	1

ServiceTemplatesリソースでサポートされるメソッド

次の表では、ServiceTemplatesリソースでサポートされるメソッドについて説明します。

表47-141 ServiceTemplatesリソースでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	URI	説明
GET	該当なし	該当なし	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/	すべてのサービス・タイプのサービス・テンプレート・コレクション・リソースの詳細を返します。
POST	該当なし	サービス・テンプレート(Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/	サービス・テンプレートのインスタンスを作成します。

ServiceTemplates REST APIの例

ServiceTemplates REST API操作の例を次に示します。

サービス・テンプレートのリスト

すべてのサービス・テンプレートをリストするには、ServiceTemplatesリソースに対してGETリクエストを発行します。

次の表に、ソフトウェア・プール容量を表示するためのGET構成を示します。

表47-142 すべてのサービス・テンプレート群を表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
Content-Type: application/json
{
 
    "name":"Service Templates",
    "type":"Service Template",
    "hasMore":false,
    "items":[
        {
            "id":"E821074692058B5DE040F00AA37D75AB",
            "name":"ST_DB_SCH_01",
            "serviceFamily":"DBAAS",
            "description":"Database Schema Service Template",
            "canonicalLink":"https://cloudcompany.com/em/websvcs/restful/extws
    /cloudservices/admin/cfw/v1/servicetemplates/E821074692058B5DE040F00AA37D75AB"
        }
    ],
    "totalCount":1,
    "canonicalLink":"https://cloudcompany.com/em/websvcs/restful/extws
    /cloudservices/admin/cfw/v1/servicetemplates"
}

V1のサービス・テンプレート

サービス・テンプレートは、セルフ・サービス・ユーザーがサービス・インスタンスをプロビジョニングするときに使用できる、標準化されたサービスの定義です。次の表では、サービス・テンプレートについて説明します。

表47-143 ServiceTemplateデータ・モデル

フィールド	データ型	サポートされるメソッド	説明	発生
name	文字列	Any	サービス・テンプレートのユーザー用の名前。このフィールドは編集できません。	1
serviceFamily	文字列	Any	サービス・ファミリ	1
serviceType	文字列	Any	サービス・タイプ	1
id	文字列	GET	サービス・テンプレートID。GETメソッドは、この要素用の値を含みます。	1
説明	文字列	Any	サービス・テンプレートの簡単な説明。	0..1
roles	コレクション<ロール>	GET POST	テンプレートにアクセスできるSSAロール。	0..1
poolIds	コレクション<文字列>	POST	このテンプレートに関連付けられたソフトウェア・プールID。	1
serviceExecutableMeta	ServiceExecutableMetaDataEntity	Any	サービス・テンプレートで使用されるサービス実行可能ファイル。	0..1
createdOn	文字列(日付/時刻)	GET	リソースが作成された日付と時刻。	0..1
createdBy	文字列	GET	リソースを作成したユーザー。	1
modifiedOn	文字列(日付/時刻)	GET	リソースが変更された日付と時刻。	0..1
modifiedBy	文字列	GET	リソースを変更したユーザー。	1
owner	文字列	GET	リソースを所有するユーザー。	1
etag	文字列	GET	HTTPエンティティ値のタグ。	0..1
lastModified	文字列	GET	HTTPの最後に変更された値	0..1
canonicalLink	URI	GET	優先リソース・バージョン。	1

説明:

• サポートされるメソッド:

  • この属性を利用できるメソッド・タイプを示します。

  • メソッド・タイプAnyは、このリソースをGET、PUTまたはPOSTメソッドで使用できることを示します。

• 発生: 0..1は、オプションのパラメータであることを示します。1は、このパラメータが必須であることを意味します。

ServiceTemplateリソースでサポートされるメソッド

次の表では、servicetemplatesリソースでサポートされるメソッドについて説明します。

表47-144 ServiceTemplateリソースでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	レスポンス・ペイロード	URI	説明
GET		該当なし	サービス・テンプレート(Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful//extws/cloudservices/admin/cfw/v1/servicetemplates/{serviceFamily}/{template id}	サービス・テンプレートの詳細を取得します。
DELETE	該当なし	該当なし	ステータス・メッセージ(Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful//extws/cloudservices/admin/cfw/v1/servicetemplates/<serviceFamily>/{template id}	サービス・テンプレートを削除します。
PUT	該当なし	サービス・テンプレート(Jsonペイロード)		https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/<serviceFamily>/{template id}	サービス・テンプレート・リソースを更新します。

V1のServiceTemplateUpdate

次の表で、ServiceTemplateUpdateデータ・モデルについて説明します。

表47-145 ServiceTemplateUpdateデータ・モデル

フィールド	データ型	サポートされるメソッド	説明	発生
説明	文字列	PUT	サービス・テンプレートの簡単な説明。	0..1
rolesAdded	コレクション<ロール>	PUT	このサービス・テンプレートにアクセスできる、追加するSSAロール。	0..1
rolesRemoved	コレクション<ロール>	PUT	このサービス・テンプレートにアクセスできる、削除するSSAロール。	0..1
poolsIdsAdded	コレクション<文字列>	PUT	既存のテンプレートの編集時に追加されるソフトウェア・プールID。	0..1
poolsIdsRemoved	コレクション<文字列>	PUT	既存のテンプレートの編集時に削除されるソフトウェア・プールID。	0..1
executableEntity	ServiceExecutableMetaDataEntity	PUT	サービス・テンプレートで使用されるサービス実行可能ファイル。	0..1

V1のServiceExecutableMetaEntity

次の表で、ServiceExecutableMetaEntityデータ・モデルについて説明します。

表47-146 ServiceExecutableMetaDataEntity

フィールド	データ型	説明
name	文字列	実際の実行可能ファイルをEnterprise Managerに保存するために使用される実行可能ファイルの名前。ジョブ、構成済デプロイメント・プロシージャ、デプロイメント・プロシージャまたはプロファイルの名前です。このフィールドは編集できません。
type	文字列	これには次のものがあります。 ジョブ DP CDP プロファイル
serviceFamily	文字列	サービス・ファミリ
serviceType	文字列	サービス・タイプ
configurations	コレクション<TemplateConfigParam>	実行可能パラメータ
payloads	コレクション<PayloadDescriptor>	ペイロード記述子のコレクション。

V1のテンプレート構成パラメータ

次の表で、TemplateConfigParamデータ・モデルについて説明します。

表47-147 構成パラメータ

フィールド	データ型	説明
id	文字列	構成パラメータのID。
name	文字列	構成パラメータの名前
value	文字列	構成パラメータの値。
values	コレクション<文字列>	構成パラメータの値のリスト。
説明	文字列	構成パラメータの説明。
required	ブール値	パラメータが必須かどうかを示すブール。
secret	ブール値	パラメータが秘密かどうかを示すブール。
subconfigurations	コレクション<TemplateConfigParam>	設定可能な値のセット。

V1のPayloadDescriptor

次の表で、PayloadDescriptorデータ・モデルについて説明します。

表47-148 PaylodDescriptorデータ・モデル

フィールド	データ型	説明
name	文字列	ペイロード・エンティティの名前。
id	文字列	ペイロード・エンティティのID。

V1のServiceTemplateメタデータ

ServiceTemplateメタデータは、サービス・テンプレート・インスタンスを作成するために必要なJSONペイロードを生成するために使用します。次の表で、ServiceTemplateメタデータ・データ・モデルについて説明します。

表47-149 ServiceTemplateメタデータ・データ・モデル

フィールド	データ型	説明
serviceFamily	文字列	サービス・ファミリの名前。
serviceType	文字列	サービス・タイプの名前。
type	文字列	次のいずれかです。 JOB DP CDP PROFILE
説明	文字列	説明
payload	ブール値	ペイロードが予想される場合はtrueです。
payloads	コレクション<PayloadMetaData>	パラメータが必須かどうかを示すブール。

V1のPayloadMetaData

次の表で、PayloadMetadataについて説明します。

表47-150 PayloadMetaData

フィールド	データ型	説明
id	文字列	ペイロードID。
name	文字列	ペイロードの名前
defaultValue	文字列	デフォルト値

V1のServiceTemplateメタデータ

次の表では、ServiceTemplateMetaDataでサポートされるメソッドについて説明します。

表47-151 ServiceTemplateMetaDataでサポートされるメソッド

メソッド	問合せパラメータ	リクエスト・ペイロード	レスポンス・ペイロード	URI	説明
GET		該当なし	コレクション<ServiceTemplateMetaData> (Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful//extws/cloudservices/admin/cfw/v1/servicetemplates/{serviceFamily}/executable/metadata	CDPやDPなどの特定のサービス・ファミリおよびサービス・タイプのメタデータを取得します。
POST		サービス・テンプレート・メタデータ(Jsonペイロード)	ServiceExecutableMetaEntity (Jsonペイロード)	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/metadata	POSTされたサービス・ファミリおよびサービス・タイプの構成を取得します。

ServiceTemplates REST APIの例

この項では、ServiceTemplates REST API操作の例を示します。

• サービス・テンプレートの作成

• サービス・テンプレートの更新

• サービス・テンプレートの削除

• サービス・テンプレートの詳細の表示

• サービス・テンプレートのメタデータの表示

• サービス・テンプレートの構成値の作成

サービス・テンプレートの作成

次の表に、サービス・テンプレートを作成するためのPOST構成を示します。

表47-152 サービス・テンプレートを作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	{ "name":"TestSchaasTemplate3", "serviceType":"SCHEMA", "serviceFamily":"DBAAS", "description":"This is a test schaas service template 1", "poolIds":[ "FC129EEFFD67CD948B3147D2BAE0BA89" ], "roles":[ { "name":"SSA01" } ], "serviceExecutableMeta":{ "type":"CDP", "configurations":[ { "name":"ROLE_NAME", "value":"SampleRole" }, { "name":"MAX_NUMBER_OF_SCHEMAS","value":"2" }, { "name":"ENFORCE_STORAGE_CONSTRAINT","value":"NO_LIMIT" }, { "name":"AUTO_EXTEND_BLOCK_SIZE","value":"1024" }, { "name":"REF_ZONE","value":"blr zone" }, { "name":"REF_POOL","value":"schpool" }, { "name":"REF_HOST","value":"mycompanyhost.com" }, { "name":"REF_DB","value":"Database" }, { "name":"CREATE_SCHEMA_OPTION","value":"EMPTY_SCHEMAS" }, { "name":"WORKLOADS", "subconfigurations":[ { "name":"WORK_LOADS:1", "subconfigurations":[ { "name":"name", "value":"Small" }, { "name":"description", "value":"small workload" }, { "name":"default", "value":"Y" }, { "name":"CPU", "value":"2" }, { "name":"Memory", "value":"2048" }, { "name":"Storage", "value":"1024" } ] }, { "name":"WORK_LOADS:2", "subconfigurations":[ { "name":"name", "value":"large " }, { "name":"description", "value":"large workload" }, { "name":"default", "value":"Y" }, { "name":"CPU", "value":"6" }, { "name":"Memory", "value":"4048" }, { "name":"Storage", "value":"2024" } ] } ] } ] } }
リクエスト・メソッド	POST

サービス・テンプレートの更新

次の表に、サービス・テンプレートを更新するためのPUT構成を示します。

表47-153 サービス・テンプレートを更新するためのPUTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	{ "description":"Service Template", "rolesAdded":[ { "name": "SSA02" } ], "rolesRemoved":[ { "name": "SSA01" } ], "serviceExecutableMeta":{ "type":"CDP", "configurations":[ { "name":"REF_ZONE", "value":"blr zone" }, { "name":"REF_POOL", "value":"schpool" }, { "name":"REF_HOST", "value":"mycompanyhost.com" } ] } }
リクエスト・メソッド	PUT

サービス・テンプレートの削除

次の表に、サービス・テンプレートを削除するためのDELETE構成を示します。

表47-154 サービス・テンプレートを削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/687FE169ED3556CED38D11DC9BDD5CCD
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI=
本文	なし
リクエスト・メソッド	DELETE

サービス・テンプレートの詳細の表示

次の表に、サービス・テンプレートの詳細を表示するためのGET構成を示します。

表47-155 サービス・テンプレートを削除するためのDELETEリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/687FE169ED3556CED38D11DC9BDD5CCD
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
 
Content-Type: application/json
{
  "name" : "ST_DB_SCH_01",
  "serviceFamily" : "DBAAS",
  "serviceType" : "SCHEMA",
  "type" : "Service Template",
  "description" : "Database Schema Service Template",
  "id" : "E821074692058B5DE040F00AA37D75AB",
  "pools" : [ {
    "name" : "SP_DB_SCH_01",
    "id" : "EBECE6B8F0144BEFAB2F1991B4AFCC65",
    "type" : "schaas_pool",
    "zone" : {
      "id" : "E82022FF954B98CFE040F00AA37D447B",
      "name" : "PZ01"
    }
  } ],
  "serviceExecutableMeta" : {
    "type" : "CDP",
    "configurations" : [ {
      "id" : "targets",
      "name" : "targets",
      "value" : ""
    }, {
      "id" : "ssaRequestId",
      "name" : "ssaRequestId",
      "value" : ""
    }, {
      "id" : "ssaUser",
      "name" : "ssaUser",
      "value" : ""
    }, {
      "id" : "ssaTargetName",
      "name" : "ssaTargetName",
      "value" : ""
    }, {
      "id" : "ssaTargetType",
      "name" : "ssaTargetType",
      "value" : ""
    }, {
      "id" : "zoneTargetName",
      "name" : "zoneTargetName",
      "value" : ""
    }, {
      "id" : "zoneTargetType",
      "name" : "zoneTargetType",
      "value" : ""
    }, {
      "id" : "REQUEST_NAME",
      "name" : "REQUEST_NAME",
      "value" : ""
    }, {
      "id" : "SERV_TEMPLATE_GUID",
      "name" : "SERV_TEMPLATE_GUID",
      "value" : ""
    }, {
      "id" : "CREATE_SCHEMA_OPTION",
      "name" : "Option for creating user schemas",
      "value" : "EMPTY_SCHEMAS"
    }, {
      "id" : "MAX_NUMBER_OF_SCHEMAS",
      "name" : "Maximum number of schemas permissible",
     "value" : "4"
    }, {
      "id" : "DB_PROFILE_URN",
      "name" : "Database Profile Component's URN",
      "value" : ""
    }, {
      "id" : "REMAP_SCHEMA_LIST",
      "name" : "Schema list.",
      "value" : "",
      "values" : [ ]
    }, {
      "id" : "MASTER_ACCOUNT",
      "name" : "Master Account",
      "value" : ""
    }, {
      "id" : "ROLE_NAME",
      "name" : "Database Role Name",
      "value" : "ST_DB_SCH_01_Oct_06_2013_22"
    }, {
      "id" : "SCHEMA_PRIVILEGES",
      "name" : "Schema Privileges",
      "value" : "",
      "values" : [ "CREATE TABLE", "CREATE SEQUENCE", "CREATE OPERATOR", "CREATE DIMENSION", "CREATE VIEW", "CREATE INDEXTYPE", "CREATE TYPE", "CREATE TRIGGER", "CREATE SESSION", "CREATE SYNONYM", "CREATE PROCEDURE" ]
    }, {
      "id" : "ENFORCE_STORAGE_CONSTRAINT",
      "name" : "Enforces Storage Constraint",
      "value" : "false"
    }, {
      "id" : "INITIAL_BLOCK_SIZE",
      "name" : "Initial Storage Size",
      "value" : ""
    }, {
      "id" : "AUTO_EXTEND_BLOCK_SIZE",
      "name" : "Auto extend block size",
      "value" : ""
    }, {
      "id" : "TABLESPACE_ENCRYPTION_ALGORITHM",
      "name" : "Tablespace Encryption",
      "value" : ""
    }, {
      "id" : "SHARED_STAGE_LOCATION",
      "name" : "Staging Location",
      "value" : ""
    }, {
      "id" : "WORKING_DIRECTORY",
      "name" : "Working Directory",
      "value" : ""
    }, {
      "id" : "SCHAAS_CUSTOM_PRE_SCRIPTS_URN",
      "name" : "Pre-script",
      "value" : ""
    }, {
      "id" : "SCHAAS_CUSTOM_POST_SCRIPTS_URN",
      "name" : "Post-script",
      "value" : ""
    }, {
      "id" : "SCHEMA_PASSWORD_LIST",
      "name" : "Schema password list",
      "value" : "",
      "values" : [ ]
    }, {
      "id" : "CUSTOM_USER_SELECTED_SCRIPT_URN",
      "name" : "Custom Script URN",
      "value" : "",
      "values" : [ ]
    }, {
      "id" : "DBSERVICE_NAME",
      "name" : "Database Service Name",
      "value" : ""
    } ]
  },
  "createdOn" : null,
  "createdBy" : null,
  "modifiedOn" : null,
  "modifiedBy" : null,
  "owner" : "SYSMAN",
  "etag" : null,
  "lastModified" : null,
  "canonicalLink" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/E821074692058B5DE040F00AA37D75AB",
  "selfLink" : "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/E821074692058B5DE040F00AA37D75AB"
}

サービス・テンプレートのメタデータの表示

次の表に、サービス・テンプレートのメタデータを表示するためのGET構成を示します。

表47-156 サービス・テンプレートのメタデータを表示するためのGETリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/metadata/DBAAS/DB
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	なし
リクエスト・メソッド	GET

受け取るレスポンスの例を次に示します。

Status 200 OK
Content-Type: application/json
"metadata" : {
    "serviceFamily:DBAAS" : {
       "serviceType:DB" : {
        "options" : [ {
          "serviceFamily" : "DBAAS",
          "serviceType" : "DB",
          "type" : "CDP",
          "description" : "Create a Service Template based on Configured Deployment Procedure.",
          "name" : "<user_input>",
          "payload" : false
        }, {
          "serviceFamily" : "DBAAS",
          "serviceType" : "DB",
          "type" : "CDP",
          "description" : "Create a Service Template based on Configured Deployment Procedure and its Payload.",
          "name" : "<user_input>",
          "payload" : true,
          "payloads" : [ {
            "id" : "DBDELETE_PRESCRIPT",
            "defaultValue" : "DBDELETE_PRESCRIPT",
            "name" : "<user_input>"
          } ]
        }, {
          "serviceFamily" : "DBAAS",
         "serviceType" : "DB",
          "type" : "DP",
          "description" : "Create a Service Template based on Deployment Procedure.",
          "name" : "<user_input>",
          "payload" : false
        }, {
          "serviceFamily" : "DBAAS",
         "serviceType" : "DB",
          "type" : "DP",
          "description" : "Create a Service Template based on Deployment Procedure and its Payload.",
          "name" : "<user_input>",
          "payload" : true,
          "payloads" : [ {
            "id" : "DBDELETE_PRESCRIPT",
            "defaultValue" : "DBDELETE_PRESCRIPT",
            "name" : "<user_input>"
          } ]
        } ]
      }
      ,
      "message" : "This gives the metadata information of the different types of service templates that can be created, the executable options supported and the allowed configuration parameters.",
      "canonicalLink" : "/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/metadata/DBAAS/DB"
    }
  }
}

サービス・テンプレートの構成値の作成

サービス・テンプレートの作成に必要な構成値を取得するには、メタデータに対してPOST操作を実行します。

表47-157 サービス・テンプレートの構成値を作成するためのPOSTリクエスト構成

機能	仕様
URI	https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/admin/cfw/v1/servicetemplates/metadata/
リクエスト・ヘッダー	Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json
本文	{ "type":"CDP", "serviceFamily":"MWAAS", "serviceType":"PhysicalWLS", "name":"Provision Middleware_SYSMAN_Jul-18-2013 00-52AM" }
リクエスト・メソッド	POST

ノート:

• このペイロードは、メタデータのGETコールを介して取得します。

• ユーザーは<user_input>に適宜入力して、ServiceExecutableMetaDataEntityをレスポンスとして取得します。

• ユーザーは、値を適宜設定した自分のcreateペイロードでこのServiceExecutableMetaDataEntityを使用して、サービス・テンプレート・メタデータを作成します。

受け取るレスポンスの例を次に示します。

{
  "configurations" : [ {
    "description" : "Username for the WebLogic Server",
    "id" : "wlsUserName",
    "name" : "WebLogic Username *",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Password for the WebLogic Server",
    "id" : "wlsUserPassword",
    "name" : "WebLogic Password *",
    "required" : "false",
    "secret" : "true"
  }, {
    "description" : "Re-enter Password for the WebLogic Server",
    "id" : "wlsUserPassword2",
    "name" : "Re-enter WebLogic Password *",
    "required" : "false",
    "secret" : "true"
  }, {
    "description" : "Enter 1 for single cluster, 0 for no cluster. For physical provisioning it is auto populated based on the profile selected.  For virtual provisioning it is defaulted to 1.  Please change based on the actual topology of the assembly. ",
    "id" : "topology",
    "name" : "Topology *",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Enter 1 for 'Yes', 0 for 'No'",
    "id" : "exposeAdminURLs",
    "name" : "Expose WebLogic and FMW Console URLs to SSA User",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Enter 1 to enable, 0 to disable Load Balancer",
    "id" : "enableLoadBalancer",
    "name" : "Enable Load Balancer",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Use ',' to separate multiple target hosts",
    "id" : "hostListForScripts",
    "name" : "Hosts for Executing Scripts",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "This will be used for the above hosts",
    "id" : "namedCredforHostList",
    "name" : "Named Credential for execution of scripts",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "To execute scripts on Admin Server besides the hosts entered above, enter 1 for 'Yes', 0 for 'No'",
    "id" : "isScriptExecuteOnAdminServer",
    "name" : "Execution of Scripts on Admin Server Host",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Lower Bound for choosing Free Ports",
    "id" : "portRangeStart",
    "name" : "Port Range Start",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Upper Bound for choosing Free Ports",
    "id" : "portRangeEnd",
    "name" : "Port Range End",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Memory required by each additonal instance in GB",
    "id" : "memoryUsagePerInstance",
    "name" : "Expected Memory Consumption (For Use By Placement Logic)",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "CPU required by each additonal instance in percemtage",
    "id" : "cpuUsagePerInstance",
    "name" : "Expected CPU Utilization (For Use By Placement Logic)",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Enter memory and java arguments to start the server. Example: -Xms1280m -Xmx1280m -XX:PermSize=128m -XX:MaxPermSize=256m -Dweblogic.security.SSL.ignoreHostnameVerification=true (Physical Only)",
    "id" : "startupArguments",
    "name" : "Managed Server Startup Arguments",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Enter 1 for distributing Java Servers uniformly on available hosts for high availability or 0 for placing maximum number of Java Servers possible on a host first before provisioning on other available host (Physical Only)",
    "id" : "requireHighAvailability",
    "name" : "Distribute Java Servers on Available Hosts",
    "required" : "false",
    "secret" : "false"
  }, {
    "description" : "Root Password to override (Virtual Only)",
    "id" : "rootPwd",
    "name" : "Root Password",
    "required" : "false",
    "secret" : "true"
  }, {
    "description" : "Agent Install User Password to override (Virtual Only)",
    "id" : "agentInstallUserPwd",
    "name" : "Agent Install User Password",
    "required" : "false",
    "secret" : "true"
  }, {
    "description" : "Enter name of the host credential to use for provisioning operations (Virtual Only)",
    "id" : "namedHostCredForVirtualFlow",
    "name" : "Host credential name for virtual flow",
    "required" : "false",
    "secret" : "false"
  } ],
  "name" : "Provision Middleware_SYSMAN_Oct-02-2013 10-31AM",
  "serviceFamily" : "MWAAS",
  "serviceType" : "PhysicalWLS",
  "type" : "CDP"

セルフ・サービス・アプリケーション用のEM CLI動詞

Enterprise Managerコマンドライン・インタフェース(EM CLI)では、様々なオペレーティング・システムのテキストベースのコンソール(シェルおよびコマンド・ウィンドウ)からEnterprise Manager Cloud Control機能にアクセスできます。管理者は、SQL*Plus、OSシェル、Perl、Tclなどのカスタム・スクリプトを使用してEnterprise Manager機能をコールできるため、Enterprise Managerの機能と企業のビジネス・プロセスを容易に統合することができます。

この項では、Enterprise Managerセルフ・サービス・アプリケーション(SSA)の管理ユーザー用のEM CLI動詞に関する詳細について説明します。

概要

新しいフレームワークがリリース12.1.0.9に導入され、新しいEM CLI動詞が導入されました。以前のバージョンのフレームワークに関連付けられたEM CLI動詞は非推奨になり、ユーザーはサポートされるEM CLI動詞への移行を推奨されます。非推奨バージョンのEM CLI動詞はv1としてリストされ、サポートされるEM CLI動詞はv2としてリストされています。

• V2のSSA操作用のEM CLI動詞

• V1のSSA操作用のEM CLI動詞

PaaSインフラストラクチャ・ゾーンのEM CLI操作はすべて、EM_CLOUD_ADMINISTRATORロールを持つユーザーのみ使用できます。また、ソフトウェア・プールの操作は、EM_SSA_ADMINISTRATORロールを持つユーザーのみ実行できます。EM CLI動詞は、セキュリティ・コンテキストからユーザー情報を取得し、これらの操作を実行する権限を持つユーザーのみを検証します。

V2のSSA操作用のEM CLI動詞

次の表に、サポートされる動詞(v2)の詳細を示します。これらの動詞は、SSA管理者ユーザーのみ使用可能であり、EM_SSA_ USERロールでは使用できません。

表47-158 V2でサポートされるEM CLI動詞

動詞	説明	書式
emcli invoke_ws	Enterprise Manager Webサービスを起動します。 オプション: -wsname - リソースのURIを示します。 -method - RESTメソッドのタイプ。 -payload - json/xml入力ペイロードを示します。 -accept - ペイロード・タイプ。これらは標準のJersey値です。 -type - 標準のJerseyレスポンス・タイプ。 -param - このオプションを使用して、フォーム/問合せパラメータ値を渡します。たとえば、-param="name:value"などです。複数のパラメータを指定できます。たとえば、-param="name:value" -param="zip:12345"などです。 パラメータはファイルを通じて提供できます。ファイルから読み取るには、-param="name:tag" -input_file="tag:file.txt"のように指定します。この例では、nameパラメータはファイルfile.txtから読み取られます。 -input_file - このオプションを使用して、payloadまたはparam値をファイルで渡します。 例: emcli invoke_ws -wsname=/em/websvcs/restful/emws/core/v0/list/dataservice -method=get -param="name:Administrators" リスト・リソースを呼び出してすべての管理者を取得します。 emcli invoke_ws -wsname=/em/websvcs/restful/emws/core/v0/list/dataservice -method=get -param="name:tag" -input_file="tag:file.txt" リスト・リソースを呼び出してすべての管理者を取得します。nameパラメータはfile.txtから読み取られます。	emcli invoke_ws -wsname=<WebService Name> -method=<method name> [-payload=<Payload>] [-accept=<accept type> [-type=response type] [-param=Query Parameters] [-input_file=<Input File for payload data>]
emcli invoke_ws -method="post" -wsname="/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/" -type="application/json" -accept="application/json" -payload= 'xxxxxx'	提供されているペイロードで新規PaaSインフラストラクチャ・ゾーンを作成します。 例: emcli invoke_ws -method="post" -wsname="/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/resourceproviders/" -type="application/json" -accept="application/json" -payload='{"useExistingTarget":false, "name":"CLI_ZONE", "type":"self_service_zone", "credentials": [ {"name":"normal_credential_guid", "value": "AKM"} ], "memberTargetType": "host", "members": ["myhost2.idc.example.com"], "placementConstraints": [{"name":"MAX_CPU_UTILIZATION","value":["75"]}, {"name":"MAX_MEMORY_ALLOCATION","value":["75"]}], "characteristics": [ {"name":"EXAMPLE.SYSMAN.CFW.ORCL_GTP_CONTACT","value":["123456789"]}, {"name":"EXAMPLE.SYSMAN.CFW.ORCL_GTP_COST_CENTER","value":["IDC.NOIDA"]}, {"name":"EXAMPLE.SYSMAN.CFW.ORCL_GTP_DEPARTMENT","value":["CFW"]}, {"name":"EXAMPLE.SYSMAN.CFW.ORCL_GTP_LIFECYCLE_STATUS","value":["Test"]}, {"name":"EXAMPLE.SYSMAN.CFW.ORCL_GTP_LINE_OF_BUS","value":["ST"]}, {"name":"EXAMPLE.SYSMAN.CFW.ORCL_GTP_LOCATION","value":["IDC"]} ], "roles": ["SSA_USER"]}'	上記と同じです。
emcli get_targets	ターゲットのステータスおよびアラート情報を取得します。 オプション: -targets=name:type - 名前またはタイプは、完全な値または"%"を使用したパターン一致で指定できます。また、名前はオプションなので、タイプのみを指定できます。 -limit_rows="取得するターゲットの最大数" - 指定されていない場合、デフォルトは2000行です。 -config_search="構成検索UI名" - 検索UI名は、構成検索の表示名である必要があります。 -alerts - 各ターゲットのクリティカルおよび警告アラートの数を表示します。 -noheader - 列見出しのない表形式の出力を表示します。 -unmanaged - 管理対象外ターゲットを表示します(ステータスまたはアラート情報なし)。 -properties - 管理対象外ターゲットとプロパティを表示します。 -separator_properties="separator_properties" - separator_propertiesを使用して管理対象外ターゲットのプロパティを表示します。 -subseparator_properties="subseparator_properties" - subseparator_propertiesを使用して管理対象外ターゲットのプロパティを表示します。 -script - このオプションは、-format="name:script"と同じです。 -format - 書式指定(デフォルトは-format="name:pretty")。 -format="name:pretty"は、出力表を読取り可能な形式で出力しますが、スクリプトによる解析は意図していません。 -format="name:script" データベースの列セパレータをタブに設定し、デフォルトの行セパレータを改行に設定します。列および行セパレータ文字列を指定して、これらのデフォルトを変更できます。 -format="name:csv"は、列セパレータをカンマに、行セパレータを改行に設定します。 例: emcli get_targets 最大2000のターゲットを表示します。クリティカル列と警告列は表示されません。 emcli get_targets -limit_rows=20 最大20のターゲットを表示します。クリティカル列と警告列は表示されません。 emcli get_targets -alerts 最大2000のターゲットを表示します。クリティカル列と警告列が表示されます。 emcli get_targets -targets="oracle_database" すべての"oracle_database"ターゲットを表示します。 emcli get_targets -targets="%oracle%" タイプに文字列"oracle"を含むすべてのターゲットを表示します。 emcli get_targets -targets="database%:%oracle%" 名前が"database"で開始し、タイプに"oracle"が含まれるすべてのターゲットを表示します。 emcli get_targets -targets="database3:oracle_database" -alerts "database3"という名前のOracleデータベースに関するステータスおよびアラート情報を表示します。 emcli get_targets -config_search="Search File Systems on Hosts" -targets="oracle%:host" -alerts "Search File Systems on Hosts"という構成検索からの結果のターゲット、および名前が"oracle"で開始しタイプが"host"であるターゲットのステータスおよびアラート情報を表示します。 emcli get_targets -targets="host" -unmanaged 管理対象外ホスト・ターゲットの名前とタイプの情報を表示します。 emcli get_targets -unmanaged -properties -separator_properties=, -subseparator_properties== 指定されたセパレータを使用して管理対象外ホスト・ターゲットの名前、タイプおよびプロパティを表示します。デフォルトでは、separator_propertiesは「;」、subseparator_propertiesは「:」です。	emcli get_targets [-targets="[name1:]type1;[name2:]type2;..."] [-alerts] [-noheader] [-script | -format= [name:<pretty|script|csv>]; [column_separator:"column_sep_string"]; [row_separator:"row_sep_string"]; ] [-limit_rows="取得するターゲットの最大数。"] [-config_search="構成検索UI名"] [-unmanaged] [-properties] [-separator_properties="properties_sep_string"] [-subseparator_properties="properties_subsep_string"]
cancel_cloud_service_requests	クラウド・サービス・リクエストを取り消します。userまたはnamesオプションを指定する必要があります。両方同時に使用することはできません。 user: 削除リクエストをフィルタするために使用するユーザー名。 family: クラウド・リクエストをフィルタするために使用するサービス・ファミリ名。 ids: クラウド・リクエストをフィルタするために使用する、セミコロン(";")で区切られたリクエストIDのリスト。スケジュールされたリクエストのみ取り消すことができます。 例 emcli cancel_cloud_service_requests -user="user1" 指定されたユーザーが所有者であるすべてのスケジュール済クラウド・リクエストを取り消します。 emcli cancel_cloud_service_requests -user="user1" -family="family1" "user1"によって所有され、サービス・ファミリが"family1"であるすべてのスケジュール済クラウド・リクエストを取り消します。 emcli cancel_cloud_service_requests -user="user1" -ids="1;2" "user1"によって所有され、IDが"1"および"2"であるすべてのスケジュール済クラウド・リクエストを取り消します。	emcli cancel_cloud_service_requests -user="username" [-family="family"] [-ids="id1;id2..."]
delete_cloud_service_instances	指定されたフィルタに基づいてクラウド・サービス・インスタンスを削除します。このオプションによって、インスタンスの削除時にセルフ・サービス・ユーザーによって所有されているすべてのオブジェクトがクリーンアップされます。 user: 削除するサービス・インスタンスをフィルタするために使用するユーザー名。 family: 削除するサービス・インスタンスをフィルタするために使用するサービス・ファミリ名。 type: 削除するサービス・インスタンスをフィルタするために使用するサービス・タイプ。 例: emcli delete_cloud_service_instances -user="user1" 指定されたユーザーが所有者であるすべてのクラウド・インスタンスを削除します。 emcli delete_cloud_service_instances -user="user1" -family="family1" "user1"によって所有され、所属するサービス・ファミリが"family1"であるすべてのクラウド・インスタンスを削除します。 emcli delete_cloud_service_instances -user="user1" -type="type1" "user1"によって所有され、所属するサービス・タイプが"type"であるすべてのクラウド・インスタンスを削除します。 emcli delete_cloud_service_instances -user="user1" -family="family1" -type="type1" "user1"によって所有され、所属するサービス・ファミリが"family1"で、サービス・タイプが"type1"であるすべてのクラウド・インスタンスを削除します。	emcli delete_cloud_service_instances -user="username" [-family="family"] [-type="type"]
delete_cloud_user_objects	クラウド・サービス・インスタンスおよびリクエストを含むクラウド・ユーザー・オブジェクトを削除します。 user: ユーザー・オブジェクトをフィルタするために使用するユーザー名。 purge: 完了したリクエストをパージします。デフォルトはfalseです force: 処理中のリクエストの取消しを試行します。ジョブ・ステータスによっては、一部のリソースで手動クリーンアップが必要です。このオプションは、一度開始すると操作を停止したり元に戻すことはできないため、慎重に使用してください。 ノート: サービス・インスタンスの実行中にpurgeオプションを使用する場合、リクエストが完全に完了するのを待機してから、再度purgeオプションを使用する必要があります。 例: emcli delete_cloud_user_objects -user="user1" "user1"が所有者であるすべてのクラウド・オブジェクトを削除します。すべてのスケジュール済リクエストが取り消されます。 emcli delete_cloud_user_objects -user="user1" -purge "user1"が所有者であるすべてのクラウド・オブジェクトを削除します。すべてのスケジュール済リクエストが取り消されます。すべての完了済リクエストがパージされます。 emcli delete_cloud_user_objects -user="user1" -force "user1"が所有者であるすべてのクラウド・オブジェクトを削除します。すべてのスケジュール済リクエストが取り消されます。すべての処理中のリクエストが中断されます。	emcli delete_cloud_user_objects -user="username" [-purge] [-force]
get_cloud_service_instances	クラウド・サービス・インスタンスのリストを取得します。オプションが指定されない場合、すべてのインスタンスが出力されます。 user: サービス・インスタンスをフィルタするために使用するユーザー名。 family: サービス・インスタンスをフィルタするために使用するサービス・ファミリ名。 type: サービス・インスタンスをフィルタするために使用するサービス・ファミリ・タイプ。 例: emcli get_cloud_service_instances すべてのクラウド・インスタンスを表示します。 emcli get_cloud_service_instances -user="user1" "user1"が所有者であるすべてのクラウド・インスタンスを表示します。 emcli get_cloud_service_instances -family="family1" 所属するサービス・ファミリが"family1"であるすべてのクラウド・インスタンスを表示します。 emcli get_cloud_service_instances -type="type1" 所属するサービス・タイプが"type1"であるすべてのクラウド・インスタンスを表示します。	emcli get_cloud_service_instances [-user="username"] [-family="family"] [-type="type"]
get_cloud_service_requests	クラウド・リクエストのリストを取得します。フィルタが適用されない場合、すべてのリクエストが出力されます。両方のオプションを同時に使用することはできません。 user: クラウド・リクエストをフィルタするために使用するユーザー名。 family: クラウド・リクエストをフィルタするために使用するサービス・ファミリ名。 ids: クラウド・リクエストをフィルタするために使用する、セミコロンで区切られたリクエストIDのリスト。 例: emcli get_cloud_service_requests すべてのクラウド・リクエストを表示します。 emcli get_cloud_service_requests -user="user1" "user1"によって作成されたすべてのクラウド・リクエストを表示します。 emcli get_cloud_service_requests -family="family1" 所属するサービス・ファミリが"family1"であるすべてのクラウド・リクエストを表示します。 emcli get_cloud_service_requests -ids="1;2" リクエストIDが"1"および"2"であるすべてのクラウドを表示します。	emcli get_cloud_service_requests [-user="username"] [-family="family"] [-ids="id1;id2..."]
get_cloud_user_objects	クラウド・サービス・インスタンスおよびリクエストを含むクラウド・ユーザー・オブジェクトのリストを取得します。ユーザー・オプションが使用されない場合、すべてのオブジェクトが出力されます。 - user: ユーザー・オブジェクトをフィルタするために使用するユーザー名。 例: emcli get_cloud_user_objects すべてのクラウド・オブジェクト、クラウド・インスタンス、リクエストおよび他のオブジェクトを表示します。 emcli get_cloud_user_objects -user="user1" "user1"が所有者であるクラウド・オブジェクト、クラウド・インスタンス、リクエストおよび他のオブジェクトを表示します。	emcli get_cloud_user_objects [-user="username"]

V1のSSA操作用のEM CLI動詞

次の表に、非推奨の動詞(v1)の詳細を示します。ユーザーは、これらの動詞の使用の回避を推奨されます。これらの動詞は、SSA管理者ユーザーのみ使用可能であり、EM_SSA_ USERロールでは使用できません。

表47-159 V1のEM CLI動詞

動詞	説明	書式
create_paas_zone	PaaSインフラストラクチャ・ゾーンを作成します。 name - 作成するPaaSインフラストラクチャ・ゾーンの名前 credential - このPaaSインフラストラクチャ・ゾーンでプロビジョニングに使用するグローバル名前付き資格証明。 hosts - このPaasインフラストラクチャ・ゾーンのメンバーとして追加するホスト・ターゲットのカンマ区切りのリスト。PaaSインフラストラクチャ・ゾーンには、メンバーとしてホストまたはOracle VMゾーンのいずれかを含めることができます。 ovm_zones - このPaasインフラストラクチャ・ゾーンのメンバーとして追加するOracle VMゾーン・ターゲットのカンマ区切りのリスト。 roles - このPaaSインフラストラクチャ・ゾーンにアクセスできるSSAロールのカンマ区切りのリスト。 description - PaaSインフラストラクチャ・ゾーンの説明。 cpu_utilization - 配置ポリシー制約を使用すると、クラウド管理者はどのホストにも最大しきい値を設定できます。入力値は、1から100の間にする必要があります。指定しない場合、デフォルト値は、80パーセントになります。Oracle VMゾーン・ターゲットをメンバーとして追加する場合、パラメータは必要ありません。 memory_utilization - PaaSインフラストラクチャ・ゾーンの別の配置ポリシー制約。入力値は、1から100の間にする必要があります。指定しない場合、デフォルト値は、80パーセントになります。Oracle VMゾーン・ターゲットをメンバーとして追加する場合、パラメータは必要ありません。 例: emcli create_paas_zone -name=MyPaaSZone -credential=ABCDEF -hosts=slc03qtn.us.example.com -roles="SSA_USER_ROLE1,SSA_USER_ROLE2" -description="Test PaaS zone" -cpu_utilization=40 -memory_utilization=70 サンプル出力: PaaS Infrastructure Zone "MyPaaSZone" created successfully.	emcli create_paas_zone-name=<Name of PaaS Zone> -credential=<Global Named Credential> [-hosts=<Host1,Host2,Host3...>] [-ovm_zones=<OVMZone1,OVMZone2,OVMZone3...>] [-roles=<SsaRole1,SsaRole2,..>] [-description=<Description of PaaS Zone>] [-cpu_utilization=<Value between 1 and 100>] [-memory_utilization=<Value between 1 and 100>]
update_paas_zone	PaaSインフラストラクチャ・ゾーンを更新します。 name - 既存のPaaSインフラストラクチャ・ゾーンの名前。 credential - 更新するグローバル名前付き資格証明。 add_hosts - このPaasインフラストラクチャ・ゾーンのメンバーとして追加するホスト・ターゲットのカンマ区切りのリスト。追加するホストは、他の既存のPaaSゾーンにまだ追加されていない必要があります。 remove_hosts - このPaasインフラストラクチャ・ゾーンのメンバーとして削除するホスト・ターゲットのカンマ区切りのリスト。 add_ovm_zones - このPaasインフラストラクチャ・ゾーンのメンバーとして追加するOracle VMゾーン・ターゲットのカンマ区切りのリスト。追加するOracle VMゾーンは、他の既存のPaaSゾーンにまだ追加されていない必要があります。 remove_ovm_zones - このPaasインフラストラクチャ・ゾーンのメンバーとして削除するOracle VMゾーン・ターゲットのカンマ区切りのリスト。 add_roles - このPaaSインフラストラクチャ・ゾーンにアクセスできる、追加するSSAロールのカンマ区切りのリスト。 remove_roles - このPaaSインフラストラクチャ・ゾーンから削除するSSAロールのカンマ区切りのリスト。 description - PaaSインフラストラクチャ・ゾーンの更新後の説明。 cpu_utilization - 配置ポリシー制約を使用すると、クラウド管理者はどのホストにも最大しきい値を設定できます。入力値は、1から100の間にする必要があります。 memory_utilization - PaaSインフラストラクチャ・ゾーンの別の配置ポリシー制約。入力値は、1から100の間にする必要があります。	emcli update_paas_zone-name=<Name of PaaS Zone> [-description=<Description of PaaS Zone>] [-credential=<Global Named Credential>] [-add_hosts=<Host1,Host2,Host3...>] [-remove_hosts=<Host4,Host5...>] [-add_ovm_zones=<OVMZone1,OVMZone2,OVMZone3...>] [-remove_ovm_zones=<OVMZone4,OVMZone5...>] [-add_roles=<SsaRole1,SsaRole2,..>] [-remove_roles=<SsaRole3,SsaRole4,..>] [-cpu_utilization=<Value between 1 and 100>] [-memory_utilization=<Value between 1 and 100>]
delete_paas_zone	PaaSインフラストラクチャ・ゾーンを削除します。PaaSインフラストラクチャ・ゾーンは、関連付けられている既存のソフトウェア・プールがある場合、削除できません。 name - 削除する既存のPaaSインフラストラクチャ・ゾーンの名前。	emcli delete_paas_zone -name=<Name of PaaS Zone>
get_paas_zone_detail	PaaSインフラストラクチャ・ゾーンの詳細を取得します。 name - 名前、説明、名前付き資格証明、ホストの数、ロール、最大メモリー割当て(%)、最大CPU使用率(%)など、既存のPaaSインフラストラクチャ・ゾーンの詳細。	emcli get_paas_zone_detail -name=<Name of PaaS Zone>
create_pool	ソフトウェア・プールを作成します。 name - 作成するソフトウェア・プールの名前 target_type - 作成するソフトウェア・プールのターゲット・タイプ。 paas_zone - ソフトウェア・プールを作成するPaaSインフラストラクチャ・ゾーンの名前。 members - ソフトウェア・プールのメンバーとして追加するターゲットのカンマ区切りのリスト。 description - ソフトウェア・プールの説明。 placement_constraints - セルフ・サービス管理者がリソース使用率の上限を設定できるようにする配置制約のカンマ区切りのキー値ペア。これにより、リソース使用量の観点からソフトウェア・プールのメンバーを保護できます。プール・ターゲット・タイプの配置制約を取得する場合は、get_pool_allowed_placement_constraints動詞を参照してください。 member_constraints - 設定条件によってソフトウェア・プールへのメンバー・ターゲットの追加を制限するカンマ区切りのキー値ペア。プール・ターゲット・タイプの使用可能なメンバー制約およびその可能な値を取得する場合は、get_pool_allowed_member_constraints動詞を参照してください。 properties - ソフトウェア・プール・ターゲット・タイプに基づいて指定する必要がある追加のプロパティに対するカンマ区切りのキー値ペア。 例: emcli create_pool -name=MyDbPool -target_type=oracle_cloud_zone -paas_zone=MyPaaSZone -members=OraDb11g_home1_1_slc03qtn -description="Test Database Pool" -member_constraints="CONFIGURATION=oracle_database,VERSION=11.2.0.3.0,PLATFORM=226" -placement_constraints="MAX_INSTANCES=7" -properties="host_credential_guid=DBA449B8967AAF77E040F00A73B11F55, root_credential_guid=DBA449B8967AAF77E040F00A73B11F55" サンプル出力: Software Pool "MyDbPool" created successfully. ノート: この動詞は、DBプールに対して使用されます。スキーマ・プールのtarget_typeは、schaas_poolです。 この動詞はプロパティを必須としていませんが(SSAフレームワークが所有しているため)、プロパティは必須であり、ない場合、プールは機能しません。 スキーマ・プールの有効なプロパティ名は次のとおりです。host_credential_guid、database_credential_guidおよびgi_credential_guid。	emcli create_pool -name=<Name of Software Pool> -target_type=<Target type of Software Pool> -paas_zone=<PaaS Infrastructure Zone of Software Pool> -members=<Member1, Member2...> [-description=<Description of Software Pool>] [-placement_constraints=<constraint1=value1, constraint2=value2...>] [-member_constraints=<constraint1=value1, constraint2=value2>] [-properties=<property1=value1, property2=value2>]
update_pool	ソフトウェア・プールを更新します。 name - 既存のソフトウェア・プールの名前。 target_type - 既存のソフトウェア・プールのターゲット・タイプ。たとえば: ミドルウェア・プールの場合は"mwaas_zone"、データベース・プールの場合は"oracle_cloud_zone"、スキーマ・プールの場合は"schaas_pool"。 description - ソフトウェア・プールの説明。 add_members - ソフトウェア・プールのメンバーとして追加するターゲットのカンマ区切りのリスト。追加するターゲットは、ソフトウェア・プールのメンバー制約を満たす必要があります。 remove_members - ソフトウェア・プールから削除するメンバー・ターゲット。 placement_constraints - セルフ・サービス管理者がリソース使用率の上限を設定できるようにする配置制約のカンマ区切りのキー値ペア。これにより、リソース使用量の観点からソフトウェア・プールのメンバーを保護できます。 properties - ソフトウェア・プール・ターゲット・タイプに基づいて更新する必要があるプロパティに対するカンマ区切りのキー値ペア。	emcli update_pool -name=<Name of Software Pool> -target_type=<Target type of Software Pool> [-description=<Description of Software Pool>] [-add_members=<Member1, Member2...>] [-remove_members=<Member4, Member5...>] [-placement_constraints=<constraint1=value1, constraint2=value2...>] [-properties=<property1=value1, property2=value2>]
delete_pool	ソフトウェア・プールを削除します。ソフトウェア・プールは、関連付けられている既存のサービス・テンプレートがある場合、削除できません。 name - 既存のソフトウェア・プールの名前。 target - ソフトウェア・プールのターゲット・タイプ。	emcli delete_pool -name=<Name of Software Pool> -target_type=<Target type of Software Pool>
get_pool_detail	名前、ターゲット・タイプ、説明、PaaSインフラストラクチャ・ゾーン、メンバーの数、配置制約、メンバー制約など、ソフトウェア・プールの詳細を取得します。 name - ソフトウェア・プールの名前。 target - ソフトウェア・プールのターゲット・タイプ	emcli get_pool_detail -name=<Name of Software Pool> -target_type=mwaas_zone
get_pool_capacity	プール・エンティティのホスト当たりのCPU使用率、メモリー割当て、インスタンス数などの、ソフトウェア・プール容量の詳細を取得します。 name - ソフトウェア・プールの名前。 target_type - ソフトウェア・プールのターゲット・タイプ。 例: emcli get_pool_capacity -name=MyDbPool -target_type=oracle_cloud_zone サンプル出力: Details of Software Pool "MyDbPool" : Capacity information for Software Pool "MyDbPool" : Capacity information for Entity "slc03qtn.us.example.com" of type "host" : Storage Utilization : 29.0 : 100.0 CPU Utilization : 2.96 : 40.0 Memory Utilization : 27.68 : 70.0 Instances : 2 : 7	emcli get_pool_capacity -name=<Name of Software Pool> -target_type=<Target type of Software Pool>
get_pool_allowed_placement_constraints	指定されたプール・ターゲット・タイプの配置制約のリストを取得します。 target_type - ソフトウェア・プールのターゲット・タイプ。 例: emcli get_pool_allowed_placement_constraints -target_type=oracle_cloud_zone サンプル出力: Name Description MAX_INSTANCES Maximum Number of Instances	emcli get_pool_allowed_placement_constraints -target_type=<mwaas_zone>
get_pool_filtered_targets	渡された基準に基づき、ソフトウェア・プールの作成に使用可能なフィルタ処理済ターゲットを取得します。 target_type - ソフトウェア・プールのターゲット・タイプ。 paas_zone - フィルタ処理済ターゲットの取得先であるPaaSインフラストラクチャ・ゾーンの名前。 member_constraints - 設定条件によってソフトウェア・プールへのメンバー・ターゲットの追加を制限するカンマ区切りのキー値ペア。 例: emcli get_pool_filtered_targets -target_type=oracle_cloud_zone -paas_zone=MyPaaSZone -member_constraints="CONFIGURATION=oracle_database,VERSION=11.2.0.3.0,PLATFORM=226" サンプル出力: Target Type Target Name oracle_home OraDb11g_home1	emcli get_pool_filtered_targets -target_type=<Target type of Software Pool> -paas_zone=<PaaS Infrastructure Zone of Software Pool> -member_constraints=<constraint1=value1, constraint2=value2>
get_pool_allowed_member_constraints	ソフトウェア・プールを作成するために許容されるソフトウェア・プール・メンバー制約値のリストを取得します。 target_type - ソフトウェア・プールのターゲット・タイプ。 例: emcli get_pool_allowed_member_constraints -target_type=oracle_cloud_zone	emcli get_pool_allowed_member_constraints -target_type=<Target type of Software Pool>
get_named_credential	DBaaSプールおよびSchaaSプールの作成に使用する資格証明情報を取得します。 cred_name - 資格証明名。 cred_owner - 資格証明の所有者。 例: emcli get_named_credential -cred_name=ABCDEF -cred_owner=ORACLE サンプル出力: Output: Credential Name:test12 Credential Owner:ORACLE Credential Type:HostCreds Credential Target Type:host Credential Username:test123 Credential Scope:global Credential Guid:DBA449B8967AAF77E040F00A73B11F55 Credential Stripe:TARGETS Credential Columns: HostPassword=****** HostUserName=test12