2.22.1　ボリュームの一覧の取得

ボリュームの一覧を取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

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

リクエストボディー

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

レスポンスボディー

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

{
        "data":[{
            "instanceID":"...",
            "status":"...",
            "ldev":"...",
            "storageSubsystemID":"...",
            "storageSubsystem":"...",
            "storageSubsystemMonitorStatus":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "pluginId":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

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

data (Type: Volume)

属性	データ型	説明
instanceID	long	ボリュームをを特定するID
status	enum	ボリュームの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。 Normal Warning Error Unreachable Unknown
ldev	string	ボリュームが属するLDEVの名称
storageSubsystemID	long	ボリュームが属するストレージシステムを特定するID
storageSubsystem	string	ボリュームが属するストレージシステムの名称
storageSubsystemMonitorStatus	enum	ボリュームが属するストレージシステムの監視状態 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。 New Manage ignore MonitorOff
thresholdProfileID	long	ボリュームに割りあたっているしきい値プロファイルを特定するID
thresholdProfileName	string	ボリュームに割りあたっているしきい値プロファイルの名称
originalThresholdProfileID	string	ボリュームに割り当てられたしきい値プロファイルのオリジナルプロファイルID
groupIDs	long[]	ボリュームが割り当たっているコンシューマーを特定するID
groupNames	string[]	ボリュームが割り当たっているコンシューマーの名称
gradeNames	string[]	ボリュームが割り当たっているコンシューマーのグレード
gradeOrders	integer[]	ボリュームが割り当たっているコンシューマーのグレードの優先度
pluginId	string	ボリュームに適用されているプラグインのID

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/Volumes 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:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO df3a7ac35f3b99a9b2afafd22d433167067da9_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 540,
    "status" : "Unknown",
    "ldev" : "vol0 (LU NUM=699d3b60-18f9-11de-a169-00a09810f3f4)",
    "storageSubsystemID" : 6,
    "storageSubsystem" : "FAS2050A-2",
    "storageSubsystemMonitorStatus" : "Manage",
    "thresholdProfileID" : 21,
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 534,
    "status" : "Unknown",
    "ldev" : "vol1 (LU NUM=7cb5b900-1c0e-11de-9f89-00a09810f3f4)",
    "storageSubsystemID" : 6,
    "storageSubsystem" : "FAS2050A-2",
    "storageSubsystemMonitorStatus" : "Manage",
    "thresholdProfileID" : 21,
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  } ],
  "count" : 2
}

2.22.1 ボリュームの一覧の取得

2.22.1　ボリュームの一覧の取得