Hitachi

Hitachi Command Suite Configuration Manager REST API リファレンスガイド

付録J.1　QoSグループの操作

リクエストラインにsimpleを含むREST APIで実行できるQoSグループの操作について説明します。
重要

リクエストラインにsimpleを含むREST APIを実行するための共通仕様（リソースの指定方法、APIを実行する前に必要な情報、APIを実行したあとに参照する情報）については、REST API リファレンスガイドのリクエストラインにsimpleを含むREST APIの説明を参照してください。

〈この項の構成〉

(1)　QoSグループの一覧を取得する

QoSグループの情報を一覧で取得します。
メモ

このAPIは、ストレージシステムがVSP 5000 シリーズの場合に使用できます。

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/storages/＜ストレージデバイスID＞/qos-groups

リクエストメッセージ

オブジェクトID

なし。

クエリパラメータ

なし。

ボディ

なし。

レスポンスメッセージ

ボディ 
{
    "data": [
        {
            "id": 10,
            "threshold": {
                "isUpperIopsEnabled": false,
                "isUpperTransferRateEnabled": false
            },
            "alertSetting": {
                "isUpperAlertEnabled": false
            },
            "alertTime": {}
        },
        {
            "id": 200,
            "threshold": {
                "isUpperIopsEnabled": true,
                "upperIops": 2000,
                "isUpperTransferRateEnabled": true,
                "upperTransferRate": 20000
            },
            "alertSetting": {
                "isUpperAlertEnabled": true,
                "upperAlertAllowableTime": 10
            },
            "alertTime": {
                "upperAlertTime": "2020-10-21T07:10:17Z"
            }
        }
    ],
    "count": 2
}

属性

型

説明

id

int

QoSグループのID

threshold

object

QoSグループの QoS の設定に関する情報

  • isUpperIopsEnabled（boolean）

    IOPSの上限値の設定が有効かどうか

    • true：有効
    • false：無効
  • upperIops（int）

    IOPSの上限値

    isUpperIopsEnabled属性がfalseの場合は出力されません。

  • isUpperTransferRateEnabled（boolean）

    データ転送量の上限値の設定が有効かどうか

    • true：有効
    • false：無効
  • upperTransferRate（int）

    データ転送量の上限値（MBps）

    isUpperTransferRateEnabled属性がfalseの場合は出力されません。

alertSetting

object

QoSグループのアラート設定に関する情報

  • isUpperAlertEnabled（boolean）

    IOPSまたはデータ転送量の上限値を上回る場合にアラートが出力されるかどうか

    • true：出力される
    • false：出力されない
  • upperAlertAllowableTime（int）

    上限値を超過してからアラートが出力されるまでの許容時間（秒）

    isUpperAlertEnabled属性がfalseの場合は出力されません。

alertTime

object

QoSグループのアラート発生時刻※に関する情報

  • upperAlertTime（ISO8601string ）

    IOPS またはデータ転送量が継続して上限値を上回る場合のアラート最終発生時刻（UTC）

注※　ストレージシステムのタイムゾーンを変更すると、タイムゾーンを変更する前のアラート発生時刻が不正な値となります。

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/simple/v1/objects/storages/900000012345/qos-groups

ページの先頭へ

(2)　特定のQoSグループの情報を取得する

指定したQoSグループの情報を取得します。
メモ

このAPIは、ストレージシステムがVSP 5000 シリーズの場合に使用できます。

実行権限

ストレージ管理者（参照）

リクエストライン

GET ＜ベースURL＞/simple/v1/objects/storages/＜ストレージデバイスID＞/qos-groups/＜オブジェクトID＞

リクエストメッセージ

オブジェクトID

QoSグループの情報取得で取得したidの値を指定します。

属性

型

説明

id

int

（必須）QoSグループのID
クエリパラメータ

パラメータ

型

説明

withVolumeIds

boolean

（任意）QoSグループに所属しているLDEV番号を取得するかどうかを指定します。

  • true：LDEV番号を取得する
  • false：LDEV番号を取得しない

省略した場合、falseが指定されたとみなされます。

ボディ

なし。

レスポンスメッセージ

ボディ 
{
    "id": 200,
    "threshold": {
        "isUpperIopsEnabled": true,
        "upperIops": 2000,
        "isUpperTransferRateEnabled": true,
        "upperTransferRate": 20000
    },
    "alertSetting": {
        "isUpperAlertEnabled":  true,
        "upperAlertAllowableTime": 10
    },
    "alertTime": {
        "upperAlertTime": "2020-10-21T07:10:17Z"
    },
    "volumeIds": [
        10000,
        10001
    ]
}

属性

型

説明

id

int

QoSグループのID

threshold

object

QoSグループのQoS の設定に関する情報

  • isUpperIopsEnabled（boolean）

    IOPS の上限値の設定が有効かどうか

    • true：有効
    • false：無効
  • upperIops（int）

    IOPSの上限値

    isUpperIopsEnabled属性がfalseの場合は出力されません。

  • isUpperTransferRateEnabled（boolean）

    データ転送量の上限値の設定が有効かどうか

    • true：有効
    • false：無効
  • upperTransferRate（int）

    データ転送量の上限値（MBps）

    isUpperTransferRateEnabled属性がfalseの場合は出力されません。

alertSetting

object

QoSグループのアラート設定に関する情報

  • isUpperAlertEnabled（boolean）

    IOPS またはデータ転送量が継続して上限値を上回る場合にアラートが出力されるかどうか

    • true：出力される
    • false：出力されない
  • upperAlertAllowableTime（int）

    上限値を超過してからアラートが出力されるまでの許容時間（秒）

    isUpperAlertEnabled属性がfalseの場合は出力されません。

alertTime

object

QoSグループのアラート発生時刻※に関する情報

  • upperAlertTime（ISO8601string）

    IOPS またはデータ転送量が継続して上限値を上回る場合のアラート最終発生時刻（UTC）

volumeIds

int[]

QoSグループに所属しているLDEV番号

クエリパラメータでwithVolumeIdsにtrueを指定した場合に出力されます。

注※　ストレージシステムのタイムゾーンを変更すると、タイムゾーンを変更する前のアラート発生時刻が不正な値となります。

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTP ステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/simple/v1/objects/storages/900000012345/qos-groups/200?withVolumeIds=true

ページの先頭へ

(3)　特定のQoSグループの性能情報を取得する

QoSグループIDを指定して、特定のQoSグループの性能情報を取得します。
メモ

このAPIは、ストレージシステムがVSP 5000 シリーズの場合に使用できます。

実行権限

ストレージ管理者（参照）

リクエストライン

GET  ＜ベースURL＞/simple/v1/objects/storages/＜ストレージデバイスID＞/performances/qos-groups/＜オブジェクトID＞

リクエストメッセージ

オブジェクトID

QoSグループの情報取得で取得したidの値を指定します。

属性

型

説明

id

int

（必須）QoSグループのID
クエリパラメータ

なし。

ボディ

なし。

レスポンスメッセージ

ボディ 
{
  "id": 10,
  "receivedCommands": 0,
  "transferRateOfReceivedCommands": 0,
  "iops": 0,
  "transferRate": 0,
  "responseTime": 0,
  "monitorTime": "2020-10-08T05:54:07Z"
}

属性

型

説明

id

int

QoSグループのID

receivedCommands

int

ホストから受領したコマンド数（IOPS）

transferRateOfReceivedCommands

int

ホストから受領したコマンドによるデータ転送量（KBps）

iops

int

ストレージシステムが処理したコマンド数（IOPS）

transferRate

int

ストレージシステムが処理したデータ転送量（KBps）

responseTime

long

平均応答時間（マイクロ秒）

monitorTime

ISO8601string

性能情報を取得した時刻（UTC）

ステータスコード

この操作のリクエストに対するステータスコードについては、HTTPステータスコードの説明を参照してください。

コード例

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session b74777a3-f9f0-4ea8-bd8f-09847fac48d3" -X GET https://192.0.2.100:23451/ConfigurationManager/simple/v1/objects/storages/900000012345/performances/qos-groups/10

ページの先頭へ

All Rights Reserved. Copyright© 2016, 2021, Hitachi, Ltd.