Hitachi

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


2.10.8 コンシューマーの割り当てに必要な情報の取得

指定したコンシューマーを監視対象リソースの割り当てに必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource

リクエストボディー

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

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。
{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "volumeIDs":["...", ...],
            "vmIDs":["...", ...],
            "resourceIDs":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

UpdateTargetResourceParam[]

操作実行時に必要なUpdateTargetResourceParamのコレクション。UpdateTargetResourceParamの詳細は以下の表を参照ください。

parameters (Type: UpdateTargetResourceParam)

属性

データ型

説明

volumeIDs

long[]

コンシューマーを割り当てるボリュームを特定するIDを指定します。複数のボリュームに割り当てを行う場合は,IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め,設定する必要があります。

"volumeIDs" : [ 81, 87 ]

すべてのボリュームの割り当てを解除する場合は,メンバーの値を空欄にします。

"volumeIDs" : [ ]

vmIDs

long[]

コンシューマーを割り当てる仮想マシンを特定するIDを指定します。複数の仮想マシンに割り当てを行う場合は,IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め,設定する必要があります。

" vmIDs " : [ 81, 87 ]

すべての仮想マシンの割り当てを解除する場合は,メンバーの値を空欄にします。

" vmIDs " : [ ]

resourceIDs

long[]

コンシューマーを割り当てるホストを特定するIDを指定します。複数のホストに割り当てを行う場合は,IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め,設定する必要があります。

" resourceIDs " : [ 81, 87 ]

すべてのホストの割り当てを解除する場合は,メンバーの値を空欄にします。

" resourceIDs " : [ ]

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

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

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Groups/160/actions/updateTargetResource HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:30 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 45d6d29dcde4fdf4ae1d16d8e5587d146bd9aa7f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://JP1OAServer:22015/Analytics/v1/objects/Groups/160/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumeIDs" : [ 13642, 13671, 13905, 14001, 14064, 14085, 14093, 14116 ],
    "vmIDs" : [ 16177, 14381, 15941, 15942, 15943, 15946, 15947, 15951, 15960, ... , 16997 ],
    "resourceIDs" : [ ]
  } ]
}