ジョブID別サーバー操作のステータスの表示
/paas/service/jcs/api/v1.1/instances/{identityDomainId}/{serviceId}/servers/history/job/{jobId}
リクエスト
- identityDomainId
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- jobId
型:string
必須:true
ジョブID。 すべての操作のジョブIDを表示するには、「すべてのサーバー操作の表示」を参照してください。- serviceId
型:string
必須:true
Oracle Java Cloud Serviceインスタンスの名前。ヘッダー・パラメータ- X-ID-TENANT-NAME
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
レスポンス
サポートされているメディア・タイプ- application/json
200レスポンスOK (操作が完了した場合)。 後述のルート・スキーマを参照してください。202 Response受入れ済(操作が実行中の場合)。 返される可能性のあるその他のHTTPステータス・コードの詳細は、「ステータス・コード」を参照してください。本文ネストされたスキーマ: actLogタイプ:object
ログで定義されているアクティビティをグループ化します。- activityLogId
-
型:
string
アクティビティ・ログのID。 - endDate
-
型:
string
操作が終了した日時。 - hostName
-
型:
string
サーバーまたはロード・バランサのホスト名。 - id
-
型:
string
操作のID。 - identityDomainId
-
型:
string
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
- jobId
-
型:
string
操作のジョブID。注意: この値は、処理のために送信される直前に、一時的にNo Job Submittedに設定される可能性があります。
- messages
-
型:
array
messagesアクティビティ・メッセージのグループ化。 - operation
-
型:
object
operation操作に関する情報をグループ化します。 - serverName
-
型:
string
サーバーまたはロード・バランサの名前。 - serverType
-
型:
string
サーバーのタイプ(WLS
またはOTD
など)。 - serviceId
-
型:
string
Oracle Java Cloud ServiceインスタンスのID。 - serviceName
-
型:
string
Oracle Java Cloud Serviceインスタンスの名前。 - startDate
-
型:
string
操作を開始した日時。 - status
-
型:
string
操作の最終的な状態。 ステータス・メッセージの例として、NEW
、RUNNING
、SUCCEED
およびFAILED
などがあります。
ネストされたスキーマ: operationタイプ:object
操作に関する情報をグループ化します。- operationId
-
型:
string
操作のID。 - operationType
-
型:
string
操作タイプ。 たとえば、SCALE_IN
、SCALE_OUT
、START_VM
、STOP_VM
、START_SERVICE
、STOP_SERVICE
などです。
ネストされたスキーマ: messages- activityDate
-
型:
string
アクティビティが記録された日付と時間。 - activityMessageId
-
型:
string
個々のアクティビティ・メッセージのID。 - message
-
型:
string
アクティビティの詳細。 - stepName
-
型:
string
アクティビティのログが記録されたときの操作のステータス。 ステータス・メッセージの例として、NEW
、RUNNING
、SUCCEED
およびFAILED
などがあります。
例
次の例は、Oracle Java Cloud Serviceインスタンスのサーバー操作に関する情報をジョブIDを使用して表示する方法を示しています。 この例では、cURLを使用してRESTリソースに対してGETリクエストを発行しています。
注意: この例のコマンドでは、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 -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/servers/history/job/8971
レスポンス・ヘッダーの例
操作が発行されたときのレスポンス・ヘッダーの例を次に示します。
HTTP/1.1 202 Accepted Date: Fri, 17 Jun 2016 01:47:42 GMT Transfer-Encoding: chunked Content-Type: application/json Content-Location: https://rest_server_url/paas/service/jcs/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance/servers/history/2,087
レスポンス本文の例
次に、完了したスケール・アウト操作に関するアクティビティ・ログを取得するレスポンス本文の例を示します。
{ "canonicalUri":null, "actLog": { "activityLogId":2087, "serviceId":130, "operation": { "operationId":130, "operationType":"SCALE_OUT" }, "status":"SUCCEED", "startDate":"Jun 17, 2016 1:47:13 AM", "endDate":"Jun 17, 2016 2:09:38 AM", "identityDomain":"ExampleIdentityDomain", "serviceName":"ExampleInstance", "serviceType":"jaas", "hostName":"exampleinstance-wls-2", "serverName":null, "serverType":"WLS", "jobId":8971, "summaryMessage":"ExampleI_server_2", "authDomain":"exampleidentitydomain", "authUser":"username", "initiatedBy":"USER", "messages":[ { "activityMessageId":2946, "activityDate":"Jun 17, 2016 1:47:13 AM", "stepName":"NEW", "message":"Activity Submitted" }, { "activityMessageId":2947, "activityDate":"Jun 17, 2016 1:47:17 AM", "stepName":"RUNNING", "message":"Activity Started" }, { "activityMessageId":2948, "activityDate":"Jun 17, 2016 1:47:21 AM", "stepName":"RUNNING", "message":"Scaling job for service [ExampleInstance] in cluster [ExampleI_cluster] with factor [1] is prepared." }, ... ... { "activityMessageId":3012, "activityDate":"Jun 17, 2016 2:09:38 AM", "stepName":"RUNNING", "message":"Scale out for service [ExampleInstance] succeeded" }, { "activityMessageId":3013, "activityDate":"Jun 17, 2016 2:09:38 AM", "stepName":"RUNNING", "message":"Completed submitting OTD script for remote execution on service [ExampleInstance]" }, { "activityMessageId":3014, "activityDate":"Jun 17, 2016 2:09:38 AM", "stepName":"RUNNING", "message":"Service [ExampleInstance] is not provisioned with OTD, hence notifying OTD with server [ExampleI_server_2] is bypassed" }, { "activityMessageId":3015, "activityDate":"Jun 17, 2016 2:09:38 AM", "stepName":"SUCCEED", "message":"Activity Ended" } ], "resourceType":"VM", "resourceId":180, "resourceName":"exampleinstance-wls-2", "payload":null }, "messages":[{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{},{}] }