注意:
SSAプラグイン・リリース12.1.0.9では、v2フレームワークと呼ばれる新しいフレームワークがREST APIに導入されています。新しいフレームワークは異なるアプローチと署名から構成されるため、REST APIは以前のフレームワークと比較した場合にも異なります。以前のフレームワーク(v1)は非推奨になり、ユーザーはv2 REST APIおよびEM CLI動詞への移行を推奨されます。
v2では、セルフ・サービス・ポータル・アプリケーションのREST APIは一般にSSAユーザーによって使用されます。これらのREST APIは、一般に.../ssa/...
の形式です。たとえば、/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/
などです。管理機能のREST API (.../admin/...
形式)は、ゾーンやテンプレートの作成など、一般にクラウドまたはSSAの管理者によって実行されるSSAポータル設定を構成するREST APIです。この章では、SSAユーザーREST APIについて説明します。
この章の項は次のとおりです。最初の2つの項では、この章で説明するすべてのv2およびv1 REST APIのサマリーを示し、その後の項では、ユーザー・プリファレンス・リソースとリクエスト・スケジュール・リソースの詳細やそれらのREST APIについて説明します。
次の表に、v2フレームワークについてこの章で説明するすべてのユーザー・プリファレンスおよびリクエスト・スケジュールREST APIをまとめています。
表50-1 V2のユーザー・プリファレンスおよびリクエスト・スケジュールREST APIのサマリー
リソース | データ・モデル | GET | POST | PUT | DELETE |
---|---|---|---|---|---|
共通RESTエンティティ |
該当なし |
サポート対象外 |
サポート対象外 |
サポート対象外 |
|
カタログ |
該当なし |
サポート対象外 |
サポート対象外 |
サポート対象外 |
|
サービス・タイプ |
該当なし |
サポート対象外 |
サポート対象外 |
サポート対象外 |
|
サービス・コレクション |
サポート対象外 |
サポート対象外 |
|||
サービス提供 |
サポート対象外 |
サポート対象外 |
サポート対象外 |
||
リクエスト・メタデータ |
サポート対象外 |
サポート対象外 |
サポート対象外 |
||
サービス・リクエスト |
サポート対象外 |
サポート対象外 |
サポート対象外 |
||
サービス・リクエスト |
該当なし |
サポート対象外 |
|||
サービス・インスタンス |
サポート対象外 |
サポート対象外 |
|||
割当て制限使用量 |
該当なし |
サポート対象外 |
サポート対象外 |
サポート対象外 |
|
ユーザー・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
サポート対象外 |
|
一般ユーザー・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
||
サービス・ユーザー・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
サポート対象外 |
|
サービス・ファミリ・ユーザー・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
||
サービス・タイプ・ユーザー・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
注意:
この表の「サポート」は、リソースに対してその操作がサポートされていることを示します。ただし、この章には操作の例は含まれません。
次の表に、v1フレームワークについてこの章で説明するすべてのユーザー・プリファレンスおよびリクエスト・スケジュールREST APIをまとめています。
表50-2 V1のユーザー・プリファレンスおよびリクエスト・スケジュールREST APIのサマリー
リソース | データ・モデル | GET | POST | PUT | DELETE |
---|---|---|---|---|---|
一般プリファレンス |
サポート対象外 |
サポート対象外 |
|||
サービス・プリファレンス |
サポート対象外 |
サポート対象 |
サポート対象外 |
||
データベース・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
||
ミドルウェア・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
||
テスト・プリファレンス |
該当なし |
サポート対象外 |
サポート対象外 |
||
サービス・リクエスト・コレクション |
サポート対象外 |
サポート対象外 |
サポート対象外 |
||
サービス・リクエスト・エンティティ |
サポート対象外 |
注意:
この表の「サポート」は、リソースに対してその操作がサポートされていることを示します。ただし、この章には操作の例は含まれません。
この項では、クラウド・フレームワーク・リソースへの共通RESTエンティティについて説明します。これらのエンティティは新しいクラウド・フレームワーク(CFW) v2に固有です。
Cfwリソースは、クラウド・フレームワーク・リソースのベース・クラスです。このリソース・フィールドは、すべての単一リソースに共通です。
表50-3 Cfwリソース・データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
description |
文字列 |
リソースの説明。 |
createdOn |
文字列 |
作成日。 |
createdBy |
文字列 |
作成者の詳細。 |
modifiedOn |
文字列 |
最終変更日。 |
modifiedBy |
文字列 |
変更者の詳細。 |
owner |
文字列 |
リソースの所有者を示します。 |
e-Tag |
文字列 |
Etagを示します。 |
lastModified |
文字列 |
最終変更の詳細。 |
canonicalLink |
Cfwリンク |
リソースの共通リンクを示します。 |
Cfwリンクは、リソースへのリンクのベース・クラスです。
表50-4 Cfwリンク・データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
href |
文字列 |
URIまたはURIテンプレートを示します。値がURIテンプレートの場合は、templatedプロパティをtrueにする必要があります。 |
templated |
ブール値 |
|
rel |
文字列 |
コンシューマが実際のリンク詳細を取得するために(typeプロパティに加えて)セカンダリ・キーとして検索できるリンク・リレーションの名前を示します( |
profile |
文字列 |
ターゲット・リソースを遅延させるときに期待されるリソースを説明するJsonスキーマを示します。 |
method |
文字列 |
リンクのターゲットをリクエストする方法。 |
mediaType |
文字列 |
リンク・ターゲットの説明。 |
Cfw値記述子は、動的データを定義します。
表50-5 Cfw値記述子データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
id |
文字列 |
IDを示します。 |
name |
文字列 |
名前を示します。 |
value |
文字列 |
値を示します。 |
defaultValue |
文字列 |
デフォルト値を示します。 |
description |
文字列 |
説明を提供します。 |
displayName |
文字列 |
表示名を提供します。 |
required |
ブール値 |
必須かどうかを示します。 |
secret |
ブール値 |
秘密かどうかを示します。 |
type |
文字列 |
タイプを示します。 |
unitOfmeasurement |
文字列 |
単位を示します。 |
values |
リスト |
値リストを提供します。 |
subvalues |
リスト<CfwValueDescriptor> |
サブ値のリストを提供します。 |
subtype |
文字列 |
値内の要素のタイプを提供します。 |
この項では、SSAユーザーのカタログAPIについて説明します。
次の表に、カタログAPIでサポートされる操作を示します。
表50-6 カタログAPIでサポートされる操作
メソッド | URI | 説明 |
---|---|---|
GET |
/em/websvcs/restful/extws/cloudservices/cfw/API |
使用可能なREST APIカタログへのリンクを返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/cfw/API/v2 |
ユーザー・タイプ別のREST APIカタログへのリンクを返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/API |
ユーザーREST APIカタログを返します。 |
この項には、カタログAPIの例が記載されています。次のREST API例について説明します。
次の表に、使用可能なREST APIカタログの詳細を表示するためのGET構成を示します。
表50-7 使用可能なREST APIカタログの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/cfw/API |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "items": [ { "href": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/cfw/API/v1", "description": "API Summary for version V1" }, { "href": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/cfw/API/v2", "description": "API Summary for version V2" } ], "totalResults": 2 }
次の表に、ユーザー・タイプ別のREST APIカタログの詳細を表示するためのGET構成を示します。
表50-8 ユーザー・タイプ別のREST APIカタログの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/cfw/API/v2 |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "items": [ { "href": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/API", "description": "APIs for Self Service Application for version V2", "type": "SSA" }, { "href": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/admin/cfw/v2/API", "description": "APIs for administrative functions for version V2", "type": "Admin" } ], "goBack": "https://xx.idc.example.com:4473/em/websvcs/restful/extws/cloudservices/cfw/API", "totalResults": 2 }
次の表に、ユーザーAPIカタログの詳細を表示するためのGET構成を示します。
表50-9 ユーザーAPIカタログの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/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://bxx.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/userprefer ences/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 }
この項では、サービス・タイプREST APIについて説明します。
SSAユーザーのサービス・タイプREST APIは次のとおりです。
GETリクエストで問合せパラメータservicefamily
をオプションで使用し、特定のサービス・ファミリ・タイプ用に出力をフィルタできます。
次の表に、サービス・タイプの詳細を表示するためのGET構成を示します。
表50-10 サービス・タイプの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/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/ssa/cfw/v2/servicetypes" }, "selfLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicetypes" } }
サービス・リソースは、サービス・コレクション・リソース、サービス提供リソースおよびリクエスト・メタデータ・リソースで定義されます。これらのリソースについて次に説明します。
この項の内容は、次のとおりです。
サービス・コレクション・リソースは、oracle.sysman.cfw.cloudAPI.common.CfwCollectionリソースの拡張です。
表50-11 サービス・コレクション・データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
name |
文字列 |
コレクションの名前です。値は"Services"です。 |
type |
文字列 |
コレクションのタイプ。値は"Services"です。 |
totalResults |
整数 |
アイテムの総数。 |
cfwItems |
リスト<ServiceOffering> |
|
canonicalLink |
Cfwリンク |
共通リンクを示します。 |
selfLink |
Cfwリンク |
セルフ・リンクを示します。 |
サービス提供リソースは、oracle.sysman.cfw.cloudAPI.common.CfwResourceリソースの拡張です。サービス提供リソースは、ユーザーがサービス・インスタンスのプロビジョニングに使用できる、ユーザーが使用可能なサービス提供をカプセル化します。
表50-12 サービス提供データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
id |
文字列 |
サービス提供のIDを示します。 |
name |
文字列 |
サービス提供の名前。 |
displayName |
文字列 |
サービス提供の表示名。 |
guid |
文字列 |
サービス提供のGUID。 |
serviceType |
文字列 |
サービス・タイプを示します。 |
serviceFamily |
文字列 |
サービス・ファミリを示します。 |
description |
文字列 |
サービス提供の説明。 |
modifiedOn |
文字列 |
変更の日付を示します。 |
lastModified |
文字列 |
最終変更の日付を示します。 |
meta |
文字列 |
サービス提供のメタ詳細。 |
canonicalLink |
Cfwリンク |
共通リンクを示します。 |
selfLink |
Cfwリンク |
セルフ・リンクを示します。 |
リクエスト・メタデータ・リソースは、oracle.sysman.cfw.cloudAPI.common.CfwResourceの拡張です。リクエスト・メタデータは、サービス・インスタンスの作成に必要なデータをカプセル化します。返されるこのレスポンスは、ユーザーによって適切な値が入力され、サービス・インスタンスの作成に必要な"POST"ペイロードの場合と同様に使用されます。
表50-13 リクエスト・メタデータ・データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
instanceName |
文字列 |
サービス・インスタンスの名前。 |
schedule |
スケジュール・エンティティ |
リクエストのスケジュール。 |
configurations |
リスト<CfwValueDescriptor> |
構成のリストを提供します。 |
characteristics |
リスト<Characteristic> |
特性のリストを提供します。 |
次の表に、サービス・リソースでサポートされる操作を示します。
表50-14 サービス・リソースでサポートされる操作
メソッド | URI | 説明 |
---|---|---|
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services |
サービス提供のリストを返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{serviceguid} |
サービス提供の詳細を返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{serviceguid}/metadata |
サービス提供メタデータの詳細を返します。 |
POST |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services |
サービス・インスタンスの作成のためのリクエストを 発行します。 |
この項では、サービス・リソースの一部であるREST APIを示します。次のREST APIタスクについて説明します。
次の表に、サービス・リソースの詳細を表示するためのGET構成を示します。
表50-15 サービス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name": "Services", "type": "Service", "totalResults": 4, "cfwItems": [ { "id": "1", "name": "ORACLE_NIMBULA_ORCHESTRATION_TEMPLATE", "displayName": "Orchestration", "guid": "04FA3C08D3F3398AE053CE74B10A52F3", "serviceType": "ORACLE_NIMBULA_ORCHESTRATION_SERVICE", "serviceFamily": "NIMBULA_INFRASTRUCTURE", "description": "Create a set of Oracle VM instances with customized configuration for multi-tier applications", "meta": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servies/04FA3C08D3F3398AE053CE74B10A52F3/metadata", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FA3C08D3F3398AE053CE74B10A52F3" } }, { "id": "2", "name": "ORACLE_NIMBULA_SIMPLE_ORCHESTRATION_TEMPLATE", "displayName": "Simple Orchestration", "guid": "04FA3C08D3F6398AE053CE74B10A52F3", "serviceType": "ORACLE_NIMBULA_ORCHESTRATION_SERVICE", "serviceFamily": "NIMBULA_INFRASTRUCTURE", "description": "Create one or more Oracle VM instances with default configuration and minimum inputs", "meta": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FA3C08D3F6398AE053CE74B10A52F3/metadata", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FA3C08D3F6398AE053CE74B10A52F3" } }, { "id": "44", "name": "MY DB Schema", "displayName": "MY DB Schema", "guid": "04FBAB67376E77D1E053CE74B10A9AA8", "serviceType": "SCHEMA", "serviceFamily": "DBAAS", "description": "My DB Schema", "meta": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FBAB67376E77D1E053CE74B10A9AA8/metadata", "canonicalLink": { 2.3 9 "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FBAB67376E77D1E053CE74B10A9AA8" } }, { "id": "41", "name": "My WebLogic Template", "displayName": "My WebLogic Template", "guid": "04FB7EEED9A03798E053CE74B10A753D", "serviceType": "WLAAS", "serviceFamily": "MIDDLEWARE_CFW", "description": "My Web Logic Template", "meta": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FB7EEED9A03798E053CE74B10A753D/metadata", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FB7EEED9A03798E053CE74B10A753D" } } ], "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/" }, "selfLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/" } }
次の表に、サービス提供リソースの詳細を表示するためのGET構成を示します。
表50-16 サービス提供リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{serviceguid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "id": "42", "name": "My Xaas Remote Server", "displayName": "My Xaas Remote Server", "guid": "04FBAB67376677D1E053CE74B10A9AA8", "serviceType": "CFW_SAMPLEXAAS_REMOTESERVER_SERVICE", "serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY", "description": "My Xaas Remote Server", "createdOn": "2014-10-09T10:13:34Z", "modifiedOn": "2014-10-09T10:13:34Z", "lastModified": "2014-10-09T10:13:34Z", "meta": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FBAB67376677D 1E053CE74B10A9AA8/metadata", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FBAB67376677D 1E053CE74B10A9AA8" } }
次の表に、リクエスト・メタデータの詳細を表示するためのGET構成を示します。
表50-17 リクエスト・メタデータの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/{serviceguid}/metadata |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "characteristics": [ { "displayName": "Self Service Zone", "name": "ORACLE.SYSMAN.SXAAS.CFW_SAMPLEXAAS_RSRC_POOL", "possibleValues": [ { "name": "my_paaszone", "value": "1C3A932A9089BBEC27A63EF389C7DF24" } ] } ], "configurations": [ { "name": "temp_param2", "type": "STRING", "value": "", "required": false, "secret": false }, { "name": "USER_NAME", "type": "STRING", "description": "User Name (cannot be any of Oracle default accounts) used to login to the requested database", "value": "", "required": false, "secret": false }, { "name": "temp_param1", "type": "STRING", "value": "", "required": false, "secret": false }, { "name": "USER_PASSWORD", "type": "STRING", "description": "User Password to login to the given User Name database account", "required": false, "secret": true } ], "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FBAB67376677D1E053CE74B10A9AA8/metadata" }, "selfLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services/04FBAB67376677D1E053CE74B10A9AA8/metadata" }, "instanceName": "<user-input>" }
次の表に、サービス・インスタンスを作成するためのPOST構成を示します。
表50-18 サービス・インスタンスを作成するためのPOSTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/services |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "name":"Xaas RemoteServer Request", "offeringId":"04FBAB67376677D1E053CE74B10A9AA8", "instanceName":"Xaas RemoteServer", "schedule": { "scheduleStartTime":"2015-01-12T16:48:10ZAmerica/Los_Angeles", "scheduleEndTime":"2015-31-12T16:48:10ZAmerica/Los_Angeles" }, "characteristics": [ { "name":"ORACLE.SYSMAN.SXAAS.CFW_SAMPLEXAAS_RSRC_POOL", "value":"1C3A932A9089BBEC27A63EF389C7DF24" } ], "configurations": [ { "name":"temp_param2", "value":"val2" }, { "name":"USER_NAME", "value":"user" }, { "name": "temp_param1", "value":"val1" }, { "name": "USER_PASSWORD", "value":"passwords" } ] } |
リクエスト・メソッド |
POST |
受け取るレスポンスの例を次に示します。
{ "requests":[ { "id":"16", "actionName":"CREATE", "canonicalLink":{ "href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/1 6" } }, { "id":"17", "actionName":"DELETE", "canonicalLink":{ "href":"https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/1 7" } } ] }
EM_SSA_USERロールを持つユーザーは、スケジュール済状態のリクエストを再スケジュールまたは取り消すことができます。
すべてのREST APIは、トップ・レベルURI /extws/cloudservices/ssa/cfw/v1/から利用できます。
サービス・リクエスト・リソースは、oracle.sysman.cfw.cloudAPI.pojo.request.RequestSummaryの拡張です。リクエストにより、SSAユーザーはタスクを即時に開始するか、後で実行できます。
表50-19 V2のサービス・リクエスト・データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
requestType |
文字列 |
リクエストのタイプ。 |
serviceFamily |
文字列 |
サービス・ファミリの名前。 |
serviceType |
文字列 |
サービス・タイプの名前。 |
startDate |
文字列 |
リクエストの開始日。 |
endDate |
文字列 |
リクエストの終了日。 |
lastModifiedDate |
文字列 |
リクエストの最終変更日。 |
timeZone |
文字列 |
リクエストのタイム・ゾーン。 |
displayName |
文字列 |
リクエストの表示名。 |
actionName |
文字列 |
リクエスト・アクションの名前。 |
description |
文字列 |
リクエストの説明。 |
submissionDate |
文字列 |
リクエストの発行日。 |
submittedBy |
文字列 |
リクエストを発行したユーザーの名前。 |
executionLogs |
文字列 |
実行ログ。 |
status |
リクエスト・ステータス |
リクエストのステータス。 |
サービス・リクエスト・コレクションは、すべてのアクセス可能なサービス・リクエスト・リソースのクラウド管理者ビューを表すコレクション・リソースです。次の表では、v1のサービス・リクエスト・コレクション・データ・モデルについて説明します。
表50-20 V1のサービス・リクエスト・コレクション・データ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
name |
文字列 |
このコレクション・リソースの名前を表示します。 |
1 |
type |
文字列 |
このコレクション・リソースのタイプ。 |
1 |
hasMore |
ブール値 |
コレクションに他の要素があることを示します。 |
1 |
count |
整数 |
返される要素の数。 |
1 |
items |
コレクション<ServiceRequestEntity> |
ServiceRequestEntityリソースのリスト。リクエストが存在しない場合、アイテムは存在しますが空です。 |
1 |
canonicalLink |
URI |
このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。 |
1 |
selfLink |
URI |
これを含む要素と同等のリソースを参照します。 |
1 |
表50-21 V1のサービス・リクエスト・エンティティ・データ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
id |
文字列 |
ServiceRequestのRequestId。 |
1 |
beginDate |
文字列 |
更新結果となる新しいスケジュールを文字列表現したタイムスタンプ。たとえば、2013-10-02T16:14:41ZPSTの形式で指定します。 |
1 |
status |
文字列 |
サービス・リクエストのステータス。 |
1 |
name |
文字列 |
サービス・リクエストの名前。 |
1 |
serviceFamily |
文字列 |
リクエスト・タイプのサービス・ファミリ。 |
1 |
lastUpdatedTime |
文字列 |
最後に変更した時点のタイムスタンプを、指定した形式で表現した文字列値。 |
1 |
lifeCycle |
文字列 |
リクエストのライフ・サイクル。 |
1 |
selfLink |
文字列 |
このURIにするGETは、このリソースのクライアント表現を表します。 |
1 |
canonicalLink |
文字列 |
このURIにするGETは、このリソースのクライアント表現を表します。 |
1 |
次の表に、サービス・リクエスト・リソースでサポートされる操作を示します。
表50-22 サービス・リクエストに対してサポートされるメソッド
リクエスト・メソッド | V2の正規のリンク | V1の正規のリンク | 説明 |
---|---|---|---|
GET |
em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/ |
em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/ |
すべてのサービス・リクエストのリストを提供します。 2つの問合せパラメータ・タイプとv1のステータスがあります。v2の問合せパラメータについては、表50-23を参照してください。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid} |
em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/<request-id> |
サービス・リクエストIDの詳細を提供します。 |
PUT |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid} |
em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/<request-id> |
指定されたリクエストを別のスケジュールに再スケジュールします。スケジュールのbeginDateは、ペイロードで指定されます。 |
DELETE |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid} |
em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/<service-request-id> |
指定されたサービス・リクエストを取り消します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid}/logs |
該当なし |
サービス・リクエスト・ログを提供します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid}/logs?stepid={stepid} |
該当なし |
リクエスト実行ステップ・ログを返します。 |
次の表に、v2フレームワークのサービス・リクエスト・リソースに対するGETリクエストでサポートされる問合せパラメータを示します。
表50-23 V2のサービス・リクエストの問合せパラメータ
パラメータ | 入力 | 説明 | 必須 |
---|---|---|---|
servicetype |
サービス・タイプの名前 |
サービス・タイプ固有の情報を返します。 |
省略可能 |
status |
サービス・リクエストのステータス |
ステータス固有の情報を返します。可能な値は次のとおりです。
|
省略可能 |
expanded |
Boolean、trueまたはfalse |
trueの場合、 使用可能な値は、trueおよびfalseです。trueまたはfalse以外の値は無視され、falseとして扱われます。 |
省略可能 |
servicefamily |
サービス・ファミリの名前 |
サービス・ファミリ固有の情報を返します。 |
省略可能 |
この項では、いくつかのREST APIのシナリオ例をすべてリストします。この項では、次の操作について説明します。
V2:
V1:
表50-24 V1およびV2でサービス・リクエスト・リソースの詳細を表示するためのGETリクエスト構成
機能 | V1に対する仕様 | V2に対する仕様 |
---|---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
なし |
リクエスト・メソッド |
GET |
GET |
v2で受け取るレスポンスのサンプルを次に示します。
{ "name": "Request summary grouped by status", "totalResults": 17, "requestSummary": [ { "status": "NO_QUOTA_ERROR", "count": 1, "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=NO_QUOTA_ERROR&expanded=true" }, { "status": "EXECUTION_ERROR", "count": 1, "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=EXECUTION_ERROR&expanded=true" }, { "status": "SUCCESS", "count": 5, "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=SUCCESS&expanded=true" }, { "status": "CLEANUP_FAILED", "count": 1, "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=CLEANUP_FAILED&expanded=true" }, { "status": "SCHEDULED", "count": 9, "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=SCHEDULED&expanded=true" } ], "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests" }, "selfLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests" } }
v1で受け取るレスポンスのサンプルを次に示します。
{ "name": "Service Requests", "type": "Service Request","count": 2, "items": [ { "id": "2", "name": "future_Create Sample XaaS Service#2", "beginDate": "2015-02-14T08:37:18Z India Standard Time", "status": "SCHEDULED", "selfLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2", "canonicalLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2", "serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY" }, { "id": "1", "name": "eadeweqqw_Create Sample XaaS Service#1", "beginDate": "2015-02-10T07:49:24Z India Standard Time", "status": "EXECUTION_ERROR", "selfLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1", "canonicalLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1", "serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY" } ], "selfLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequest?status=ALL", "canonicalLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/" }
次の表に、サービス・リクエスト・リソースを問い合せるためのGET構成を示します。
表50-25 V2でStatus=SUCCESSのサービス・リクエストを問い合せるためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=SUCCESS |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "Request summary grouped by status", "totalResults" : 5, "requestSummary" : [ { "status" : "SUCCESS", "count" : 3, "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SUCCESS&expanded=true" }, { "status" : "SCHEDULED", "count" : 2, "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SCHEDULED&expanded=true" } ], "canonicalLink" : { "href" : 3.4 22 - - "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests" }, "selfLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SUCCESS" } }
次の表に、expanded=true
のサービス・リクエスト・リソースを問い合せるためのGET構成を示します。問合せ変更がURIで行われるexpanded=false
も同様のアプローチに従います。
表50-26 V2でExpanded=trueのサービス・リクエストを問い合せるためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?expanded=true |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
expanded=true
で受け取るレスポンスのサンプルを次に示します。
{ "name" : "Service Requests", "type" : "Service Request", "totalResults" : 5, "cfwItems" : [ { "id" : "5", "name" : "Rst_rpc_14-09-11 09.52.58_11-Sep-14 21:53:06.663", "startDate" : "2014-09-11T16:23:06Z", "status" : "SUCCESS", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/5" }, "displayName" : "Rst_rpc_14-09-11 09.52.58_11-Sep-14 21:53:06.663" }, { "id" : "4", "name" : "Remove Sample XaaS Service_Xaas_Storage__11-Sep-14 21:52:58.553", "startDate" : "2017-07-12T23:48:10Z", "status" : "SCHEDULED", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/4" }, "displayName" : "Remove Sample XaaS Service_Xaas_Storage__11-Sep-14 21:52:58.553" }, { "id" : "3", "name" : "Rst_en_14-09-11 09.52.58_11-Sep-14 21:52:58.363", "startDate" : "2014-09-11T16:22:58Z", "status" : "SUCCESS", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/3" }, "displayName" : "Rst_en_14-09-11 09.52.58_11-Sep-14 21:52:58.363" }, { "id" : "2", "name" : "Rst_st_en_14-09-11 09.52.58_11-Sep-14 21:52:54.187", "startDate" : "2015-01-13T00:48:10Z", "status" : "SCHEDULED", "canonicalLink" : { "href" : 3.5 23 - - "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/2" }, "displayName" : "Rst_st_en_14-09-11 09.52.58_11-Sep-14 21:52:54.187" }, { "id" : "1", "name" : "Rst_14-09-11 09.52.58_11-Sep-14 21:52:49.360", "startDate" : "2014-09-11T16:22:49Z", "status" : "SUCCESS", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/1" }, "displayName" : "Rst_14-09-11 09.52.58_11-Sep-14 21:52:49.360" } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests" }, "selfLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?expanded=true" } }
expanded=false
で受け取るレスポンスのサンプルを次に示します。
{ "name" : "Request summary grouped by status", "totalResults" : 5, "requestSummary" : [ { "status" : "SUCCESS", "count" : 3, "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SUCCESS&expanded=true" }, { "status" : "SCHEDULED", "count" : 2, "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=SCHEDULED&expanded=true" } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests" }, "selfLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?expanded=false"
次の表に、status=SUCCESS&expanded=false
のサービス・リクエスト・リソースを問い合せるためのGET構成を示します。問合せ変更がURIで行われるstatus=SUCCESS&expanded=true
も同様のアプローチに従います。
表50-27 V2でstatus=SUCCESS&expanded=falseのサービス・リクエストを問い合せるためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests?status=SUCCESS&expanded=false |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
status=SUCCESS&expanded=false
で受け取るレスポンスのサンプルを次に示します。
{ "name" : "Request summary grouped by status", "totalResults" : 5, "requestSummary" : [ { "status" : "SUCCESS", "count" : 3, "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SUCCESS&expanded=true" }, { "status" : "SCHEDULED", "count" : 2, "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SCHEDULED&expanded=true" } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests" }, "selfLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SUCCESS&expanded=false" } }
status=SUCCESS&expanded=true
で受け取るレスポンスのサンプルを次に示します。
{ "name" : "Service Requests", "type" : "Service Request", "totalResults" : 3, "cfwItems" : [ { "id" : "5", "name" : "Rst_rpc_14-09-11 09.52.58_11-Sep-14 21:53:06.663", "startDate" : "2014-09-11T16:23:06Z", "status" : "SUCCESS", "canonicalLink" : { "href" : 3.7 "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere 25 quests/5" }, "displayName" : "Rst_rpc_14-09-11 09.52.58_11-Sep-14 21:53:06.663" }, { "id" : "3", "name" : "Rst_en_14-09-11 09.52.58_11-Sep-14 21:52:58.363", "startDate" : "2014-09-11T16:22:58Z", "status" : "SUCCESS", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/3" }, "displayName" : "Rst_en_14-09-11 09.52.58_11-Sep-14 21:52:58.363" }, { "id" : "1", "name" : "Rst_14-09-11 09.52.58_11-Sep-14 21:52:49.360", "startDate" : "2014-09-11T16:22:49Z", "status" : "SUCCESS", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/1" }, "displayName" : "Rst_14-09-11 09.52.58_11-Sep-14 21:52:49.360" } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests" }, "selfLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests?status=SUCCESS&expanded=true" } }
サービス・リクエストの詳細を表示するためのGETリクエスト構成を次に示します。
表50-28 V2でサービス・リクエストの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "id": "44", "name": "dp_2b022961-c#44", "status": "SUCCESS", "serviceType": "CFW_SAMPLEXAAS_SERVICE", "serviceFamily": "Sample Services", "actionName": "Create Sample XaaS Service", "startDate": "2014-10-15T09:29:23Z", "createdOn": "2014-10-15T09:29:23Z", "createdBy": "SYSMAN", "owner": "SYSMAN", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/44" }, "executionLogs": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/44/logs" }
サービス・リクエストを削除するためのDELETEリクエスト構成を次に示します。
表50-29 V2でサービス・リクエストを削除するためのDELETEリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
DELETE |
受け取るレスポンスの例を次に示します。
{ "message" : "[\"Request 31 deleted successfully\"]" }
次の表にPUTリクエスト構成を示します。
表50-30 V1およびV2状態にあるサービス・リクエストを再スケジュールするためのPUTリクエスト構成
機能 | V1に対する仕様 | V2に対する仕様 |
---|---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2 |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "beginDate": "2013-10-02T16:14:41ZPST" } |
{"startDate":"2015-08-12T16:48:10ZAmerica/Los_Angeles"} |
リクエスト・メソッド |
PUT |
PUT |
v2で受け取るレスポンスのサンプルを次に示します。
{ "message" : "Request 2 rescheduled successfully." }
v1で受け取るレスポンスのサンプルを次に示します。
Status 200 OK { message: "Service request 2 rescheduled successfully." }
次の表に、サービス・リクエスト・ログを表示するためのGETリクエスト構成を示します。
表50-31 V2でサービス・リクエストのログを表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid}/logs |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "submittedOn" : "2014-09-12T07:20:38Z", "steps" : [ { "stepName" : "CfwRequestInitCommand", "stepId" : "CfwRequestInitCommand", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/21/logs?stepid=CfwRequestInitCommand" }, { "stepName" : "CfwRequestPreProcessCommand", "stepId" : "CfwRequestPreProcessCommand", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/21/logs?stepid=CfwRequestPreProcessCommand" }, { "stepName" : "CfwRequestJobInvokerCommand", "stepId" : "CfwRequestJobInvokerCommand", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/21/logs?stepid=CfwRequestJobInvokerCommand" }, { "stepId" : "", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/21/logs?stepid=" }, { "stepName" : "CfwRequestPostProcessCommand", "stepId" : "CfwRequestPostProcessCommand", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/21/logs?stepid=CfwRequestPostProcessCommand" } ], "id" : "21" }
次の表に、サービス・リクエスト・ログを問い合せるためのGETリクエスト構成を示します。
表50-32 V2でサービス・リクエストのログを問い合せるためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/{requestid}/logs?stepid=CfwRequestPreProcessCommand |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "id" : "21", "stepName" : "CfwRequestPreProcessCommand", "stepId" : "CfwRequestPreProcessCommand", "data" : "INFO:Request Pre-processing in progress.\nINFO:Preparing the inputs for Request Action: Create Sample XaaS Service\nINFO:Performing placment checks to identify the appropriate Service- Provider.\nINFO:Placement checks executed successfully.\nINFO:Request pre-processing successfully executed.", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicere quests/21/logs?stepid=CfwRequestPreProcessCommand" } }
次の表にGETリクエスト構成を示します。
表50-33 V1で特定のサービス・ファミリにおけるサービス・リクエストの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests?type=mwaas |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { name: "Service Requests" type: "Service Request" count: 2 items: [2] 0: { id: "2" name: "request2_14153ee61c5_Create_20130925_123353" beginDate: "2013-09-25T12:48:50ZAsia/Calcutta" status: "Scheduled" lifeCycle: "Create Service Instance" selfLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2" canonicalLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2" serviceFamily: "MWAAS" } 1: { id: "1" name: "request1_14153ea0bb6_Create_20130925_122909" beginDate: "2013-09-25T12:44:03ZAsia/Calcutta" status: "Cancelled" lifeCycle: "Create Service Instance" selfLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1" canonicalLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1" serviceFamily: "MWAAS" } selfLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests?status=ALL" canonicalLink: "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests" }
次の表にGETリクエスト構成を示します。
表50-34 V1で特定のステータスであるサービス・リクエストの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/?status=SCHEDULED |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name": "Service Requests", "type": "Service Request", "count": 1, "items": [ { "id": "2", "name": "future_Create Sample XaaS Service#2", "beginDate": "2015-02-14T08:37:18Z India Standard Time", "status": "SCHEDULED", "selfLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2", "canonicalLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/2", "serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY" } ], "selfLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequest?status=SCHEDULED", "canonicalLink": "https://cloudcompnay.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/" }
次の表にPUTリクエスト構成を示します。
表50-35 v1で取消済状態にあるサービス・リクエストを再スケジュールするためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1 |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "beginDate": "2013-10-02T16:14:41ZPST" } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
Status : 400 Bad request {errorMessages: "Error occured while rescheduling. Verify that schedule is not in past and status is scheduled."}
次の表にDELETEリクエスト構成を示します。
表50-36 V1でスケジュール済サービス・リクエストを取り消すためのDELETEリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1 |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
DELETE |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: "Service request 1 cancelled successfully." }
次の表にDELETEリクエスト構成を示します。
表50-37 V1で取消済状態にあるサービス・リクエストを削除するためのDELETEリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/servicerequests/1 |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
DELETE |
受け取るレスポンスの例を次に示します。
Status : 400 Bad request{errorMessages: "Error occured while cancelling. Only request with status SCHEDULED is cancellable."}
サービス・インスタンス・リソースは、サービス・インスタンスとアクション・エンティティから構成されます。サービス・インスタンス・リソースのデータ・モデルとその関連エンティティを次に示します。
表50-38 V2のサービス・インスタンス・データ・モデル
フィールド | データ型 | 説明 |
---|---|---|
guid |
文字列 |
サービス・インスタンスのGUID |
serviceFamily |
文字列 |
サービス・ファミリの名前。 |
serviceType |
文字列 |
サービス・タイプの名前。 |
status |
文字列 |
サービス・インスタンスのステータス。 |
displayname |
文字列 |
サービス・インスタンスの表示名。 |
targetType |
文字列 |
サービス・インスタンスのターゲット・タイプ。 |
表50-39 V2のアクション・データ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
offeringId |
文字列 |
サービスのGUID。 |
1 |
name |
文字列 |
リクエストの名前。 |
1 |
instanceName |
文字列 |
サービス・インスタンスの名前。 |
0..1 |
schedule |
ScheduleEntity |
リクエストのスケジュール。 |
0..1 |
configurations |
リスト<CfwValueDescriptor> |
構成。 |
0..1 |
characteristics |
リスト<Characteristic> |
特性のリスト。 |
0..1 |
サポートされるリクエスト・パラメータとその説明を次の表に示します。
次の表に、サービス・インスタンス・リソースでサポートされるメソッドの詳細を示します。
表50-40 サービス・インスタンス・リソースに対してサポートされるメソッド
リクエスト・メソッド | URI | 説明 |
---|---|---|
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/ |
サービス・インスタンス・コレクションの詳細を返します。 問合せパラメータについては、表50-41を参照してください。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid} |
指定されたサービス・インスタンスの詳細を返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/actions |
指定されたサービス・インスタンスで使用可能なアクションを返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/attributes |
指定されたサービス・インスタンスの属性を返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/actions/{actionid} |
指定されたサービス・インスタンスに対してアクションを実行するために必要なアクションの詳細とアクションの入力を返します。 |
PUT |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/ |
特定のサービス・インスタンスに関するアクションを実行します。 |
次の表に、v2フレームワークのサービス・インスタンス・リソースに対するGETリクエストでサポートされる問合せパラメータを示します。
表50-41 V2のサービス・インスタンスの問合せパラメータ
パラメータ | 入力 | 説明 | 必須 |
---|---|---|---|
servicetype |
サービス・タイプの名前。 |
サービス・タイプ固有の情報を返します。 |
省略可能 |
status |
サービス・インスタンスのステータス。 |
ステータス固有の情報を返します。可能な値は次のとおりです。
|
省略可能 |
expanded |
Boolean、trueまたはfalse。 |
ServiceInstanceCollectionには、trueの場合は |
省略可能 |
この項では、サービス・インスタンス・リソースのREST APIの例を示します。この項では、次の操作について説明します。
次の表にGETリクエスト構成を示します。
表50-42 V2でサービス・インスタンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "Service Instances Summary", "totalResults" : 7, "serviceInstanceSummary" : [ { "status" : "STATUS_UP", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?status=STATUS_UP&expanded=true", "count" : 3 }, { "status" : "PENDING_CREATION", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?status=PENDING_CREATION&expanded=true", "count" : 4 } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances" } }
次の表に、次のパラメータに基づいてサービス・インスタンス・リソースを問い合せるためのGETリクエスト構成を示します。
expanded=true
expanded=false
status=STATUS_UP
servicetype=CFW_SAMPLEXAAS_SERVICE
expanded=true,status=STATUS_UP
expanded=false,status=STATUS_UP,servicetype=CFW_SAMPLEXAAS_SERVICE
表50-43 V2でサービス・インスタンス・リソースを問い合せるためのGETリクエスト構成
機能 | 指定 |
---|---|
expanded=trueのURI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?expanded=true |
expanded=falseのURI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?expanded=false |
status=STATUS_UPのURI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?status=STATUS_UP |
servicetype=CFW_SAMPLEXAAS_SERVICEのURI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?servicetype=CFW_SAMPLEXAAS_SERVICE |
expanded=true&status=STATUS_UPのURI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?expanded=true&status=STATUS_UP |
expanded=false,status=STATUS_UP,servicetype=CFW_SAMPLEXAAS_SERVICEのURI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances?expanded=fal se&status=STATUS_UP&servicetype=CFW_SAMPLEXAAS_SERVICE |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
expanded=false
で受け取るレスポンスのサンプルを次に示します。
{ "name" : "Service Instances Summary", "totalResults" : 7, "serviceInstanceSummary" : [ { "status" : "STATUS_UP", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances?status=STATUS_UP&expanded=true", "count" : 3 }, { "status" : "PENDING_CREATION", "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances?status=PENDING_CREATION&expanded=true", "count" : 4 } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances" }, "selfLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances?expanded=false" } }
次の表にGETリクエスト構成を示します。
表50-44 V2でサービス・インスタンスの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "test", "targetName" : "test", "guid" : "CCA88E9507D4A9E2214935F956D83150", "serviceType" : "CFW_SAMPLEXAAS_SERVICE", "serviceFamily" : "CFW_SAMPLEXAAS_SERVICEFAMILY", "status" : "STATUS_UP", "targetType" : "Cfw_Xaas_DB_Service", "createdOn" : "2014-11-15T00:00:00ZAsia/Calcutta", "createdBy" : "SYSMAN", "owner" : "SYSMAN", "attributes" : { "href" : "https://xx.idc.example.com:14488/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances/CCA88E9507D4A9E2214935F956D83150/attributes" }, "canonicalLink" : { "href" : "https://xx.idc.example.com:14488/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances/CCA88E9507D4A9E2214935F956D83150" }, "selfLink" : { "href" : "https://xx.idc.example.com:14488/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicein stances/CCA88E9507D4A9E2214935F956D83150" } }
次の表にGETリクエスト構成を示します。
表50-45 V2でサービス・インスタンスの属性の詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/attributes |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "serviceInstanceGuid" : "CCA88E9507D4A9E2214935F956D83150", "attributes" : [ { "name" : "xaasServiceName", "type" : "STRING", "value" : "test" } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:14488/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/CCA88E9507D4A9E2214935F956D83150/attributes" }, "selfLink" : { "href" : "https://xx.idc.example.com:14488/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/CCA88E9507D4A9E2214935F956D83150/attributes" } }
次の表にGETリクエスト構成を示します。
表50-46 V2でサービス・インスタンスで使用可能なアクションの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/actions |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "totalResults" : 6, "selfLink" : { "href" : "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/2A2BD0D7C40F7C2814FA6788704E313 A/actions" }, "cfwItems" : [ { "name" : "DELETE", "id" : "82", "displayName" : "Remove Sample XaaS Service", "description" : "Removing my Sample XaaS service" }, { "name" : "START", "id" : "84", "displayName" : "Start Service", "description" : "Starts this service" }, { "name" : "STOP", "id" : "85", "displayName" : "Stop Service", "description" : "Stops this service" }, { "name" : "CLEANUP", "id" : "86", "displayName" : "Cleanup Sample XaaS Failed Request", "description" : "Cleanup Sample Xaas Failed Request" }, { "name" : "SYNCSTARTSERVICE", "id" : "87", "displayName" : "Sync Start Service", "description" : "Synchronous Action to Start Sample Service" }, { "name" : "SYNCSTOPSERVICE", "id" : "88", "displayName" : "Sync Stop Service", "description" : "Synchronous Action to Stop Sample Service" } ], "name" : "Actions", "type" : "Action", "canonicalLink" : { "href" : "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/2A2BD0D7C40F7C2814FA6788704E313 A/actions" } }
次の表にGETリクエスト構成を示します。
表50-47 V2でサービス・インスタンスに対してアクションを実行するために必要なアクションの入力の詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid}/actions/{actionid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "START", "id" : "94", "displayName" : "START", "actionInputs" : [ { "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", "value" : "Y", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "CPU", "value" : "60", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "MEMORY", "value" : "4048", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "STORAGE", "value" : "500", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "XAAS_TEST", "value" : "NONE", "type" : "STRING", "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", "value" : "N", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "CPU", "value" : "80", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "MEMORY", "value" : "8088", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "STORAGE", "value" : "750", "type" : "STRING", "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", "value" : "Y", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "CPU", "value" : "60", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "MEMORY", "value" : "40448", "type" : "STRING", "required" : false, "secret" : false }, { "name" : "STORAGE", "value" : "500", "type" : "STRING", "required" : false, "secret" : false } ] } ] } ], "description" : "Starts this service" }
次の表にPUTリクエスト構成を示します。
表50-48 V2でサービス・インスタンスに対してアクションを実行するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/serviceinstances/{instanceid} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "actionId":94, "configurations":[ { "name":"domainName", "type":"STRING", "description":"Domain Name", "required":true, "value":"/mwaas_rest_9_SSA_USER1/rest_9_SSA_USER1" }, { "name":"applicationName", "type":"STRING", "description":"Application Name", "required":true, "value":"test1" } ] } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
{ "requests": [ { "id": "4", "actionName": "STOP", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/servicerequests/4" } } ] }
この項では、SSAユーザーの割当て制限使用量REST APIについて説明します。
次の表に、割当て制限使用量でサポートされる操作を示します。
表50-49 割当て制限使用量でサポートされるメソッド
リクエスト・メソッド | URI | 説明 |
---|---|---|
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage |
割当て制限使用量へのリンクを返します。 |
GET |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/{servicefamily} |
サービス・ファミリ別の割当て制限使用量を返します。 |
この項では、割当て制限使用量のREST APIの例を示します。次の例について説明します。
次の表にGETリクエスト構成を示します。
表50-50 サービス・ファミリ別に割当て制限使用量の詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/{servicefamily} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name": "Usages", "type": "Usages Collection", "totalResults": 4, "cfwItems": [ { "id": "sampleActionOpen", "name": "Storage", "type": "Others", "allowed": "10.0", "used": "3.0", "unit": "GB" }, { "name": "Cfw Sample XaaS - Other Service", "type": "Service Instances", "serviceType": "CFW_SAMPLEXAAS_SERVICE_FOR_NOMEM", "used": "0" }, { "name": "Cfw Sample XaaS", "type": "Service Instances", "serviceType": "CFW_SAMPLEXAAS_SERVICE", "used": "0" }, { "name": "Cfw Sample RemoteServer XaaS", "type": "Service Instances", "serviceType": "CFW_SAMPLEXAAS_REMOTESERVER_SERVICE", "used": "0" } ], "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/CFW_SAMPLEXAAS_SERVICEFAMILY" }, "selfLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/CFW_SAMPLEXAAS_SERVICEFAMILY" } }
次の表にGETリクエスト構成を示します。
表50-51 割当て制限使用量の詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/" }, "usages": [ { "serviceFamily": "CFW_SAMPLEXAAS_SERVICEFAMILY", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/CFW_SAMPLEXAAS_SERVICEFAMILY" } }, { "serviceFamily": "NIMBULA_INFRASTRUCTURE", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/NIMBULA_INFRASTRUCTURE" } }, { "serviceFamily": "DBAAS", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/DBAAS" } }, { "serviceFamily": "MIDDLEWARE_CFW", "canonicalLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/MIDDLEWARE_CFW" } } ], "selfLink": { "href": "https://cloudcompany.com/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/quotausage/" } }
この項では、v2フレームワークのユーザー・プリファレンス・リソースについて説明します。
次の表に、ユーザー・プリファレンス・リソースでサポートされるリクエスト・メソッドを示します。
表50-52 V2のユーザー・プリファレンス・リソースでサポートされるリクエスト・メソッド
リクエスト・メソッド | URI | 説明 |
---|---|---|
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/ |
一般プリファレンスおよびサービス固有のプリファレンスのトップ・レベル・ビューを返します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general |
一般ユーザー・プリファレンスを返します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general/metadata |
一般ユーザー・プリファレンスのメタデータを返します。 |
PUT |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general |
ユーザーの一般プリファレンスを更新します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services |
サービス・プリファレンスのトップ・レベル・ビューを返します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily} |
サービス・ファミリ・ユーザー・プリファレンスを返します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/metadata |
指定されたサービス・ファミリ・プリファレンスのメタデータを返します。 |
PUT |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily} |
サービス・ファミリ・ユーザー・プリファレンスを更新します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/{servicetype} |
サービス・タイプ・ユーザー・プリファレンスを返します。 |
GET |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/{servicetype}/metadata |
指定されたサービス・タイプ・プリファレンスのメタデータを返します。 |
PUT |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/{servicetype} |
ユーザーのサービス・ファミリ・プリファレンスを更新します。 |
この項では、次のREST APIについて説明します。この項では、次の操作について説明します。
次の表にGETリクエスト構成を示します。
表50-53 V2でユーザー・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "generalPreferences" : "https://blr2223141.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general", "servicePreferences" : "https://blr2223141.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services", "canonicalLink" : { "href" : "https://blr2223141.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences" } }
次の表にGETリクエスト構成を示します。
表50-54 V2で一般ユーザー・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "General Preference", "type" : "General User Preferences", "preferences" : [ { "name" : "USER_LOCALE", "value" : "en", "type" : "STRING", "defaultValue" : "en", "displayName" : "English", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "REQUEST_STATUS", "type" : "VECTOR", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false }, { "name" : "REQUEST_NOTIFICATION", "value" : "false", "type" : "BOOLEAN", "defaultValue" : "false", "description" : "This allows the user to receive notifications for different statuses of the request.", "required" : false, "secret" : false }, { "name" : "NOTIFICATION_DAYS_1", "value" : "0", "type" : "INTEGER", "defaultValue" : "0", "description" : "Number of days before the first notification is sent to the user before the expiry date of the service instance.", "required" : false, "secret" : false }, { "name" : "NOTIFICATION_DAYS_2", "value" : "0", "type" : "INTEGER", "defaultValue" : "0", "description" : "Number of days before the second notification is sent to the user before the expiry date of the service instance.", "required" : false, "secret" : false }, { "name" : "DEFAULT_SERVICE", "value" : "MWAAS", "type" : "STRING", "defaultValue" : "IAAS", "description" : "This will be used as your default service after successful login to Self Service Portal.", "required" : false, "secret" : false }, { "name" : "EMAIL", "type" : "VECTOR", "description" : "This is the default Email address for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "QUOTA_THRESHOLD", "value" : "0.0", "type" : "FLOAT", "defaultValue" : "0.0", "description" : "Notifications will be sent to users when resources exceed the defined quota percentage.", "required" : false, "secret" : false }, { "name" : "QUOTA_NOTIFICATION", "value" : "false", "type" : "BOOLEAN", "defaultValue" : "false", "description" : "Receive quota related notification when the quota reaches the specified threshold.", "required" : false, "secret" : false }, { "name" : "INSTANCE_EXPIRY_NOTIFICATION", "value" : "false", "type" : "BOOLEAN", "defaultValue" : "false", "description" : "Enables user to receive notifications for Service Instances that are due to expire based on the notification period.", "required" : false, "secret" : false } ], "meta" : "https://blr2223141.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general/metadata", "canonicalLink" : { "href" : "https://blr2223141.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general" } }
次の表にGETリクエスト構成を示します。
表50-55 V2で一般ユーザー・プリファレンス・リソースのメタデータを表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general/metadata |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "General Preference", "type" : "General User Preferences", "preferences" : [ { "name" : "USER_LOCALE", "value" : "en", "type" : "STRING", "defaultValue" : "en", "displayName" : "English", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false, "possibleValues" : [ { "name" : "USER_LOCALE", "value" : "es_ES", "type" : "STRING", "defaultValue" : "en", "displayName" : "Spanish", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "ja", "type" : "STRING", "defaultValue" : "en", "displayName" : "Japanese", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "fr", "type" : "STRING", "defaultValue" : "en", "displayName" : "French", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "ko", "type" : "STRING", "defaultValue" : "en", "displayName" : "Korean", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "de", "type" : "STRING", "defaultValue" : "en", "displayName" : "German", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "zh_TW", "type" : "STRING", "defaultValue" : "en", "displayName" : "Traditional Chinese", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "zh_CN", "type" : "STRING", "defaultValue" : "en", "displayName" : "Simplified Chinese", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "en", "type" : "STRING", "defaultValue" : "en", "displayName" : "English", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "USER_LOCALE", "value" : "pt_BR", "type" : "STRING", "defaultValue" : "en", "displayName" : "Brazilian Portuguese", "description" : "This is the default Locale for receiving cloud notifications.", "required" : false, "secret" : false } ] }, { "name" : "REQUEST_STATUS", "type" : "VECTOR", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false, "possibleValues" : [ { "name" : "REQUEST_STATUS", "value" : "PARTIAL_SUCCEEDED", "type" : "VECTOR", "displayName" : "Partially Succeeded", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false }, { "name" : "REQUEST_STATUS", "value" : "ERROR", "type" : "VECTOR", "displayName" : "Error", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false }, { "name" : "REQUEST_STATUS", "value" : "CANCELLED", "type" : "VECTOR", "displayName" : "Cancelled", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false }, { "name" : "REQUEST_STATUS", "value" : "EXECUTING", "type" : "VECTOR", "displayName" : "Running", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false }, { "name" : "REQUEST_STATUS", "value" : "SUCCESS", "type" : "VECTOR", "displayName" : "Success", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false }, { "name" : "REQUEST_STATUS", "value" : "SCHEDULED", "type" : "VECTOR", "displayName" : "Scheduled", "description" : "Request Status For Which Notifications Are Enabled", "required" : false, "secret" : false } ] }, { "name" : "REQUEST_NOTIFICATION", "value" : "false", "type" : "BOOLEAN", "defaultValue" : "false", "description" : "This allows the user to receive notifications for different statuses of the request.", "required" : false, "secret" : false }, { "name" : "NOTIFICATION_DAYS_1", "value" : "0", "type" : "INTEGER", "defaultValue" : "0", "description" : "Number of days before the first notification is sent to the user before the expiry date of the service instance.", "required" : false, "secret" : false }, { "name" : "NOTIFICATION_DAYS_2", "value" : "0", "type" : "INTEGER", "defaultValue" : "0", "description" : "Number of days before the second notification is sent to the user before the expiry date of the service instance.", "required" : false, "secret" : false }, { "name" : "DEFAULT_SERVICE", "value" : "MWAAS", "type" : "STRING", "defaultValue" : "IAAS", "description" : "This will be used as your default service after successful login to Self Service Portal.", "required" : false, "secret" : false }, { "name" : "EMAIL", "type" : "VECTOR", "description" : "This is the default Email address for receiving cloud notifications.", "required" : false, "secret" : false }, { "name" : "QUOTA_THRESHOLD", "value" : "0.0", "type" : "FLOAT", "defaultValue" : "0.0", "description" : "Notifications will be sent to users when resources exceed the defined quota percentage.", "required" : false, "secret" : false }, { "name" : "QUOTA_NOTIFICATION", "value" : "false", "type" : "BOOLEAN", "defaultValue" : "false", "description" : "Receive quota related notification when the quota reaches the specified threshold.", "required" : false, "secret" : false }, { "name" : "INSTANCE_EXPIRY_NOTIFICATION", "value" : "false", "type" : "BOOLEAN", "defaultValue" : "false", "description" : "Enables user to receive notifications for Service Instances that are due to expire based on the notification period.", "required" : false, "secret" : false } ], "canonicalLink" : { "href" : "https://xxx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general/metadata" } }
次の表にPUTリクエスト構成を示します。
表50-56 V2で一般ユーザー・プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/general |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "preferences":[ { "value":"MWAAS", "name":"DEFAULT_SERVICE" }, { "value":"false", "name":"REQUEST_NOTIFICATION" } ] } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
{ "message" : "General preferences updated successfully." }
次の表にGETリクエスト構成を示します。
表50-57 V2でサービス・ユーザー・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "preferences" : [ { "name" : "MIDDLEWARE_CFW", "type" : "Service Family User Preferences", "required" : false, "secret" : false, "meta" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/MIDDLEWARE_CFW/metadata", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/MIDDLEWARE_CFW" } }, { "name" : "NIMBULA_INFRASTRUCTURE", "type" : "Service Family User Preferences", "required" : false, "secret" : false, "meta" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/NIMBULA_INFRASTRUCTURE/metadata", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/NIMBULA_INFRASTRUCTURE" } }, { "name" : "DBAAS", "type" : "Service Family User Preferences", "required" : false, "secret" : false, "meta" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/DBAAS/metadata", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/DBAAS" } }, { "name" : "CFW_SAMPLEXAAS_SERVICEFAMILY", "type" : "Service Family User Preferences", "required" : false, "secret" : false, "meta" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/metadata", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY" } } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services" } }
次の表にGETリクエスト構成を示します。
表50-58 V2でサービス・ファミリ・ユーザー・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
次の表にGETリクエスト構成を示します。
表50-59 V2でサービス・ファミリ・ユーザー・プリファレンスのメタデータを表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/metadata |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "CFW_SAMPLEXAAS_SERVICEFAMILY", "type" : "Service Type User Preferences", "preferences" : [ { "name" : "SAMPLE_PREFERENCE_1", "value" : "test", "type" : "STRING", "defaultValue" : "Sample Value 1", "description" : "Type of the Supported Files", "required" : false, "secret" : false } ], "subPreferences" : [ { "name" : "CFW_SAMPLEXAAS_SERVICE_FOR_NOMEM", "type" : "Service Type User Preferences", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/metadata/CFW_SAMPLEXAAS_SERVICE_FOR_NOMEM" } }, { "name" : "CFW_SAMPLEXAAS_SERVICE", "type" : "Service Type User Preferences", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/metadata/CFW_SAMPLEXAAS_SERVICE" } }, { "name" : "CFW_SAMPLEXAAS_REMOTESERVER_SERVICE", "type" : "Service Type User Preferences", "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/metadata/CFW_SAMPLEXAAS_REMOTESERVER_SERVICE" } } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/metadata" } }
次の表にPUTリクエスト構成を示します。
表50-60 V2でサービス・ファミリ・ユーザー・プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "preferences":[ { "value":"test", "name":"SAMPLE_PREFERENCE_1" } ] } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
{ "message" : "User service preferences updated successfully." }
次の表にGETリクエスト構成を示します。
表50-61 V2でサービス・タイプ・ユーザー・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/{servicetype} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "CFW_SAMPLEXAAS_SERVICE", "type" : "Service Type User Preferences", "preferences" : [ { "name" : "SAMPLE_PREFERENCE_1", "value" : "UPD_ST_Rest_14-09-06 11.59.34", "type" : "STRING", "defaultValue" : "Sample Value 1", "description" : "Type of the Supported Files", "required" : false, "secret" : false } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/CFW_SAMPLEXAAS_SERVICE" } }
次の表にGETリクエスト構成を示します。
表50-62 V2でサービス・タイプ・ユーザー・プリファレンスのメタデータを表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/{servicetype}/metadata |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "name" : "CFW_SAMPLEXAAS_SERVICE", "type" : "Service Type User Preferences", "preferences" : [ { "name" : "SAMPLE_PREFERENCE_1", "value" : "test", "type" : "STRING", "defaultValue" : "Sample Value 1", "description" : "Type of the Supported Files", "required" : false, "secret" : false } ], "canonicalLink" : { "href" : "https://xx.idc.example.com:24503/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/CFW_SAMPLEXAAS_SERVICEFAMILY/CFW_SAMPLEXAAS_SERVICE/metadata" } }
次の表にPUTリクエスト構成を示します。
表50-63 V2でサービス・タイプ・ユーザー・プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v2/userpreferences/services/{servicefamily}/{servicetype} |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "preferences":[ { "value":"UPD_ST_Rest_14-09-07 12.03.39", "name":"SAMPLE_PREFERENCE_1" } ] } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
{ "message" : "User service preferences updated successfully." }
EM_SSA_USER
ロールを持つSSAユーザーは、Cloud REST APIを使用して、一般およびサービス固有の両方のユーザー・プリファレンスを設定できます。
これはトップ・レベルのリソースで、次のプリファレンスを取得するために使用されます。
一般プリファレンス
サービス・プリファレンス: このプリファレンスには、マイ・データベース・プリファレンス、マイ・ミドルウェア・プリファレンスおよびマイ・テスト・プリファレンスがあります。
ユーザー・プリファレンスのURI (正規のリンク)は、em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/
です。このURIに対するGETリクエストによって、一般的なプリファレンスとサービス固有プリファレンスのトップ・レベル・ビューが得られます。次の表に、このURIに対するGETリクエスト構成を示します。
表50-64 正規のリンク
メソッド | 問合せパラメータ | リクエスト・ペイロード | URI | 説明 |
---|---|---|---|---|
GET |
なし |
なし |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/ |
一般プリファレンスおよびサービス固有のプリファレンスのトップ・レベル・ビューを提供します。 |
表50-65 マイ・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "servicePreferences":"/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services", "canonicalLink":"/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/"
すべてのサービス・タイプに対して適用できる、一般的なユーザー・プリファレンスを表します。
表50-66 一般プリファレンス・データ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
emailAddress |
文字列 |
クラウド通知を受信するためのデフォルトの電子メール・アドレスです。 |
0..1 |
locale |
文字列 |
クラウド通知を受信するためのデフォルトのロケールです。デフォルトのロケールは英語です。指定できる値は次のとおりです。
|
0..1 |
request |
RequestEntity |
リクエスト通知の値。 |
0..1 |
instanceExpiry |
InstanceExpiryEntity |
インスタンス期限切れ通知の値。 |
0..1 |
割当て制限 |
QuotaEntity |
インスタンス期限切れ通知の値。 |
0...1 |
quotaThreshold |
整数 |
通知は、リソースが定義済の割当て率を超えると、ユーザーに送信されます。 |
0..1 |
defaultServiceType |
文字列 |
セルフ・サービス・ポータルに正常にログインしたときのデフォルトのサービスです。指定しない場合、これがサーバーのデフォルトになります。サポートされるサービス・タイプの値には、IAAS (サーバー)、DBAAS (データベース)、MWAAS (ミドルウェア)、TAAS (テスト)などがあります。 |
0..1 |
canonicalLink |
URI |
このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。 |
1 |
この項では、次のコンポジット・リソース属性データ・モデルについて説明します。
RequestEntity
InstanceExpiryEntity
QuotaEntity
次の表では、RequestEntityデータ・モデルについて説明します。
表50-67 RequestEntityデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
requestNotifications |
ブール値 |
リクエストの様々なステータス通知をユーザーが受信できるようにします。 |
0..1 |
requestStatus |
リスト<文字列> |
通知が有効となっているリクエスト・ステータスのリスト。サポートされるリクエスト・ステータス値は次のとおりです。
|
次の表では、InstanceExpiryEntityデータ・モデルについて説明します。
表50-68 InstanceExpiryEntityデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
instanceExpiryNotifications |
ブール値 |
通知期間に基づき期限切れとなるようにスケジュールされているサービス・インスタンスの通知をユーザーが受信できるようにします。 |
0..1 |
daysBeforeFirstNotification |
整数 |
サービス・インスタンスの期限切れの日付前に、最初の通知がユーザーに送信されるまでの日数。 |
0..1 |
daysBeforeSecondNotification |
整数 |
サービス・インスタンスの期限切れの日付前に、2回目の通知がユーザーに送信されるまでの日数。 |
0..1 |
次の表では、サポートされるメソッドについて説明します。
表50-70 サポートされるメソッド
メソッド | 問合せパラメータ | リクエスト・ペイロード | URI | 説明 |
---|---|---|---|---|
GET |
なし |
なし |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/general |
SSAユーザー用の一般プリファレンスを提供します。 |
PUT |
なし |
GeneralPreferences |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/general |
SSAユーザー用の一般プリファレンスを更新します。 |
次の表は、SSAユーザーの一般リファレンスを確認するためのGETリクエスト構成を示します。
表50-71 SSAユーザーの一般プリファレンスの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/general/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
{ "emailAddress": "john.smith@cloudcompany.com", "locale": "English", "request": { "requestNotifications": true, "requestStatus": ["SUCCESS","INCOMPLETE"] } "instanceExpiry": { "instanceExpiryNotifications": true, "daysBeforeFirstNotification": 10, "daysBeforeSecondNotification": 5 }, "quota": { "quotaNotifications": true, "quotaThreshold": 80.0 }, "defaultServiceType": "Servers", "canonicalLink": "em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/general" }
次の表は、SSAユーザーの一般リファレンスを更新するためのPUTリクエスト構成を示します。
表50-72 SSAユーザーの一般プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/general/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文(1つのフィールドの更新) |
{ "emailAddress": "john.smith@cloudcompany.com", "locale": "en", "defaultServiceType": "IAAS", } |
本文(すべてのフィールドの更新) |
{ "emailAddress": "john.smith@cloudcompany.com", "locale": "en", "request": { "requestNotifications": true, "requestStatus": ["SCHEDULED","INCOMPLETE"] }, "instanceExpiry": { "instanceExpiryNotifications": true, "daysBeforeFirstNotification": 10, "daysBeforeSecondNotification": 5 }, "quota": { "quotaNotifications": true, "quotaThreshold": 80 }, "defaultServiceType": "IAAS" } |
本文(通知フィールドの更新) |
{ "request": { "requestNotifications": true, "requestStatus": ["SCHEDULED","INCOMPLETE"] } } |
本文(期限切れ通知フィールドの更新) |
{ "instanceExpiry": { "instanceExpiryNotifications": true, "daysBeforeFirstNotification": 10, "daysBeforeSecondNotification": 5 } } |
本文(割当て制限通知フィールドの更新) |
{ "quota": { "quotaNotifications": true, "quotaThreshold": 80 } } |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: "General Preferences updated successfully." }
ここでは、以下の項目について説明します。
サービス・プリファレンス・リソースは、サービス・ファミリごとのSSAユーザーのユーザー・プリファレンスを表します。
表50-73 ServicePreferencesデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
canonicalLink |
URI |
このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。 |
1 |
servicePreferences |
コレクション<EntityValueHolder> |
特定のサービス・ファミリにおけるSSAユーザーのユーザー・プリファレンス。 |
1 |
表50-74 サポートされるメソッド(II)
メソッド | 問合せパラメータ | リクエスト・ペイロード | URI | 説明 |
---|---|---|---|---|
GET |
なし |
なし |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services |
すべてのサービス・ファミリにおけるサービス・プリファレンスのトップ・レベル・ビューを提供します。 |
GET |
なし |
なし |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/ services/<servicefamily> |
特定のサービス・ファミリにおけるSSAユーザーのユーザー・プリファレンスを提供します。 |
PUT |
なし |
ServicePreferences |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/ services/< servicefamily > |
特定のサービス・ファミリにおけるSSAユーザーのユーザー・プリファレンスを更新します。 |
特定のサービス・ファミリに関連するユーザー・プリファレンス・メタデータのセットをフェッチします。このデータ・モデルを使用することにより、ユーザーは、各サービス・ファミリで利用可能なユーザー・プリファレンスおよびそれぞれの値を識別できます。
表50-75 ServicePreferenceMetaDataデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
canonicalLink |
URI |
このURIに対してGETを実行すると、このリソースのクライアント表現がリフレッシュされます。 |
1 |
servicePreferencesMeta |
コレクション<ValueDescriptor> |
特定のサービス・タイプに関連するユーザー・プリファレンス・メタデータのセット。 |
0..1 |
この仕様のいくつかのリソース・エンティティには、次のコンポジット・リソース属性が含まれています。
値(文字列表現)およびその説明(キャプション)を表します。次の表で、このデータ・モデルについて説明します。
表50-76 ValueEntityデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
value |
文字列 |
エンティティの実際値の文字列表現 |
1 |
description |
文字列 |
エンティティを説明するエンティティのキャプション |
0..1 |
名前、値および説明を持つ単一のエントリを表します。次の表で、このデータ・モデルについて説明します。
表50-77 EntityValueHolderデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
name |
文字列 |
エンティティの名前。 |
1 |
value |
文字列 |
エンティティの実際値の文字列表現 |
1 |
description |
文字列 |
エンティティを説明するエンティティのキャプション |
0..1 |
関連付けられたオブジェクトに設定可能な値のタイプに関するメタデータを説明します。次の表で、このデータ・モデルについて説明します。
表50-78 ValueDescriptorデータ・モデル
フィールド | データ型 | 説明 | 発生 |
---|---|---|---|
name |
文字列 |
記述するデータの名前 |
1 |
displayName |
文字列 |
記述するデータの表示名 |
0..1 |
description |
文字列 |
参照するデータの説明 |
0..1 |
currentValue |
文字列 |
記述するデータの現在の値 |
0..1 |
isRequiredAttribute |
ブール値 |
データの値が必要な場合はtrue |
0..1 |
possibleValues |
コレクション<ValueEntity> |
記述するデータの有効な値のリスト(オプション) |
0..1 |
description |
文字列 |
参照するデータの説明 |
0..1 |
この項では、サービス・プリファレンス・リソースのREST APIの例について説明します。
次の表に、すべてのサービス・ファミリにおけるサービス・プリファレンスのトップ・レベル・ビューを取得するためのGETリクエスト構成を示します。
表50-79 サービス・プリファレンス・リソースの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { DBAAS: { displayName: "My Database Preferences" description: "User preferences for Database services" canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas" } MWAAS: { displayName: "My Middleware Preferences" description: "User preferences for Middleware services" canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas" } TAAS: { displayName: "My Tests Preferences" description: "User preferences for Testing as a Service (TaaS)" canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/taas" } canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services" }
この項では、データベース・サービスのプリファレンスを指定するマイ・データベース・プリファレンス・リソースのREST APIの例について説明します。
次の表にGETリクエスト構成を示します。
表50-80 DBaaSユーザー・プリファレンス・メタデータの詳細を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas/metadata |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { servicePreferencesMetadata: { items: { name: "defaultPaasZone" displayName: "Default PaaS Infrastructure Zone" description: "Default PaaS Infrastructure Zone" currentValue: "" isRequiredAttribute: false possibleValues: { value: "dbaas_west_coast_zone" } } } canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas/ metadata" }
次の表にPUTリクエスト構成を示します。
表50-81 DBaaSユーザー・プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "servicePreferences": { "items":[ { "name": "defaultPaasZone", "value": "dbaas_west_coast_zone" } ] } } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: Service Preferences updated successfully." }
次の表にPUTリクエスト構成を示します。
表50-82 空白のDBaaSユーザー・プリファレンス設定を設定するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "servicePreferences": { "items":[ { "name": "defaultPaasZone", "value": "" } ] } } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: Service Preferences updated successfully." }
次の表にGETリクエスト構成を示します。
表50-83 DBaaSユーザー・プリファレンス設定を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/dbaas" servicePreferences: { items: { name: "defaultPaasZone" value: "dbaas_west_coast_zone" } } }\
この項では、ミドルウェア・サービスのユーザー・プリファレンスREST APIの例を示します。
次の表にGETリクエスト構成を示します。
表50-84 MWaaSユーザー・プリファレンス・メタデータを表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas/metadata/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { servicePreferencesMetadata: { items: { name: "defaultPaasZone" displayName: "Default PaaS Infrastructure Zone" description: "Default PaaS Infrastructure Zone" currentValue: "" isRequiredAttribute: false possibleValues: { value: "mwaas_east_coast_zone" } } } canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas/ metadata" }
次の表にPUTリクエスト構成を示します。
表50-85 MWaaSユーザー・プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "servicePreferences": { "items":[ { "name": "defaultPaasZone", "value": "mwaas_east_coast_zone" } ] } } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: Service Preferences updated successfully." }
0
表50-86 空白のMWaaSユーザー・プリファレンス設定を設定するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
{ "servicePreferences": { "items":[ { "name": "defaultPaasZone", "value": "" } ] } } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: Service Preferences updated successfully." }
次の表にGETリクエスト構成を示します。
表50-87 MWaaSユーザー・プリファレンス設定を表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas/ |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/mwaas" servicePreferences: { items: { name: "defaultPaasZone" value: "mwaas_west_coast_zone" } } }
この項では、Testing as a Service (TaaS)のユーザー・プリファレンスREST APIの例を詳しく説明します。
次の表にGETリクエスト構成を示します。
表50-88 TaaSユーザー・プリファレンス・メタデータを表示するためのGETリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/taas/metadata |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= Content-Type: application/json |
本文 |
なし |
リクエスト・メソッド |
GET |
受け取るレスポンスの例を次に示します。
Status 200 OK { servicePreferencesMetadata: { items: { name: "defaultInstanceRootPassword" displayName: "Default Instance Root Password" description: "The password that will be set as default root password to new environment and test driver instance." currentValue: "" isRequiredAttribute: false } } canonicalLink: "/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/taas/m etadata" }
次の表にPUTリクエスト構成を示します。
表50-89 TaaSユーザー・プリファレンスを更新するためのPUTリクエスト構成
機能 | 指定 |
---|---|
URI |
https://<OMS_HOST>:<OMS_CONSOLE_PORT>/em/websvcs/restful/extws/cloudservices/ssa/cfw/v1/mypreferences/services/taas |
リクエスト・ヘッダー |
Authorization: basic ZGVtb3VzZXI6ZGVtb3VzZXI= |
本文 |
{ "servicePreferences": { "items":[ { "name": "defaultInstanceRootPassword", "value": "AQPY8bgHk" } ] } } |
リクエスト・メソッド |
PUT |
受け取るレスポンスの例を次に示します。
Status 200 OK { message: "Service Preferences updated successfully." }