2.15.1 クラスタ一覧の取得
クラスタの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Clusters
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "name":"...", "status":"...", "componentType":"...", "thresholdProfileID":"...", "thresholdProfileName":"...", "originalThresholdProfileID":"...", "pluginId":"...", "description":"...", "collectorID":"...", "collectorName":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Cluster[] |
Clusterのコレクション。Clusterの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Cluster)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
クラスタの名称 |
status |
enum |
クラスタの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
componentType |
enum |
クラスタの種別 (指定可能な値は「列挙型一覧」のComponentTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
thresholdProfileID |
long |
クラスタに割り当てられたしきい値プロファイルを特定するID |
thresholdProfileName |
string |
クラスタに割り当てられたしきい値プロファイルの名称 |
originalThresholdProfileID |
string |
クラスタに割り当てられたしきい値プロファイルのオリジナルプロファイルID |
pluginId |
string |
クラスタに適用されているプラグインのID |
description |
string |
説明 |
collectorID |
long |
発見に使用されたコレクターを特定するID |
collectorName |
string |
発見に使用されたコレクターの名称 |
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/Clusters/ HTTP/1.1 Authorization: HSSO e1ae4524b8ff0eb6560dda6af26e6a258ac92f6_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810 User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko Host: localhost:22015 Accept: application/json Accept-Language: ja [Response Header] HTTP/1.1 200 OK Date: Fri, 04 Sep 2020 09:27:26 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO e1ae4524b8ff0eb6560dda6af26e6a258ac92f6_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810 X-Frame-Options: SAMEORIGIN Connection: Keep-Alive Content-Type: application/json Content-Length: 633 [Response Body] { "data" : [ { "instanceID" : 1000001, "name" : "nutanix_cluster", "status" : "Normal", "componentType" : "GENERIC_HYPERVISOR_CLUSTER", "thresholdProfileID" : 27, "thresholdProfileName" : "Default Profile for Nutanix Cluster", "originalThresholdProfileID" : "26", "pluginId" : "com.hitachi.software.ias.NutanixPlugin" } ], "count" : 1 }