2.6.9 コンシューマーの割り当て
指定したコンシューマーを監視対象に割り当てます。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
POST http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource/invoke
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。Action
{
"name":"...",
"href":"...",
"method":"...",
"type":"...",
"parameters":["...", ...]
}
Action (Type: Action)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
name |
string |
操作名です。 |
|
href |
string |
操作の実行先URLです。 |
|
method |
string |
メソッド名です。 |
|
type |
string |
データのデータ形式です。 |
|
parameters |
anyType[] |
操作実行時に必要な UpdateTargetResourceParam のコレクション。 UpdateTargetResourceParam の詳細は以下の表を参照ください。 |
UpdateTargetResourceParam
{
"volumeIDs":["...", ...],
"vmIDs":["...", ...],
"resourceIDs":["...", ...]
}
UpdateTargetResourceParam (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 " : [ ] |
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。Job
{
"instanceID":"...",
"created":"...",
"updated":"...",
"completed":"...",
"state":"...",
"affectedResource":["...", ...],
"result":["...", ...]
}
Job (Type: Job)
|
属性 |
データ型 |
説明 |
|---|---|---|
|
instanceID |
string |
インスタンスのIDを示します。 |
|
created |
string |
オブジェクトの生成日付を示します。ISO8601形式です。 |
|
updated |
string |
オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。 |
|
completed |
string |
処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。 |
|
state |
string |
以下の値が設定されます。 “failed”: 操作が正常終了しなかったことを示します。 “success”: 操作が正常終了したことを示します。 |
|
affectedResource |
string[] |
操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。 |
|
result |
anyType[] |
実行結果のコレクション。空欄です。 |
ステータスコード
|
HTTPステータスコード |
Reason phrase |
説明 |
|---|---|---|
|
200 |
OK |
正常終了 |
|
400 |
Bad Request |
リクエストボディ形式不正 |
|
401 |
Unauthorized |
ログイン権限がない |
|
403 |
Forbidden |
更新権限がない |
|
404 |
Not Found |
リソースが存在しない |
|
412 |
Precondition Failed |
サーバーが起動していない |
|
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header]
POST /Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288
[Request Body]
{
"name" : "updateTargetResource",
"href" : "http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ {
"volumeIDs" : [ 534 ],
"vmIDs" : [ 97, 31 ],
"resourceIDs" : [ ]
} ]
}
[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:11:06 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 154d18c71a465150d5e228e8f16bf42c4dd280_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json
[Response Body]
{
"instanceID" : "e89f633c-700d-4e75-9f81-d2d59c95a7bf",
"created" : "2015-11-27T18:11:06.679+09:00",
"updated" : "2015-11-27T18:11:07.023+09:00",
"completed" : "2015-11-27T18:11:07.023+09:00",
"state" : "success",
"affectedResource" : [ ],
"result" : [ ]
}