2.19.1 データストアの一覧の取得
データストアの一覧を取得します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/objects/Datastores
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{ "data":[{ "name":"...", "status":"...", "monitorStatus":"...", "description":"...", "datastoreUrl":"...", "identificationNumber":"...", "clusterName":"...", "collectorID":"...", "collectorName":"...", "autoCollectionType":"...", "usedCredentialID":"...", "usedCredentials":"...", "accessPointType":"...", "accessPointSnmpVersion":"...", "accessPointIpAddress":"...", "accessPointUser":"..." }, : ], "pagination":{ "page":"...", "pageSize":"...", "numPages":"...", "totalCount":"..." }, "count":"..." }
Collections (Type: Collections)
属性 |
データ型 |
説明 |
---|---|---|
data |
Datastore[] |
Datastoreのコレクション。Datastoreの詳細は以下の表を参照ください。 |
pagination |
Pagination |
ページ情報。リソースが存在しない場合、このパラメータは表示されません。 |
count |
int |
条件に合致したデータの個数 |
data (Type: Datastore)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
データストアの名称 |
status |
enum |
データストアの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
monitorStatus |
enum |
データストアの監視状態 (指定可能な値は「列挙型一覧」のComponentMonitorTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
description |
string |
データストアの説明 |
datastoreUrl |
string |
監視対象または管理ソフトウェアにて定義されているデータストアのURL |
identificationNumber |
string |
監視対象または管理ソフトウェアにて定義されているデータストアの識別番号 |
clusterName |
string |
データストアが属するクラスタの名称 |
collectorID |
long |
発見に使用されたコレクターを特定するID。 |
collectorName |
string |
発見に使用されたコレクターの名称 |
autoCollectionType |
enum |
発見に使用されたコレクターの種別 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
usedCredentialID |
long |
発見時に使用された認証情報の名称 |
usedCredentials |
string |
発見時に使用された認証情報の名称 |
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/DatastoresHTTP/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:53: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" : 1667, "name" : "SelfServiceContainer", "status" : "Normal", "monitorStatus" : "InUse", "identificationNumber" : "3cbe1312-ea74-4c94-8963-547fbe412946", "clusterName" : "nutanix_cluster", "usedCredentialID" : 5, "usedCredentials" : "Nutanix", "accessPointType" : "SNMP", "accessPointSnmpVersion" : "V3", "accessPointIpAddress" : "10.197.101.182", "accessPointUser" : "admin" },{ "instanceID" : 300, "name" : "datastore39", "status" : "Normal", "monitorStatus" : "InUse", "description" : "", "datastoreUrl" : "ds:///vmfs/volumes/58bf7061-e63b5c93-c2a2-1c6f65310ce4/", "collectorID" : 0, "collectorName" : "vCenter", "autoCollectionType" : "AutoConnect", "accessPointType" : "VCENTER", "accessPointIpAddress" : "10.197.64.164", "accessPointUser" : "administrator@vsphere.local" }], "count": 2 }