次の項では、Oracle Virtual Assembly BuilderデプロイヤWebサービスAPIにおける管理操作について説明します。
次の定義は、各操作の「HTTP問合せ文字列における他のパラメータ」の項に示すパラメータに適用されます。
1..1 : パラメータは必須で、指定できるのは1回だけです。
1..* : パラメータは必須で、複数回指定できます。
0..1 : パラメータはオプションで、指定する場合は1回だけ指定できます。
0..* : パラメータはオプションで、指定する場合は複数回指定できます。
操作のレスポンスのタイプは、Webサービス・スキーマの定義に対応します。付録A「Webサービス・スキーマ」を参照してください。
この操作によって、ターゲットに指定されたユーザーのユーザー構成情報が追加されます。AddTargetUser
の目的は、ユーザーがターゲットを使用することを指定することに加えて、ターゲットと対話する際に使用されるユーザー固有の情報を、必要に応じて指定することです。
Oracle VMで使用されるデプロイヤの場合、AddTargetUser
は、ターゲットに対するアクセス権限を付与するためにクラウド管理者によって呼び出されます。この場合、ターゲットの作成時にクラウド管理者が仮想化環境への資格証明を提供するため、他のプロパティは提供されません。資格証明は保護される必要があるため、一般的なデプロイヤの場合は、アプリケーション管理者がこの操作を呼び出すことは許可されません。
Oracle Exalogicにおけるデプロイヤの場合は、ターゲットを使用するアプリケーション管理者によってAddTargetUser
が呼び出されます。この場合、ユーザーはターゲットにアクセスするために自分の資格証明を指定します。
HTTP問合せ文字列における他のパラメータ
target 1..1
user 1..1
ユーザーのプロパティとして他のパラメータが使用されます。
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: AddTargetUserResult
必要なロールおよび権限
Oracle VMデプロイヤでは、クラウド管理者のみがAddTargetUser
の呼出しを許可されます。Oracle Exalogicデプロイヤでは、すべてのアプリケーション管理者がAddTargetUser
を呼び出せます。
このような違いがあるのは、通常、資格証明はターゲット構成で提供され保護されている必要がありますが、Oracle Exalogicデプロイヤでは、ユーザーが自分の資格証明を指定するためです。
この操作を呼び出すクラウド管理者は、自身以外のユーザー名を指定できます。
この操作によって、デプロイメント操作のターゲットを作成します。この呼出しには接続情報を定義する構成情報が含まれていますが、ターゲットのタイプによって、資格証明情報が含まれる場合と含まれない場合があります。特に、Oracle VM 3.0のターゲットの場合は資格証明が指定されますが、Oracle Exalogicのターゲットの場合、ここでは資格証明が指定されず、後でAddTargetUser
操作で指定する必要があります。
HTTP問合せ文字列における他のパラメータ
name 1..1
type 1..1
default 0..1(デフォルト値はfalse)
ターゲットのプロパティとして、他のパラメータが使用されます。
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: CreateTargetResult
必要なロールおよび権限
この操作は、クラウド管理者によってのみ呼出し可能です。
この操作によって、デプロイメント・ターゲットおよびすべての構成情報が削除されます。このターゲットがあるユーザーまたはすべてのユーザーのデフォルトであった場合、このデフォルト設定は解除されます。.
HTTP問合せ文字列における他のパラメータ
name 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: DeleteTargetResult
必要なロールおよび権限
この操作は、クラウド管理者によってのみ呼出し可能です。
この操作によって、ターゲットの構成情報を記述します。
HTTP問合せ文字列における他のパラメータ
target 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: DescribeTargetConfigurationsResult
必要なロールおよび権限
この操作は、クラウド管理者によってのみ呼出し可能です。
この操作によって、指定されたタイプのデプロイメント操作について作成されたターゲットがリストされます。
HTTP問合せ文字列における他のパラメータ
type 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: ListTargetsResult
必要なロールおよび権限
この操作は、アプリケーション管理者またはクラウド管理者によって呼出し可能です。
この操作によって、指定されたターゲットのユーザーがリストされます。
HTTP問合せ文字列における他のパラメータ
target 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: DescribeTargetUsersResult
必要なロールおよび権限
この操作は、アプリケーション管理者またはクラウド管理者によって呼出し可能です。
この操作によって、指定されたユーザーのターゲットがリストされます。
HTTP問合せ文字列における他のパラメータ
user 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: DescribeUserTargetsResult
必要なロールおよび権限
この操作は、アプリケーション管理者またはクラウド管理者によって呼出し可能です。
この操作によって、すべてのユーザーに対し、そのタイプのデフォルトのターゲットが取得されます。
HTTP問合せ文字列における他のパラメータ
type 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: GetDefaultTargetResult
必要なロールおよび権限
この操作は、アプリケーション管理者またはクラウド管理者によって呼出し可能です。
この操作によって、指定されたターゲット名のターゲット・タイプ(exalogic
またはovm
)が取得されます。
HTTP問合せ文字列における他のパラメータ
target 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: GetTargetTypeResult
必要なロールおよび権限
この操作は、アプリケーション管理者またはクラウド管理者によって呼出し可能です。
この操作によって、ターゲットからユーザーが削除されます。
HTTP問合せ文字列における他のパラメータ
target 1..1
user 1..*
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: RemoveTargetUsersResult
必要なロールおよび権限
この操作は、アプリケーション管理者またはクラウド管理者によって呼出し可能です。
クラウド管理者ロールを保持する呼出し元は、メソッドを呼び出して自分以外のユーザー名を指定できます。管理者以外のユーザーは、自分のユーザー名の指定のみが可能です。
この操作によって、すべてのユーザーに対し、そのタイプのすべてのターゲットに関するデフォルト・ターゲットとして、指定した名前のターゲット・タイプが設定されます。ユーザーがOracle Virtual Assembly Builder操作を呼び出し、指定されたターゲットがない、またはそのターゲット・タイプのsetUserDefaultTarget
を以前に呼び出したことがない場合は、指定されたターゲットが使用されます。
HTTP問合せ文字列における他のパラメータ
name 1..1
HTTPメソッド
GET
リクエストのコンテンツ
N/A
レスポンスのコンテンツ
text/xml要素: SetDefaultTargetResult
必要なロールおよび権限
この操作は、クラウド管理者によってのみ呼出し可能です。