Hitachi

JP1 Version 11 JP1/Operations Analytics REST APIリファレンス


2.12.1 FCスイッチの一覧の取得

FCスイッチの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

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

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

FCSwitch のコレクション。 FCSwitch の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

FCSwitch

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "wwn":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

FCSwitch (Type: FCSwitch)

属性

データ型

説明

instanceID

long

FCスイッチを特定するID

name

string

FCスイッチの名称

ipAddress

string

FCスイッチのIPアドレス

status

enum

FCスイッチの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • Normal
  • Warning
  • Error
  • Unreachable
  • Unknown
  • NotMonitored

monitorStatus

enum

FCスイッチの監視状態。

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • New
  • Manage
  • ignore
  • MonitorOff

description

string

FCスイッチの詳細情報

usedCredentialID

long

発見時に使用された認証情報を特定するID。

usedCredentials

string

発見時に使用された認証情報の名称。

wwn

string

FCスイッチのWWNの値

thresholdProfileID

long

FCスイッチに割り当たっているしきい値プロファイルを特定するID

thresholdProfileName

string

FCスイッチに割り当たっているしきい値プロファイルの名称

accessPointType

enum

発見時に使用された認証情報の種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • WBEM
  • SNMP

accessPointIpAddress

string

監視対象への接続に使用したIPアドレス

accessPointUser

string

監視対象への接続に使用したユーザーID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/FCSwitches 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 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 5,
    "name" : "SANbox",
    "ipAddress" : "10.197.87.222",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "FC Switch",
    "usedCredentialID" : 6,
    "usedCredentials" : "10.197.87.222",
    "wwn" : "10:00:00:C0:DD:0D:62:E4",
    "thresholdProfileID" : 8,
    "thresholdProfileName" : "Default Profile for FC Switch",
    "accessPointType" : "WBEM",
    "accessPointIpAddress" : "10.197.87.222",
    "accessPointUser" : "admin"
  } ],
  "count" : 1
}