2.6.2　収集間隔の情報取得

収集間隔の情報を取得します。

権限

Admin

APIのバージョン

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/MonitoringIntervalSettings

リクエストボディー

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

レスポンスボディー

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

{
        "data":[{
            "instanceID":"...",
            "configurationEnabled":"...",
            "configurationLastDuration":"...",
            "configurationMaxDuration":"...",
            "configurationInterval":"...",
            "configurationStartHour":"...",
            "configurationStartMinutes":"...",
            "performanceEnabled":"...",
            "performanceLastDuration":"...",
            "performanceMaxDuration":"...",
            "performanceInterval":"...",
            "hypervisorVMEnabled":"...",
            "hypervisorVMLastDuration":"...",
            "hypervisorVMMaxDuration":"...",
            "hypervisorVMInterval":"...",
            "hypervisorVMScheduleCycleType":"...",
            "hypervisorVMStartHour":"...",
            "hypervisorVMStartMinutes":"...",
            "applicationEventEnabled":"...",
            "applicationEventLastDuration":"...",
            "applicationEventMaxDuration":"...",
            "applicationEventInterval":"...",
            "stateOfHypervisorVMEnabled":"...",
            "stateOfHypervisorVMLastDuration":"...",
            "stateOfHypervisorVMMaxDuration":"...",
            "stateOfHypervisorVMInterval":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性	データ型	説明
data	MonitoringInterval[]	MonitoringIntervalのコレクション。MonitoringIntervalの詳細は以下の表を参照ください。
pagination	Pagination	ページ情報。リソースが存在しない場合、このパラメータは表示されません。
count	int	条件に合致したデータの個数

data (Type: MonitoringInterval)

属性	データ型	説明
instanceID	long	インスタンスを特定するID
configurationEnabled	boolean	構成の収集が有効であるかどうか。・true：有効である・false：無効である
configurationLastDuration	int	構成の収集の最新の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
configurationMaxDuration	int	構成の収集の最長の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
configurationInterval	int	構成の収集の収集間隔（日）
configurationStartHour	int	構成の収集の開始時刻（時）
configurationStartMinutes	int	構成の収集の開始時刻（分）
performanceEnabled	boolean	性能の収集が有効であるかどうか。・true：有効である・false：無効である
performanceLastDuration	int	性能の収集の最新の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
performanceMaxDuration	int	性能の収集の最長の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
performanceInterval	int	性能の収集の収集間隔（分）
hypervisorVMEnabled	boolean	構成の収集（仮想マシン／ハイパーバイザー）を有効にするかどうか。・true：有効にする・false：無効にする省略時は既に設定されている値を変更しません。
hypervisorVMLastDuration	int	構成の収集（仮想マシン／ハイパーバイザー）の最新の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
hypervisorVMMaxDuration	int	構成の収集（仮想マシン／ハイパーバイザー）の最長の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
hypervisorVMInterval	int	構成の収集（仮想マシン／ハイパーバイザー）の収集間隔（分/時/日）指定できる値は1～9999です。実行周期タイプは"hypervisorVMScheduleCycleType"メンバーで指定します。省略時は既に設定されている値を変更しません。
hypervisorVMScheduleCycleType	enum	構成の収集（仮想マシン／ハイパーバイザー）の収集実行周期タイプ。 (指定可能な値は「列挙型一覧」のScheduleCycleTypeの表を参照してください。) 以下に示す値のみ指定可能です。 Minutely Hourly Daily
hypervisorVMStartHour	int	構成の収集（仮想マシン／ハイパーバイザー）の開始時刻（時）指定できる値は0～23です。省略時は既に設定されている値を変更しません。"hypervisorVMScheduleCycleType"メンバーの値が"Daily"の場合にのみ指定できます。
hypervisorVMStartMinutes	int	構成の収集（仮想マシン／ハイパーバイザー）の開始時刻（分）指定できる値は0～59です。省略時は既に設定されている値を変更しません。"hypervisorVMScheduleCycleType"メンバーの値が"Daily"の場合にのみ指定できます。
applicationEventEnabled	boolean	イベントの収集（アプリケーション）が有効であるかどうか。・true：有効である・false：無効である
applicationEventLastDuration	int	イベントの収集（アプリケーション）の最新の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
applicationEventMaxDuration	int	イベントの収集（アプリケーション）の最長の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
applicationEventInterval	int	イベントの収集（アプリケーション）の収集間隔（分）
stateOfHypervisorVMEnabled	boolean	状態の収集（仮想マシン／ハイパーバイザー）を有効にするかどうか。・true：有効にする・false：無効にする省略時は既に設定されている値を変更しません。
stateOfHypervisorVMLastDuration	int	状態の収集（仮想マシン／ハイパーバイザー）の最新の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
stateOfHypervisorVMMaxDuration	int	状態の収集（仮想マシン／ハイパーバイザー）の最長の所要時間（分）収集が一度も行われていない場合は-1が返却されます。
stateOfHypervisorVMInterval	int	状態の収集（仮想マシン／ハイパーバイザー）の収集間隔（分）指定できる値は1～9999です。省略時は既に設定されている値を変更しません。

pagination (Type: Pagination)

属性	データ型	説明
page	integer	ページ
pageSize	integer	ページサイズ
numPages	integer	ページの数
totalCount	integer	オブジェクトの数

ステータスコード

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

使用例

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

[Response Body]
{
"data": [{
"instanceID": 1,
"configurationEnabled": true,
"configurationLastDuration": -1,
"configurationMaxDuration": -1,
"configurationInterval": 1,
"configurationStartHour": 0,
"configurationStartMinutes": 45,
"performanceEnabled": true,
"performanceLastDuration": 1,
"performanceMaxDuration": 1,
"performanceInterval": 5,
"hypervisorVMEnabled": true,
"hypervisorVMLastDuration": 1,
"hypervisorVMMaxDuration": 1,
"hypervisorVMInterval": 5,
"hypervisorVMScheduleCycleType": "Minutely",
"hypervisorVMStartHour": 0,
"hypervisorVMStartMinutes": 0,
"applicationEventEnabled": true,
"applicationEventLastDuration": -1,
"applicationEventMaxDuration": -1,
"applicationEventInterval": 5,
"stateOfHypervisorVMEnabled": true,
"stateOfHypervisorVMLastDuration": 1,
"stateOfHypervisorVMMaxDuration": 1,
"stateOfHypervisorVMInterval": 1
}],
"count": 1
}

2.6.2 収集間隔の情報取得

2.6.2　収集間隔の情報取得