2.8.1 ユーザープロファイルの一覧の取得
ユーザープロファイルの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{
"data":[{
"instanceID":"...",
"profileName":"...",
"description":"...",
"resourceType":"...",
"profileType":"...",
"thresholdValues":[{
"instanceID":"...",
"monitoring":"...",
"metricType":"...",
"pluginMetricType":"...",
"displayName":"...",
"unit":"...",
"proportion":"...",
"thresholdValueOfWarning":"...",
"thresholdValueOfError":"...",
"stepSize":"...",
"max":"...",
"min":"..."
},
:
],
"numOfResources":"...",
"autoAssignFilters":["...", ...]
},
:
],
"pagination":{
"page":"...",
"pageSize":"...",
"numPages":"...",
"totalCount":"..."
},
"count":"..."
}
Collections (Type: Collections)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
data |
UserThresholdProfile[] |
UserThresholdProfileのコレクション。UserThresholdProfileの詳細は以下の表を参照ください。 |
|
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
|
count |
int |
条件に合致したデータの個数 |
data (Type: UserThresholdProfile)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
instanceID |
long |
インスタンスを特定するID。 |
|
profileName |
string |
ユーザープロファイルの名称。128文字以下の文字列を指定します。 |
|
description |
string |
ユーザープロファイルの説明。256文字以下の文字列を指定します。 |
|
resourceType |
string |
ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。 ・VM:仮想マシン ・VOLUME:ボリューム ・WINDOWS:Windows ・LINUX_UNIX:Linux/UNIX |
|
profileType |
string |
ユーザープロファイルの変更種別 ・User:ユーザーが作成したプロファイル ・Default:デフォルトで登録されているプロファイル ・Preset:初期値が設定されたプロファイル |
|
thresholdValues |
UserThresholdValue[] |
ユーザープロファイルに設定されているしきい値の内容。 |
|
numOfResources |
int |
ユーザープロファイルが割り当たっているリソースの数 |
|
autoAssignFilters |
string[] |
自動割り当てルールのルール名。 |
thresholdValues (Type: UserThresholdValue)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
instanceID |
long |
インスタンスを特定するID |
|
monitoring |
boolean |
監視しているしきい値かどうか。 ・true:監視している。 ・false:監視していない。 省略時はfalseが設定されます。 |
|
metricType |
string |
しきい値の識別子。未サポートのメンバーです。 |
|
pluginMetricType |
string |
しきい値に設定されているメトリックの種別(プラグイン) |
|
displayName |
string |
しきい値の表示名。 |
|
unit |
string |
しきい値の単位を表す文字列。 |
|
proportion |
boolean |
しきい値の方向。 true:測定値がしきい値を下回る場合に異常または警告となる。 false:測定値がしきい値を上回る場合に異常または警告になる。 |
|
thresholdValueOfWarning |
float |
警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。 ・stepSizeの倍数 ・max以下 ・min以上 設定可能な数値以外が入力された場合，入力値が自動的に調整されます。 |
|
thresholdValueOfError |
float |
エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。 ・stepSizeの倍数 ・max以下 ・min以上 設定可能な数値以外が入力された場合，入力値が自動的に調整されます。 |
|
stepSize |
float |
しきい値の増加量。 |
|
max |
double |
しきい値がとりえる最大値。 |
|
min |
double |
しきい値がとりえる最小値。 |
pagination (Type: Pagination)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
page |
integer |
ページ |
|
pageSize |
integer |
ページサイズ |
|
numPages |
integer |
ページの数 |
|
totalCount |
integer |
オブジェクトの数 |
ステータスコード
|
HTTPステータスコード |
Reason phrase |
説明 |
|---|---|---|
|
200 |
OK |
正常終了 |
|
400 |
Bad Request |
クエリパラメータ不正 |
|
401 |
Unauthorized |
ログイン権限がない |
|
403 |
Forbidden |
参照権限がない |
|
412 |
Precondition Failed |
サーバーが起動していない |
|
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja
[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:42:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ef807fefafe4f3d3f3058e252907ae61ed6a63a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"instanceID" : 62,
"profileName" : "Default Profile for Volume",
"description" : "Default Profile for Volume",
"resourceType" : "VOLUME",
"profileType" : "User",
"thresholdValues" : [ {
" instanceID" : 763,
"monitoring" : false,
"metricType" : "STO_VOLUME_TOTAL_IO_RATE",
"displayName" : "Volume IOPS ",
"unit" : "transfers/sec",
"proportion" : false,
"thresholdValueOfWarning" : 0.0,
"thresholdValueOfError" : 2222.0,
"stepSize" : 1.0,
"max" : 3.4028235E38,
"min" : 0.0
}, {
"instanceID" : 761,
"monitoring" : false,
"metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
"displayName" : "Volume IO Rate",
"unit" : "MBps",
"proportion" : false,
"thresholdValueOfWarning" : 421.0,
"thresholdValueOfError" : 450.0,
"stepSize" : 1.0,
"max" : 3.4028235E38,
"min" : 0.0
}, {
"instanceID" : 762,
"monitoring" : true,
"metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
"displayName" : "Volume Response Time Per IO Request",
"unit" : "msec/transfer",
"proportion" : false,
"thresholdValueOfWarning" : 499.9,
"thresholdValueOfError" : 500.1,
"stepSize" : 0.1,
"max" : 3.4028235E38,
"min" : 0.0
} ],
"numOfResources" : 0,
"autoAssignFilters" : [ ],
"originalThresholdProfileID" : 62
}