14.5.7 特定のボリュームのQoSの設定情報を取得する
ボリュームIDを指定して、ボリュームのQoSの設定に関する情報を取得します。
実行権限
ストレージ管理者(参照)
リクエストライン
GET <ベースURL>/simple/v1/objects/volumes/<オブジェクトID>/qos-setting
リクエストメッセージ
- オブジェクトID
-
ボリュームの情報取得で取得したidの値を指定します。
属性
型
説明
id
int
(必須)ボリュームID
- クエリパラメータ
- なし。
- ボディ
- なし。
レスポンスメッセージ
- ボディ
-
ボリュームIDが100のボリュームのQoSの設定情報を取得した例を次に示します。
{ "volumeId": 100, "threshold": { "isUpperIopsEnabled": true, "upperIops": 2000, "isUpperTransferRateEnabled": true, "upperTransferRate": 20000, "isLowerIopsEnabled": true, "lowerIops": 1000, "isLowerTransferRateEnabled": true, "lowerTransferRate": 10000, "isResponsePriorityEnabled": false }, "alertSetting": { "isUpperAlertEnabled": true, "upperAlertAllowableTime": 10, "isLowerAlertEnabled": true, "lowerAlertAllowableTime": 20, "isResponseAlertEnabled": false }, "alertTime": {} }
属性
型
説明
volumeId
int
ボリュームID
threshold
object
ボリュームのQoSの設定に関する情報が出力されます。
- isUpperIopsEnabled(boolean)
IOPSの上限値の設定が有効かどうか
- true:有効
- false:無効
- upperIops(int)
IOPSの上限値
属性isUpperIopsEnabledがtrueの場合に出力されます。
- isUpperTransferRateEnabled(boolean)
データ転送量の上限値の設定が有効かどうか
- true:有効
- false:無効
- upperTransferRate(int)
データ転送量の上限値(MiBps)
属性isUpperTransferRateEnabledがtrueの場合に出力されます。
- isLowerIopsEnabled(boolean)
IOPSの下限値の設定が有効かどうか
- true:有効
- false:無効
- lowerIops(int)
IOPSの下限値
属性isLowerIopsEnabledがtrueの場合に出力されます。
- isLowerTransferRateEnabled(boolean)
データ転送量の下限値の設定が有効かどうか
- true:有効
- false:無効
- lowerTransferRate(int)
データ転送量の下限値(MiBps)
属性isLowerTransferRateEnabledがtrueの場合に出力されます。
- isResponsePriorityEnabled(boolean)
I/O処理の優先度の設定が有効かどうか
- true:有効
- false:無効
- responsePriority(int)
I/O処理の優先度
値が大きいほど優先度が高く、値が小さいほど優先度が低いことを示します。
属性isResponsePriorityEnabledがtrueの場合に出力されます。
- targetResponseTime(int)
応答時間の目標値(ミリ秒)
属性isResponsePriorityEnabledがtrueの場合に出力されます。
alertSetting
object
ボリュームのアラート設定に関する情報が出力されます。
- isUpperAlertEnabled(boolean)
IOPSまたはデータ転送量が継続して上限値を上回る場合に、アラートが出力されるかどうか
- true:出力される
- false:出力されない
- upperAlertAllowableTime(int)
上限値を超過してからアラートが出力されるまでの許容時間(秒)
属性isUpperAlertEnabledがtrueの場合に出力されます。
- isLowerAlertEnabled(boolean)
IOPSまたはデータ転送量が継続して下限値を下回る場合に、アラートが出力されるかどうか
- true:出力される
- false:出力されない
- lowerAlertAllowableTime(int)
下限値未達の場合にアラートが出力されるまでの許容時間(秒)
属性isLowerAlertEnabledがtrueの場合に出力されます。
- isResponseAlertEnabled(boolean)
平均応答時間が継続して目標値未達成の場合にアラートが出力されるかどうか
- true:出力される
- false:出力されない
- responseAlertAllowableTime(int)
平均応答時間の目標値未達成の場合にアラートが出力されるまでの許容時間(秒)
属性isResponseAlertEnabledがtrueの場合に出力されます。
alertTime
object
ボリュームのアラート発生時刻※に関する情報が出力されます。
- upperAlertTime(ISO8601string)
IOPSまたはデータ転送量が継続して上限値を上回る場合のアラート最終発生時刻(UTC)
アラートが出力される設定をしていない、またはアラートが発生していない場合、この属性は出力されません。
- lowerAlertTime(ISO8601string)
IOPSまたはデータ転送量が継続して下限値を下回る場合のアラート最終発生時刻(UTC)
アラートが出力される設定をしていない、またはアラートが発生していない場合、この属性は出力されません。
- responseAlertTime(ISO8601string)
平均応答時間が継続して目標値未達成の場合のアラート最終発生時刻(UTC)
アラートが出力される設定をしていない、またはアラートが発生していない場合、この属性は出力されません。
- 注※
- ストレージシステムのタイムゾーンを変更すると、タイムゾーンを変更する前のアラート発生時刻が不正な値となります。
- isUpperIopsEnabled(boolean)
ステータスコード
この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。
コード例
curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3f9f04ea8bd8f09847fac48d3" -X GET https://192.0.2.100/ConfigurationManager/simple/v1/objects/volumes/100/qos-setting