2.4.2　ユーザープロファイルの情報取得

指定したユーザープロファイルの情報を取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

UserThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (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	しきい値の識別子。未サポートのメンバーです。
displayName	string	しきい値の表示名。
unit	string	しきい値の単位を表す文字列。
proportion	boolean	しきい値の方向。 true:測定値がしきい値を下回る場合に異常または警告となる。 false:測定値がしきい値を上回る場合に異常または警告になる。
thresholdValueOfWarning	float	警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。・stepSizeの倍数・max以下・min以上
thresholdValueOfError	float	エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。・stepSizeの倍数・max以下・min以上
stepSize	float	しきい値の増加量。
max	double	しきい値がとりえる最大値。
min	double	しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード	Reason phrase	説明
200	OK	正常終了
401	Unauthorized	ログイン権限がない
403	Forbidden	参照権限がない
404	Not Found	リソースが存在しない
412	Precondition Failed	サーバーが起動していない
500	Internal Server Error	サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles/62 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 07:19:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO fe84f16f0bb366a0b4d1226353e169d76c5ee_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
"instanceID" : 23,
"profileName" : "Default Profile for Hyper-V",
"description" : "Default Profile for Hyper-V",
"resourceType" : "HYPERV",
"profileType" : "Default",
"thresholdValues" : [ {
"instanceID" : 539,
"monitoring" : true,
"metricType" : "WIN_CPU_LOAD",
"displayName" : "CPU Use",
"unit" : "%",
"proportion" : false,
"thresholdValueOfWarning" : 80.0,
"thresholdValueOfError" : 90.0,
"stepSize" : 1.0,
"max" : 100.0,
"min" : 0.0
}, {
.......
},
.......
],
"numOfResources" : 1
}

2.4.2 ユーザープロファイルの情報取得

2.4.2　ユーザープロファイルの情報取得