Oracle Java Cloud Service REST API

機械翻訳について

サービス・インスタンスの監視

get

/paas/core/api/v1.1/healthcheck/{identityDomainId}/services/jaas/instances/{serviceId}

指定されたOracle Java Cloud Serviceインスタンスの状態監視データを返します。

監視情報は次の各レベルで提供されます。

サービス・インスタンス
コンポーネント(OTD、WLS)
仮想マシン(VM)
サーバー

OTDレベルおよびサーバー・レベルでは、より詳細なランタイム・メトリックが提供されます。

OTDコンポーネントについては、次の状態メトリックが提供されます。

epsLast5MinAvg - 過去5分間の平均エラー数/秒。
errorRequestCount - ロード・バランサが起動されてからの合計エラー・リクエスト数。
rtLast4MinAvg - 過去5分間の平均レスポンス時間。
requestCount - ロード・バランサが起動されてからの合計リクエスト数。
upsince - ロード・バランサが起動されてからの時間(UTC)。

サーバーごとに、次の各メトリックが提供されます。

heapfree - 空きヒープ・メモリー量(MB)。
heapmax - 最大ヒープ・サイズ(MB)。
upsince - ロード・バランサが起動されてからの時間(UTC)。

注意: 状態監視メトリックは毎時更新されます。このため、次の時間のリフレッシュまでメトリックが最新でないこともあります。

リクエスト

パス・パラメータ

identityDomainId: 型: string

必須: true

Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。
Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
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. 返される可能性のあるその他のHTTPステータス・コードの詳細は、「ステータス・コード」を参照してください。

本文

レスポンス本文には、状態監視情報が含まれます。

ルート・スキーマ: monitor-response

レスポンス本文には、状態監視情報が含まれます。

プロパティ

identity_domain: 型: string

Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID (Oracle Public Cloudの場合)。
Oracle Java Cloud Serviceインスタンスのテナント名(Oracle Cloud Machineの場合)。
service_components: 型: array service_components

Oracle Java Cloud Serviceコンポーネントの状態の詳細をグループ化します。
service_name: 型: string

Oracle Java Cloud Serviceインスタンスの名前。
summary: 型: object summary

Oracle Java Cloud Serviceインスタンスの健全性のサマリーの詳細をグループ化します。

ネストされたスキーマ: service_components

型: array

Oracle Java Cloud Serviceコンポーネントの状態の詳細をグループ化します。

アイテム

タイプ: object service_components_health

ネストされたスキーマ: summary

タイプ: object

Oracle Java Cloud Serviceインスタンスの健全性のサマリーの詳細をグループ化します。

プロパティ

status: 型: string

インスタンスの状態有効な値はUP、DOWN、またはERROR(状態チェックでシステム・エラーが発生したことを示す)です。
status_time: 型: string

ステータスが記録された時間(UTC)。

ネストされたスキーマ: service_components_health

プロパティ

component: 型: string

状態データを記録するコンポーネント。有効な値には、OTDおよびWLSが含まれます。
health_data: 型: array health_data

Oracle Java Cloud Serviceインスタンス・コンポーネントのランタイム・メトリックをグループ化します。
summary: 型: object summary

Oracle Java Cloud Serviceインスタンス・コンポーネントの状態のサマリーをグループ化します。
vms: 型: array vms

Oracle Java Cloud Serviceコンポーネントに関連付けられているVMの状態の詳細をグループ化します。

ネストされたスキーマ: health_data

型: array

Oracle Java Cloud Serviceインスタンス・コンポーネントのランタイム・メトリックをグループ化します。

アイテム

型: object health_data

ネストされたスキーマ: summary

タイプ: object

Oracle Java Cloud Serviceインスタンス・コンポーネントの状態のサマリーをグループ化します。

プロパティ

status: 型: string

コンポーネントのステータス。有効な値はUP、DOWN、またはERROR(状態チェックでシステム・エラーが発生したことを示す)です。
status_message: 型: string

ステータス・メッセージ(存在する場合)。
status_time: 型: string

ステータスが記録された時間(UTC)。
sub_status: 型: string

サブコンポーネントのステータス(適用できる場合)。

ネストされたスキーマ: vms

型: array

Oracle Java Cloud Serviceコンポーネントに関連付けられているVMの状態の詳細をグループ化します。

アイテム

型: object vms

ネストされたスキーマ: health_data

プロパティ

displayName: 型: string

ヘルス・モニタリング・ランタイム・メトリックの表示名。
name: 型: string

状態監視ランタイム・メトリックの名前。
unit: 型: string

メトリックの単位。たとえば、MBおよびmsです。
value: 型: string

監視データの値。

ネストされたスキーマ: vms

プロパティ

servers: 型: array servers

VMで実行されているサーバーの状態の詳細をグループ化します。
summary: 型: object summary

VMの状態サマリーをグループ化します。
vm: 型: string

VMの名前。

ネストされたスキーマ: servers

型: array

VMで実行されているサーバーの状態の詳細をグループ化します。

アイテム

型: object servers

ネストされたスキーマ: summary

タイプ: object

VMの状態サマリーをグループ化します。

プロパティ

status: 型: string

VMのステータス。有効な値はUP、DOWN、またはERROR(状態チェックでシステム・エラーが発生したことを示す)です。
status_time: 型: string

ステータスが記録された時間(UTC)。

ネストされたスキーマ: servers

プロパティ

health_data: 型: array health_data

サーバーの状態の詳細をグループ化します。
server_name: 型: string

サーバーの名前。
server_role: 型: string

サーバー・タイプ。例: MANAGEDまたはADMIN。
summary: 型: object summary

サーバーのヘルス・ステータスのサマリーをグループ化します。

ネストされたスキーマ: health_data

型: array

サーバーの状態の詳細をグループ化します。

アイテム

型: object health_data

ネストされたスキーマ: summary

タイプ: object

サーバーのヘルス・ステータスのサマリーをグループ化します。

プロパティ

status: 型: string

サーバーのステータス。有効な値はUP、DOWN、またはERROR(状態チェックでシステム・エラーが発生したことを示す)です。
status_message: 型: string

ステータス・メッセージ(存在する場合)。
status_time: 型: string

ステータスが記録された時間(UTC)。

404 Response

Not Found

500 Response

Internal Server Error

例

次の例では、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/core/api/v1.1/healthcheck/ExampleIdentityDomain/services/jaas/instances/ExampleInstance

レスポンス・ヘッダーの例

次にレスポンス・ヘッダーの例を示します。

HTTP/1.1 200 OK
Date: Thu, 17 Nov 2016 20:23:11 GMT
Transfer-Encoding: chunked
Content-Type: application/json

レスポンス本文の例

次の例では、JSON形式で返されるレスポンスを示しています。

{
    "summary":
    {
        "status":"UP",
        "status_time":"2016-11-17T20:23:20.029+00:00"
    },
    "identity_domain":"ExampleIdentityDomain",
    "service_components":[
    {
        "summary":
        {
            "status":"UP",
            "status_time":"2016-11-17T20:23:11.000+00:00"
        },
        "component":"OTD",
        "vms":[
        {
            "summary":
            {
                "status":"UP",
                "status_time":"2016-11-17T20:23:18.511+00:00"
            },
            "vm":"exampleinstance-lb-1",
            "servers":[]
        }],
        "health_data":[
        {
            "unit":"count",
            "name":"requestCount",
            "value":"2",
            "displayName":"Execution t"
        },
        {
            "unit":"count",
            "name":"errorRequestCount",
            "value":"0",
            "displayName":"Execution t"
        },
        {
            "unit":"ms",
            "name":"epsLast5MinAvg",
            "value":"0",
            "displayName":"Execution time"
        },
        {
            "unit":"ms",
            "name":"upsince",
            "value":"2016-11-17T19:53:16.000+00:00",
            "displayName":"Server time from when it was up."
        },
        {
            "unit":"ms",
            "name":"rtLast5MinAvg",
            "value":"0",
            "displayName":"Execution t"
        }]
    },
    {
        "summary":
        {
            "status":"UP",
            "status_time":"2016-11-17T20:23:10.000+00:00",
            "status_message":"Number of servers processing request:1"
        },
        "component":"WLS",
        "vms":[
        {
            "summary":
            {
                "status":"UP",
                "status_time":"2016-11-17T20:23:18.511+00:00"
            },
            "vm":"exampleinstance-wls-1",
            "servers":[
            {
                "summary":
                {
                    "status":"UP",
                    "status_time":"2016-11-17T20:23:10.000+00:00"
                },
                "server_name":"ExampleI_server_1",
                "server_role":"MANAGED",
                "health_data":[
                {
                    "unit":"MB",
                    "name":"heapmax",
                    "value":"1820.5",
                    "displayName":"Max memory"
                },
                {
                    "unit":"ms",
                    "name":"upsince",
                    "value":"2016-11-17T19:56:14.000+00:00",
                    "displayName":"Server time from when it was up."
                },
                {
                    "unit":"MB",
                    "name":"heapfree",
                    "value":"1328.96",
                    "displayName":"Free memory"
                }]
            },
            {
                "summary":
                {
                    "status":"UP",
                    "status_time":"2016-11-17T20:23:10.000+00:00",
                    "status_message":"Not processing requests"
                },
                "server_name":"ExampleI_adminserver",
                "server_role":"ADMIN",
                "health_data":[
                {
                    "unit":"MB",
                    "name":"heapmax",
                    "value":"1820.5",
                    "displayName":"Max memory"
                },
                {
                    "unit":"ms",
                    "name":"upsince",
                    "value":"2016-11-17T17:50:22.000+00:00",
                    "displayName":"Server time from when it was up."
                    },                                                
                {
                    "unit":"MB",
                    "name":"heapfree",
                    "value":"1146.91",
                    "displayName":"Free memory"
                }]
            }]
        }]
    }],
    "service_name":"ExampleInstance"
}