自動スケール・ポリシーの表示
get
/paas/api/v1.1/instancemgmt/{identityDomainId}/services/JaaS/instances/{serviceId}/autoscaling/policies
このエンドポイントはOracle Public Cloudでのみ使用できます。
Oracle Java Cloud Serviceインスタンスの最新の自動スケール・ポリシーを返します。
リクエスト
パス・パラメータ
- identityDomainId
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID。- serviceId
型:string
必須:true
Oracle Java Cloud Serviceインスタンスの名前。
ヘッダー・パラメータ
- X-ID-TENANT-NAME
-
型:
string
必須:true
Oracle Java Cloud Serviceアカウントのアイデンティティ・ドメインID。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK。
本文
自動スケール・ポリシーを作成、更新または表示する場合、レスポンス本文には自動スケール・ポリシーの詳細が含まれています。
ルート・スキーマ: autoscalingpolicy-response
自動スケール・ポリシーを作成、更新または表示する場合、レスポンス本文には自動スケール・ポリシーの詳細が含まれています。
- description
-
型:
string
自動スケール・ポリシーの説明。 - message
-
型:
string
例:Rule is Active
- name
-
型:
string
自動スケール・ポリシーの名前。 デフォルト名はサービス・インスタンス名です。 - policies
-
タイプ:
array
policies自動スケール・ポリシーの詳細をグループ化します。 - startTime
-
型:
string
自動スケール・ポリシーが作成または更新された日時。 - status
-
型:
string
自動スケール・ポリシーの状態。 - version
-
型:
string
自動スケール・ポリシーのバージョン。
ネストされたスキーマ: policies
ネストされたスキーマ: policy-details
- alarm
-
タイプ:
object
alarmアラームをトリガーするルールの条件をグループ化します。 - coolDownPeriod
-
型:
integer
スケーリング・アクティビティが完了してから、次のスケーリング・アクティビティを開始できるようになるまでの時間(分単位)。 - maxClusterSize
-
型:
integer
スケール・アウトするときに、サービス・インスタンスによってサポートされる最大クラスタ・サイズ。 - minClusterSize
-
型:
integer
スケール・インするときに、サービス・インスタンスによってサポートされる最小クラスタ・サイズ。 - operation
-
型:
string
アラームがトリガーされたときに実行されるスケーリング操作。 例:scaleOut
、scaleIn
ネストされたスキーマ: alarm
タイプ:
object
アラームをトリガーするルールの条件をグループ化します。
- breachedOnInstance
-
型:
string
アラーム・ルールがすべてのVMインスタンスまたはいずれかのVMインスタンスで違反となったときに、自動スケールが実行されるかどうか。 例:ALL
、ANY
。 - comparisonOperator
-
型:
string
指定したstatistic
値およびthreshold
値を比較するときに使用される算術操作。 例:GreaterThanOrEqualToThreshold
、LessThanOrEqualToThreshold
- metricName
-
型:
string
アラームに設定されているメトリックの名前。 たとえば、CPUUtilization
です - metricUnit
-
型:
string
アラームに関連付けられているメトリックの測定単位。 例:percent
- sampleCount
-
型:
integer
特定のメトリックでデータが連続して比較される回数。 - sampleFrequency
-
型:
integer
特定のメトリックでデータが比較される間隔(分単位)。 - statistic
-
型:
string
アラームに関連付けられているメトリックに適用される統計。 例:AVG
、MIN
、MAX
- threshold
-
型:
integer
特定のstatistic
が比較される値。
404 Response
Not found. これは、このサービス・インスタンスに自動スケール・ポリシーが定義されていないことを意味します。 Oracle Java Cloud Serviceで自動スケールが有効にされていないことを意味している場合もあります。
例
次の例では、cURLを使用してRESTリソースに対するGETリクエストを発行することによってOracle Java Cloud Serviceインスタンスに定義された自動スケール・ポリシーを表示する方法を示しています。
注意:
この例のコマンドでは、URL構造https://rest_server_url/resource-pathが使用されています。ここで、rest_server_urlはアイデンティティ・ドメインを問い合せるためのOracle Public CloudのRESTサーバーです。 Oracle Public Cloudに使用する適切なURL構造の詳細は、リクエストの送信を参照してください。
リソース・パスのサービス・タイプ../JaaS/..では大文字小文字が区別されます。
cURLコマンド
curl -i -X GET -u username:userPassword1! -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/JaaS/instances/ExampleInstance/autoscaling/policies
レスポンス・ヘッダーの例
次にレスポンス・ヘッダーの例を示します。
HTTP/1.1 200 OK Date: Thu, 19 May 2016 02:23:06 GMT Transfer-Encoding: chunked Content-Type: application/json
レスポンス本文の例
JSON形式で返されるレスポンスの例を次に示します。
{ "name": "JCSPolicy", "description": "JCS1 Auto Scaling Policy", "policies": [ { "operation": "scaleOut", "alarm": { "metricName": "CPUUtilization", "metricUnit": "percent", "statistic": "AVG", "comparisonOperator": "GreaterThanOrEqualToThreshold", "threshold": "80", "sampleCount": "3", "sampleFrequency": "10", "breachedOnInstance": "ALL" }, "coolDownPeriod": "30", "maxClusterSize": "4" }, { "operation": "scaleIn", "alarm": { "metricName": "CPUUtilization", "metricUnit": "percent", "statistic": "AVG", "comparisonOperator": "LessThanOrEqualToThreshold", "threshold": "40", "sampleCount": "3", "sampleFrequency": "10", "breachedOnInstance": "ANY" }, "coolDownPeriod": "30", "minClusterSize": "2" } ], "version": 1, "status": "Active", "startTime": "2016-05-19T07:33:46.252+0000" }
レスポンス本文の例(ポリシーが定義されていない)
サービス・インスタンスにポリシーが定義されていない場合にJSON形式で返されるレスポンスを次に示します。
{ "status": "Not Found", "errors": [ { "detail": "Policy not found." } ] }