2.20.1 IPスイッチの一覧の取得
IPスイッチの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/IPSwitches
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "instanceID":"...", "name":"...", "ipAddress":"...", "status":"...", "monitorStatus":"...", "description":"...", "usedCredentialID":"...", "usedCredentials":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "accessPointType":"...", "accessPointSnmpVersion":"...", "accessPointIpAddress":"...", "accessPointUser":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
IPSwitch[] |
IPSwitchのコレクション。IPSwitchの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: IPSwitch)
属性 |
データ型 |
説明 |
---|---|---|
instanceID |
long |
IPスイッチを特定するID |
name |
string |
IPスイッチの名称 |
ipAddress |
string |
IPスイッチのIPアドレス |
status |
enum |
IPスイッチの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
IPスイッチの監視状態。 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
description |
string |
IPスイッチの詳細情報 |
usedCredentialID |
long |
発見時に使用された認証情報を特定するID。 |
usedCredentials |
string |
発見時に使用された認証情報の名称。 |
thresholdProfileID |
long |
IPスイッチに割り当たっているしきい値プロファイルを特定するID |
thresholdProfileName |
string |
IPスイッチに割り当たっているしきい値プロファイルの名称 |
originalThresholdProfileID |
string |
IPスイッチに割り当てられたしきい値プロファイルのオリジナルプロファイルID |
accessPointType |
enum |
発見時に使用された認証情報の種別。 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointSnmpVersion |
enum |
発見時に使用されたSNMPのバージョン。 (指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。) 以下に示す値のみ指定可能です。
|
accessPointIpAddress |
string |
監視対象への接続に使用したIPアドレス |
accessPointUser |
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/IPSwitches 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 21:15: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" : 3, "name" : "dell2", "ipAddress" : "10.197.87.242", "status" : "Unknown", "monitorStatus" : "Manage", "description" : "YYYY Ethernet Switch", "usedCredentialID" : 7, "usedCredentials" : "10.197.87.242", "thresholdProfileID" : 10, "thresholdProfileName" : "Default Profile for IP Switch", "accessPointType" : "SNMP", "accessPointSnmpVersion" : "V1_V2C", "accessPointIpAddress" : "10.197.87.242", } ], "count" : 1 }