新規サービス・インスタンスのプロビジョニング
/api/v1.1/instances/{identityId}
リクエスト
- application/json
- identityId
-
タイプ:
string
必須:true
Oracle Cloud Serviceアカウントのアイデンティティ・ドメインの名前。
object
- cloudStorageContainer
-
タイプ:
string
サービス・インスタンスをバックアップするためのストレージを提供するOracle Storage Cloud Serviceコンテナの名前。 次の形式を使用して、コンテナ名を指定します:<storageservicename>-<storageidentitydomain>/<containername>
注意:
- Oracle SOA Cloud Serviceインスタンスのバックアップに使用しているOracle Storage Cloudコンテナを他の目的に使用しないでください。 たとえば、Oracle Database Cloud - Database as a Serviceインスタンスのバックアップにも使用することはできません。 複数の目的にコンテナを使用すると、請求のエラーが生じる可能性があります。
- description
-
タイプ:
string
サービス・インスタンスに関する追加情報を提供する自由形式のテキスト。 - level
-
タイプ:
string
サービス・レベル。 有効な値は次のとおりです。PAAS
- 本番レベル・サービス。 Oracle SOA Cloud Serviceインスタンスの作成および監視、バックアップおよびリストア、パッチ適用およびスケーリングをサポートします。 これはデフォルトです。
- parameters
-
タイプ:
array
parameters次のカテゴリのコンポーネント固有の属性をグループ化します。- WebLogic Server (
"type":"weblogic"
) - Oracle Traffic Director (
"type":"otd"
)
- WebLogic Server (
- provisionOTD
-
タイプ:
boolean
デフォルト値:false
ロード・バランサを有効化するかどうかを指定するフラグ。 Oracle SOA Cloud Serviceに対して複数の管理対象サーバーを構成する場合、この値のデフォルトはtrue
です。 それ以外の場合、デフォルトはfalseです。 - publicNetwork
-
タイプ:
string
Oracle SOA Cloud Service REST APIがアクセスされるネットワークへのパス。 - serviceName
-
タイプ:
string
Oracle SOA Cloud Serviceインスタンスの名前。 サービス名の条件は次のとおりです。- 50文字を超えることはできません。
- 文字で始まる必要があります。
- 文字、数字またはハイフンのみ使用できます。
- それ以外の特殊文字を含むことはできません。
- アイデンティティ・ドメイン内で一意である必要があります。
デフォルトでは、サービス・インスタンスのドメインとクラスタの名前は、サービス・インスタンス名(
serviceName
)の最初の8文字から生成され、それぞれ次の形式を使用します。first8charsOfServiceInstanceName_domain
first8charsOfServiceInstanceName_cluster
- subscriptionType
-
タイプ:
string
請求単位。 有効な値は次のとおりです。MONTHLY
- 使用した時間数に関係なく、月全体に対する固定価格を支払います。
- topology
-
タイプ:
string
トポロジ名。 有効な値は次のとおりです。osb
- Oracle Service Busトポロジ。soa
- サービス指向アーキテクチャ。soaosb
- OSBおよびSOAの両方のトポロジ。b2b
- B2B (Business to Business)およびSOAの両方のトポロジ。mft
- MFT (Managed File Transfer)トポロジ。insight
- Oracle Business Insight (Business Activity Monitoring)トポロジ。
object
- adminPassword
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
に設定されている場合にのみこの属性が有効になります。WebLogic Server管理者のパスワード。 パスワードは次の要件を満たしている必要があります。
- 文字で始まること
- 8文字以上30文字以下の長さであること
- 文字、1つ以上の数字、およびオプションで任意の数の特殊文字(ドル記号($)、ポンド記号(#)およびアンダースコア(_))が含まれていること。
- adminUserName
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
に設定されている場合にのみこの属性が有効になります。WebLogic Server管理者のユーザー名。 名前には8文字以上128文字以下の長さが必要で、次の文字を含めることはできません。
- タブ
- 大カッコ
- 丸カッコ
- 次の特殊文字: 左山カッコ(<)、右山カッコ(>)、アンパサンド(&)、ポンド記号(#)、パイプ記号(|)および疑問符(?)。
- connectString
-
タイプ:
string
データベースへの接続に使用される文字列。接続文字列は次のいずれかの形式で入力する必要があります。
host:port/SID
host:port/serviceName
- dbaName
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
に設定されている場合にのみこの属性が有効になります。Oracle Database Cloud - Database as a Serviceインスタンス管理者のユーザー名。
Oracle WebLogic Server 11g (10.3.6)に基づいたサービス・インスタンスの場合、この値はDBAロールを持つデータベース・ユーザーに設定されている必要があります。 デフォルト・ユーザー
SYSTEM
、またはDBA
ロールが付与されたユーザーを使用できます。Oracle WebLogic Server 12c (12.1.3)に基づいたサービス・インスタンスの場合、この値はSYSDBAシステム権限を持つデータベース・ユーザーに設定されている必要があります。 デフォルト・ユーザー
SYS
、またはSYSDBA
権限が付与されたユーザーを使用できます。 - dbaPassword
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
に設定されている場合にのみこの属性が有効になります。Oracle Database Cloud - Database as a Serviceインスタンス管理者のパスワード。
- dbNetwork
-
タイプ:
string
Oracle SOA Cloud Serviceインスタンスがデータベースにアクセスするためのネットワークへのパス。 - listenerPortsEnabled
-
タイプ:
boolean
デフォルト値:false
注意: コンポーネントのtype
がotd
に設定されている場合にのみこの属性が有効になり、weblogic
の場合は無効です。ロード・バランサ上でリスナー・ポートを有効にするかどうかを指定するフラグ。 このフラグのデフォルトは
true
です。 - loadBalancingPolicy
-
タイプ:
string
注意: コンポーネントのtype
がotd
に設定されている場合にのみこの属性が有効になり、weblogic
の場合は無効です。ロード・バランサへのリクエストのルーティングに使用するポリシー。 有効なポリシーは次のとおりです。
least_connection_count
- 各新規リクエストを管理対象サーバーに最小接続数で渡します。 このポリシーは、管理対象サーバーが完全に停止したときに配布を平滑化する場合に有用です。 リクエストの扱いにより高い処理能力を持つ管理対象サーバーは、次第に受信する接続が増加します。 これはデフォルトです。least_response_time
- 最速のレスポンス時間で、管理対象サーバーに新しいリクエストをそれぞれ渡します。 このポリシーは、管理対象サーバーがネットワーク間で分散している場合に有用です。round_robin
- 各新規リクエストを行内の次の管理対象サーバーに渡すことで、接続数やレスポンス時間に関係なく、すべての管理対象サーバーに対して均等にリクエストを分配します。
- managedServerCount
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
またはotd
に設定されている場合にのみこの属性が有効になります。管理対象サーバーの数。 許可されている値は、1、2または4です。
- otdAdminPassword
-
タイプ:
string
注意: コンポーネントのtype
がotd
に設定されている場合にのみこの属性が有効になります。Oracle Traffic Director管理者のパスワード。 パスワードは次の要件を満たしている必要があります。
- 文字で始まること
- 8文字以上30文字以下の長さであること
- 文字、1つ以上の数字、およびオプションで任意の数の特殊文字(ドル記号($)、ポンド記号(#)およびアンダースコア(_))が含まれていること。
この値が指定されていない場合のデフォルト値はWebLogic Server管理者のパスワードです。
- otdAdminUserName
-
タイプ:
string
注意: コンポーネントのtype
がotd
に設定されている場合にのみこの属性が有効になります。Oracle Traffic Director管理者のユーザー名。 名前には8文字以上128文字以下の長さが必要で、次の文字を含めることはできません。
- タブ
- 大カッコ
- 丸カッコ
- 次の特殊文字: 左山カッコ(<)、右山カッコ(>)、アンパサンド(&)、ポンド記号(#)、パイプ記号(|)および疑問符(?)。
この値が指定されていない場合のデフォルト値はWebLogic Server管理者のユーザー名です。
- shape
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
またはotd
に設定されている場合にのみこの属性が有効になります。必要なコンピューティング形態。 形態では、Oracle Compute Unit (OCPU)の数およびメモリー量(RAM)を定義します。
weblogic
の有効な形態は次のとおりです。- oc1m: 1個のOCPU、15GBのメモリー
- oc2m: 2個のOCPU、30GBのメモリー
- oc3m: 4個のOCPU、60GBのメモリー
- oc4m: 8個のOCPU、120GBのメモリー
- oc5m: 16個のOCPU、240GBのメモリー
otd
の有効な形態は次のとおりです。- oc3: 1個のOCPU、7.5GBのメモリー
- oc4: 2個のOCPU、15GBのメモリー
- oc5: 4個のOCPU、30GBのメモリー
- oc6: 8個のOCPU、60GBのメモリー
- oc7: 16個のOCPU、120GBのメモリー
形態の詳細は、『Oracle Compute Cloud Serviceの使用』のマシン・イメージとシェイプについてに関する項を参照してください。 カスタム容量単位のプロパティの定義に関するガイドラインは、『Oracle SOA Cloud Serviceの使用』のOracle SOA Cloud Service-Coherenceインスタンスのカスタム容量単位と高度な構成についてに関する項を参照してください。
- type
-
タイプ:
string
一連のパラメータが適用されるコンポーネント・タイプ。 有効な値は次のとおりです。weblogic
- Oracle WebLogic Serverotd
- Oracle Traffic Director (ロード・バランサ)
- version
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
に設定されている場合にのみこの属性が有効になり、otd
の場合は無効です。Oracle WebLogic Serverソフトウェアのバージョン。 有効な値は、
12.1.3.0.4
および10.3.6.0.9
です。 - VMsPublicKey
-
タイプ:
string
注意: コンポーネントのtype
がweblogic
またはotd
に設定されている場合にのみこの属性が有効になります。公開鍵を参照するコンピューティングSSH鍵オブジェクトの名前。 SSH公開鍵/秘密鍵ペアは標準のSSH鍵生成ツールを使用して生成します。
ロード・バランサに対して指定されていない場合、この値のデフォルトは、WebLogic Serverに対して指定されている
VMsPublicKeyName
オブジェクトになります。注意: WebLogic Serverとロード・バランサの両方に対して、
VMsPublicKey
またはVMsPublicKeyName
のいずれか1つの属性を指定する必要があります。
レスポンス
- application/json
- text/plain
例
次の例では、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによってOracle SOA Cloud Serviceインスタンスを作成する方法を示しています。詳細は、「cURLの使用」を参照してください
Oracle SOA Cloud Serviceコンソールの概要に関する項も参照してください。
cURLコマンド
curl -i -X POST -u joe@example.com:Welcome123! -d @create.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain
リクエスト本文の例
JSON形式のリクエスト本文の例を次に示します。
{ "serviceName": "MyFirstInstance", "level": "PAAS", "description": "My first instance using the REST API", "provisionOTD": true, "cloudStorageContainer" : "yourRemoteStorage", "publicNetwork":"yourPublicNetwork", "parameters": [ { "version": "12.1.3", "edition":"SUITE", "managedServerCount":"1", "templates":"full", "adminUserName": "weblogic", "adminPassword": "welcome1", "connectString" : "yourDBConnectString", "dbaName" : "yourDBUsername", "dbaPassword" : "yourDBPassword", "dbNetwork" : "yourDBNetwork", "shape": "oc1m", "VMsPublicKey": "ssh-rsa keystring xperiment", "type": "weblogic" }, { "listenerPortsEnabled": true, "loadBalancingPolicy": "LEAST_CONNECTION_COUNT", "otdAdminUserName": "otdadmin", "otdAdminPassword": "welcome1", "shape": "oc3", "type": "OTD" } ] }
レスポンス・ヘッダーの例
レスポンス・ヘッダーの例を次に示します。
Locationヘッダーは、サービス・インスタンス作成リクエストのステータスにアクセスする際に使用できるRESTリソースを返します。 詳細は、「サービスのプロビジョニング・ステータスの取得」を参照してください。
HTTP/1.1 100 Continue HTTP/1.1 202 Accepted Date: Fri, 23 Jan 2015 22:18:26 GMT Location: https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/status/create/job/5261 Content-Length: 0 Content-Type: application/json