サービス・インスタンスの表示
/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}
リクエスト
- identityDomainId
-
型:
string必須:trueOracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- serviceId
型:string必須:trueOracle Java Cloud Serviceインスタンスの名前。
- X-ID-TENANT-NAME
-
型:
string必須:trueOracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
レスポンス
- application/vnd.com.oracle.oracloud.provisioning.Service+json
- auto_update
-
型:
booleanメンテナンス中にOracle Cloud Toolsに対する更新が自動的にOracle Java Cloud Serviceインスタンスに適用されるかどうかを指定するフラグ。 Oracle Cloud Toolsは、サービス・インスタンスのライフサイクルの管理に使用されます。 - cluster_name
-
型:
stringサービス・インスタンスの管理対象サーバーを含むクラスタの名前。 - compliance_status
-
型:
stringOracle Cloud Toolsのバージョンがコンプライアンスに準拠しているかどうかを示すステータス。 OracleはOracle Cloud Toolsを使用して、サービス・インスタンスのライフサイクルを管理します。 Oracle Cloud Toolsがコンプライアンスに準拠していない場合、この属性は次のステータス値のいずれかに設定されます。NEW_VERSION: Oracle Cloud Toolsの新しいバージョンを使用できることを示します。 この更新をできるだけ早く適用することをお薦めします。DEPRECATED: Oracle Cloud Toolsの現行バージョンは非推奨になっていることを示します。 最新のOracle Cloud Tools更新を適用し、将来のサービスの中断を回避します。UNSUPPORTED: Oracle Cloud Toolsの現行バージョンはサポートされていないことを示します。 最新のパッチを適用して、通常の操作を再開します。
Oracle Cloud Toolsが最新の場合、この属性は空白になります。
- compliance_status_desc
-
型:
stringOracle Java Cloudサービス・インスタンスのライフサイクルを管理するために使用されるOracle Cloud Toolsのコンプライアンス・ステータスに関する詳細を提供する説明。 Oracle Cloud Toolsがコンプライアンスに準拠していない場合、この属性は次のステータス値のいずれかになります。Oracle Cloud Toolsがコンプライアンスに準拠していない場合、この属性は次のステータス値のいずれかに設定されます。NEW_VERSION: Oracle ツールのより新しいバージョンlatestVersionを使用できます。 この更新には、Oracle Cloud Toolsに対するクリティカルな修正が含まれます。 OracleはCloud Toolsを使用して、サービスのライフサイクルを管理します。 この更新をできるだけ早く適用することをお薦めします。DEPRECATED: OracleツールのバージョンdeprecatedVersionは非推奨であるため、このサービスは、現在、非推奨の状態にあります。 このバージョンは将来サポートされなくなる可能性があるため、最新のOracleツールの更新を適用してください。UNSUPPORTED: Oracleツール・バージョンunsupportedVersionは廃止されたため、このサービスは現在サポートされていない状態にあります。 最新のパッチを適用して、通常の操作を再開します。
Oracle Cloud Toolsが最新の場合、この属性は空白になります。
- compute_site_name
-
型:
stringサービス・インスタンスがプロビジョニングされている場所。 - content_url
-
型:
stringデプロイしたアプリケーションにHTTPを使用してアクセスするリソースURL。 - created_by
-
型:
stringOracle Java Cloud Serviceインスタンスの作成に使用されるユーザー・アカウントの名前。 - creation_job_id
-
型:
string作成ジョブのジョブID - creation_time
-
型:
stringOracle Java Cloud Serviceインスタンスが作成された日付および時間。 - db_associations
-
タイプ:
arraydb_associations使用されているDatabase Cloud Serviceデータベース・デプロイメントおよびデータベースの詳細をグループ化します。 - db_info
-
型:
stringOracle Required Schemaをホストするために使用されるデータベース。Oracle Public Cloudでは、これにはDatabase Cloud Serviceデータベース・デプロイメントに関する情報が含まれています。
Oracle Cloud Machineでは、これはデータベース接続文字列です。
- db_service_name
-
型:
stringこの属性は、Oracle Public Cloudでのみ使用できます。Oracle Required Schemaをホストするために使用されるDatabase Cloud Serviceデータベース・デプロイメントの名前。
- db_service_uri
-
型:
stringこのサービス・インスタンスのOracle Database Cloud Serviceデータベース・デプロイメントのリソースURL。 - deletion_job_id
-
型:
integer削除ジョブのジョブID - description
-
型:
stringサービス・インスタンスに関する追加情報を提供する自由形式のテキスト。 - domain_mode
-
型:
stringドメインのモード。 有効な値は、DEVELOPMENTおよびPRODUCTIONです。 - domain_name
-
型:
stringWebLogicドメインの名前。 - エディション
-
型:
stringソフトウェア・エディション。 有効な値は、「SE」、「EE」または「SUITE」です。 - error_status_desc
-
型:
stringOracle Java Cloud Serviceインスタンスがエラー状態にある理由を説明するエラー・ステータス。 次に、説明の例を示します。This service is currently in an erroneous state as the tools are in an inconsistent state. Reason - error details. Apply the latest tools patch to resume normal operations on this service. - fmw_control_url
-
型:
stringEnterprise Manager Fusion Middleware ControlへのURL。 - identity_domain
-
型:
stringOracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- isApp2Cloud
-
型:
booleanこの属性は、Oracle Public Cloudでのみ使用できます。このサービス・インスタンスがAppToCloudアーティファクトとともに作成されたかどうかを指定するフラグ。 この属性は、サービス・インスタンスがAppToCloudアーティファクトとともに作成された場合にのみ表示されます。
- last_modified_time
-
型:
stringOracle Java Cloud Serviceインスタンスが変更された日付および時間。 - level
-
型:
stringサービス・レベル 有効な値は次のとおりです。PAAS: 本番レベル・サービス。 Oracle Java Cloud Serviceインスタンスの作成および監視、バックアップおよびリストア、パッチ適用およびスケーリングをサポートします。 これはデフォルトです。BASIC: 開発者レベル・サービス。 Oracle Java Cloud Serviceインスタンスの作成および監視をサポートします。 注意: このサービス・レベルはバックアップおよびリストア、パッチ適用またはスケーリングをサポートしていません。
- lifecycle_control_job_id
-
型:
integerライフサイクル制御リクエストのジョブID。 長整数値です。 この属性は、ライフサイクル制御リクエストが進行中の場合にのみ表示されます。 このIDを使用して、ライフサイクル制御リクエスト(たとえば、起動/停止/再起動操作)のステータスを確認できます(サービス・インスタンス・ライフサイクル操作のステータスの表示を参照)。 - memory_size
-
型:
integerサービス・インスタンスのすべてのノードに対して割り当てられるメモリーの合計量(GB)。 - num_ip_reservations
-
型:
integerOracle Java Cloud Serviceインスタンス用に予約されたパブリックIPアドレスの総数。 - num_nodes
-
型:
integerドメイン内の管理対象サーバーの数。 - ocpu_count
-
型:
integerサービス・インスタンスのすべてのノードに対して割り当てられるOracle Compute Units (OCPU)の合計数。 - options
-
型:
arrayoptionsCoherenceデータ層に関する情報をグループ化します。 - otd_admin_url
-
型:
stringロード・バランサ管理コンソールへのURL。 - otd_provisioned
-
型:
stringロード・バランサが有効になっているかどうかを指定するフラグ。 - otd_shape
-
型:
stringロード・バランサの必要なコンピューティング・シェイプ。 - otd_storage_size
-
型:
integerロード・バランサの記憶域サイズ(GB)。 - psm_plugin_version
-
型:
stringPaaS Service Managerのバージョン。 - sample_app_url
-
型:
stringサービス・インスタンスのプロビジョニング時にサンプル・アプリケーションがインストールおよびデプロイされていた場合のアクセス用URL。 Oracle Public Cloudの場合、『Oracle Java Cloud Serviceの使用』のOracle Java Cloud Serviceインスタンスにデプロイされるサンプル・アプリケーションについての項を参照してください。 Oracle Cloud Machineの場合、『OPCMでのOracle Java Cloud Serviceの使用』の「Oracle Java Cloud Serviceインスタンスにデプロイされるサンプル・アプリケーションについて」を参照してください。 - secure_content_url
-
型:
stringデプロイしたアプリケーションにHTTPSを使用してアクセスするURL。 - service_components
-
型:
arrayservice_componentsサービス・コンポーネントの詳細をグループ化します。 - service_name
-
型:
stringOracle Java Cloud Serviceインスタンスの名前。 - service_uri
-
型:
stringOracle Java Cloud ServiceインスタンスのリソースURL。 - shape
-
型:
string必要なコンピューティング・シェイプ。 - shiftJobId
-
型:
stringこの属性は、Oracle Public Cloudでのみ使用できます。AppToCloudの移行に関する
customPayloadインポート操作のジョブID。 この属性は、サービス・インスタンスがAppToCloudアーティファクトとともに作成された場合にのみ表示されます。 - shiftStatus
-
型:
stringこの属性は、Oracle Public Cloudでのみ使用できます。AppToCloudの移行に関するサービス・インスタンスのステータス。 指定可能な値:
readyToShift、shiftCompleted、shiftFailed。この属性は、サービス・インスタンスがAppToCloudアーティファクトとともに作成された場合にのみ表示されます。
- status
-
型:
stringOracle Java Cloud Serviceインスタンスのステータスを指定するフラグ。 有効な値は、「Running」、「In Progress」、「Maintenance」、「Stopped」、「Terminating」および「Failed」です。 - storage_size
-
型:
integerサービス・インスタンスのすべてのノードに対して割り当てられるブロック・ストレージの合計量(GB)。 - subscription_type
-
型:
string請求頻度。Oracle Public Cloudでは、有効な値は次のとおりです。
HOURLY: 請求期間中に使用された時間数に対してのみ支払います。MONTHLY: 使用された時間数に関係なく、満1か月に対して単一の価格を支払います。
Oracle Cloud Machineの場合、現時点ではこの属性は適用できません。
- upper_stack_product_name
-
型:
stringこの属性は、Oracle Public Cloudでのみ使用できます。Oracle Fusion Middleware製品インストーラがこのサービス・インスタンスに追加されました。 例えば:
WCP - version
-
型:
stringOracle Fusion Middleware ソフトウェア・バージョン。 有効な値は、12cRelease212、12cRelease2、12cR3および11gです。 - wls_admin_url
-
型:
stringWebLogic管理コンソールへのURL。 - wls_deployment_channel_port
-
型:
integerWLSTを使用して、管理サーバーにアクセスするためのポート。 - wlsVersion
-
型:
stringOracle WebLogic Serverのソフトウェア・バージョン。 例:12.2.1.2.0、12.2.1.0.x、12.1.3.0.xおよび10.3.6.0.x。
array-
タイプ:
objectdb_associations
- db_apex_url
-
型:
stringサービス・インスタンス上のOracle Application Expressへの接続に使用するURL。 - db_app
-
型:
booleanこのデータベースをアプリケーション・スキーマのホストに使用するかどうかを指定するフラグ(true)。 - db_connect_string
-
型:
stringOracle Public Cloudでは、これにはDatabase Cloud Serviceデータベース・デプロイメントに関する情報が含まれています。
Oracle Cloud Machineでは、これはデータベース接続文字列です。
- db_em_url
-
型:
stringサービス・インスタンス上のEnterprise Managerへの接続に使用するURL。 - db_infra
-
型:
booleanこのデータベースを使用してOracle Required Schema(true)をホストするかどうかを指定するフラグ。 - db_monitor_url
-
型:
stringサービス・インスタンス上のOracle DBaaS Monitorへの接続に使用するURL。 - db_service_level
-
型:
stringDatabase Cloud Serviceデータベース・デプロイメントのサービスレベル。Oracle Cloud Machineでは、唯一の値は
PAASです。 - db_service_name
-
型:
stringDatabase Cloud Serviceデータベース・デプロイメントの名前。 - db_version
-
型:
stringOracleデータベースのバージョン。 - pdb_service_name
-
型:
stringOracle Database 12c用に作成されたプラガブル・データベースの名前。 この値は、Oracle Database 11gを実行しているDatabase Cloud Serviceデータベース・デプロイメントには適用されません。
すべてのサービス・インスタンスを表示する場合、?outputLevel=verbose問合せパラメータが設定されているとこの属性が返されます。
- clusterName
-
型:
stringサービス・インスタンスのCoherenceデータ層クラスタの名前。 - heapIncrements
-
型:
stringスケール・アウト操作の結果として容量単位が追加されるときに使用可能な追加ヒープ。 - heapSize
-
型:
string容量単位でJVMごとに構成するヒープ・サイズ。 - jvmCount
-
型:
integer容量単位でVMごとに構成するJVMまたは管理対象サーバーの数。 - maxHeap
-
型:
stringサイトに基づく、使用可能な最大JVMヒープ。 - maxPrimary
-
型:
stringサイトに基づく、提供可能な最大プライマリ・キャッシュ。 - maxScalingUnit
-
型:
integerサイトに基づく、プロビジョニング可能な容量単位の最大数。 - primaryIncrements
-
型:
stringスケール・アウト操作の結果として容量単位が追加されるときに追加可能なプライマリ・キャッシュ記憶域。 - scalingUnitCount
-
型:
integerサービス・インスタンスに対してプロビジョニングされる容量単位の数。 - scalingUnitInstances
-
型:
arrayscalingUnitInstancesサービス・インスタンスでプロビジョンされる容量単位に関する情報をグループ化します。 - scalingUnitName
-
型:
stringデフォルトの容量単位の名前(サービス・インスタンスで使用される場合)。 - shape
-
型:
string容量単位によってプロビジョニングされる仮想マシンのシェイプ。 - totalHeap
-
型:
string容量単位ごとに構成されるJVMの数に基づく、使用可能な合計ヒープ。 - totalPrimary
-
型:
stringCoherenceに割り当てる合計プライマリ・キャッシュ記憶域は、一般的にJVMヒープ・サイズを3つに分割するルールに基づき、プライマリ・キャッシュ記憶域、バックアップ記憶域およびスクラッチ領域にそれぞれ1/3ずつ使用されます。 - vmCount
-
型:
integer容量単位ごとに構成される仮想マシンの数。
- name
-
型:
stringCoherenceデータ層の管理対象サーバーの名前。
- type
-
型:
stringサービス・コンポーネント・タイプ。 有効な値は、「JDK」、「OTD」、「OTD_JDK」または「WLS」です。 - version
-
型:
string指定されたコンポーネントのソフトウェア・バージョン。 たとえば、WLSの場合は12.1.3.0.5、OTDの場合は11.1.1.9.1、OTD_JDKの場合は1.7.0_91、またはJDKの場合は1.7.0_91のようにします。
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによってOracle Java Cloud Serviceインスタンスについて詳細情報を表示する方法を示しています。
注意: この例のコマンドでは、URL構造https://rest_server_url/resource-pathが使用されています。ここで、rest_server_urlはアイデンティティ・ドメインまたはテナント名を問い合せるためのOracle Public CloudまたはOracle Cloud MachineのRESTサーバーです。 Oracle Public CloudまたはOracle Cloud Machineに使用する適切なURL構造の詳細は、リクエストの送信を参照してください。
cURLコマンド
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
レスポンス・ヘッダーの例
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 200 OK Date: Tue, 14 Jun 2016 19:36:40 GMT Transfer-Encoding: chunked Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
レスポンス本文の例(Oracle Public Cloud)
JSON形式のレスポンス本文の例を次に示します。
{
"service_name" : "ExampleInstance",
"version" : "12cR3",
"wlsVersion": "12.1.3.0.160419",
"status" : "Running",
"error_status_desc": "",
"compliance_status": "",
"compliance_status_desc": "",
"auto_update": "true",
"description" : "Example, Inc product distribution",
"identity_domain" : "ExampleIdentityDomain",
"creation_time": "Tue Jun 14 19:14:27 UTC 2016",
"last_modified_time": "Tue Jun 14 19:14:25 UTC 2016",
"created_by":"username",
"service_uri" : "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance",
"domain_name" : "ExampleDomain",
"domain_mode" : "PRODUCTION",
"cluster_name" : "ExampleCluster",
"num_nodes" : 3,
"level" : "PAAS",
"subscription_type" : "HOURLY",
"edition" : "EE",
"shape" : "oc3",
"otd_provisioned" : "yes",
"otd_shape" : "oc3",
"otd_storage_size": 41984,
"service_components": [
{
"type": "WLS",
"version": "12.1.3.0.160419"
},
{
"type": "OTD_JDK",
"version": "1.7.0_101"
},
{
"type": "OTD",
"version": "11.1.1.9.2"
},
{
"type": "JDK",
"version": "1.7.0_101"
}],
"creation_job_id" : "8466",
"deletion_job_id" : 0,
"lifecycle_control_job_id" : 273,
"db_info" : "myDBService:1521\/PDB1.exampleidentitydomain.oraclecloud.internal",
"db_service_name" : "myDBService",
"num_ip_reservations" : 3,
"wls_admin_url" : "https:\/\/192.0.2.0:7002\/console",
"fmw_control_url" : "https:\/\/192.0.2.0:7002\/em",
"otd_admin_url" : "https:\/\/192.0.2.23:8989",
"sample_app_url": "https:\/\/192.0.2.23\/sample-app\/",
"content_url" : "http:\/\/192.0.2.23",
"secure_content_url" : "https:\/\/192.0.2.23",
"wls_deployment_channel_port": 9001,
"psm_plugin_version": "16.3.1-132"
"compute_site_name": "XY001_Z23",
"db_associations": [
{
"db_service_name": "myAppDBService",
"db_infra": false,
"db_connect_string": "myAppDBService:1521\/PDB1A.exampleidentitydomain.oraclecloud.internal",
"pdb_service_name": "PDB1A",
"db_version": "12.1.0.2"
},
{
"db_service_name": "myDBService",
"db_infra": true,
"db_connect_string": "myDBService:1521\/PDB1.exampleidentitydomain.oraclecloud.internal",
"pdb_service_name": "PDB1",
"db_version": "12.1.0.2"
}]
}
サービス・インスタンスがAppToCloudアーティファクトとともに最近作成され、オンプレミスのドメインがまだインポートされていない場合、次の追加の属性が表示されます。
"isApp2Cloud": "true",
"shiftStatus": "readyToShift",
オンプレミスのドメインがAppToCloudサービス・インスタンスにインポートされている場合は、インポートのジョブIDが表示されます。 例:
"shiftStatus": "shiftCompleted",
"shiftJobId": "30059",
"isApp2Cloud": "true",
レスポンス本文の例(Oracle Cloud Machine)
JSON形式のレスポンス本文の例を次に示します。
{
"service_name" : "ExampleInstance",
"version" : "12cR3",
"wlsVersion" : "12.1.3.0.160419",
"status" : "Running",
"error_status_desc": "",
"compliance_status": "",
"compliance_status_desc": "",
"auto_update": "true",
"description" : "Example, Inc product distribution",
"identity_domain" : "myTenantName",
"creation_time": "Thu Aug 25 22:32:8 UTC 2016",
"last_modified_time": "Thu Aug 25 22:32:6 UTC 2016",
"created_by":"username",
"service_uri" : "https:\/\/rest_server_url\/paas\/service\/jcs\/api\/v1.1\/instances\/myTenantName\/ExampleInstance",
"domain_name" : "ExampleDomain",
"domain_mode" : "PRODUCTION",
"cluster_name" : "ExampleCluster",
"num_nodes" : 3,
"level" : "PAAS",
"subscription_type" : "HOURLY",
"edition" : "EE",
"shape" : "oc3",
"otd_provisioned" : "yes",
"otd_shape" : "oc3",
"otd_storage_size": 43008,
"service_components": [
{
"type": "WLS",
"version": "12.1.3.0.160419"
},
{
"type": "OTD_JDK",
"version": "1.7.0_101"
},
{
"type": "OTD",
"version": "11.1.1.9.2"
},
{
"type": "JDK",
"version": "1.7.0_101"
}],
"creation_job_id" : "1",
"deletion_job_id" : 0,
"lifecycle_control_job_id" : 273,
"db_info": "mydbhost:1521\/dbservicename",
"num_ip_reservations" : 3,
"wls_admin_url" : "https:\/\/thehost:7002\/console",
"fmw_control_url" : "https:\/\/thehost:7002\/em",
"otd_admin_url" : "https:\/\/thelbhost:8989",
"sample_app_url": "https:\/\/thehost\/sample-app\/",
"content_url": "http:\/\/thehost",
"secure_content_url" : "https:\/\/thehost",
"wls_deployment_channel_port": 9001,
"psm_plugin_version": "16.3.3-1-168",
"compute_site_name": "PRIVATE_SITE",
"db_associations": [
{
"db_connect_string": "mydbhost:1521\/dbservicename",
"db_infra": true
}]
}
レスポンス本文のDatagridオプションの例
次に、サービス・インスタンスで(Oracle Public CloudまたはOracle Cloud Machine上で)Oracle Coherenceが有効な場合のレスポンス本文のdatagridオプションに関する例を示します。
"options": [{
"type": "datagrid",
"clusters": [{
"clusterName": "ExampleI_DGCluster",
"scalingUnitCount": 4,
"scalingUnitName": "BASIC",
"shape": "oc3",
"vmCount": 1,
"jvmCount": 1,
"heapSize": "4608M",
"maxScalingUnit": 30,
"heapIncrements": "4608M",
"primaryIncrements": "1536M",
"totalHeap": "18432M",
"totalPrimary": "6144M",
"maxHeap": "138240M",
"maxPrimary": "46080M",
"scalingUnitInstances": [
{
"servers": [{"name": "ExampleI_server_3_DG"}],
"scalingUnitInstanceId": 4,
"status": "Ready"
},
{
"servers": [{"name": "ExampleI_server_4_DG"}],
"scalingUnitInstanceId": 6,
"status": "Ready"
},
{
"servers": [{"name": "ExampleI_server_2_DG"}],
"scalingUnitInstanceId": 2,
"status": "Ready"
},
{
"servers": [{"name": "ExampleI_server_5_DG"}],
"scalingUnitInstanceId": 8,
"status": "Ready"
}
]
}]
}]