2.6.8 Obtaining Consumer Allocation Information
This API acquires information required for assigning the specified consumer to a monitored resource.
Execution permission
Admin, Modify
API version
v1
Request format
GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource
Request body
Not applicable.
Response body
The structure of the response body and the object attributes are as follows:Action
{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":["...", ...] }
Action (Type: Action)
Attribute |
Type |
Description |
---|---|---|
name |
string |
Name of the execute an operation. |
href |
string |
URL of the execute an operation. |
method |
string |
Name of the method. |
type |
string |
Data format of the object. |
parameters |
anyType[] |
A list of UpdateTargetResourceParam objects necessary to execute an operation. For details about UpdateTargetResourceParam, see the table below. |
UpdateTargetResourceParam
{ "volumeIDs":["...", ...], "vmIDs":["...", ...], "resourceIDs":["...", ...] }
UpdateTargetResourceParam (Type: UpdateTargetResourceParam)
Attribute |
Type |
Description |
---|---|---|
volumeIDs |
long[] |
Specify IDs for identifying volumes to which the consumer is to be assigned. To assign the consumer to multiple volumes, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set. "volumeIDs" : [ 81, 87 ] To release the assignment of all the volumes, set the member value to a blank. "volumeIDs" : [ ] |
vmIDs |
long[] |
Specify IDs for identifying virtual machines to which the consumeris to be assigned. To assign the consumer to multiple virtual machines, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set. " vmIDs " : [ 81, 87 ] To release the assignment of all the virtual machines, set the member value to a blank. " vmIDs " : [ ] |
resourceIDs |
long[] |
Specify IDs for identifying hosts to which the consumer is to be assigned. To assign the consumer to multiple hosts, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set. " resourceIDs " : [ 81, 87 ] To release the assignment of all the virtual machines, set the member value to a blank. " resourceIDs " : [ ] |
Status codes
Status code |
Reason phrase |
Description |
---|---|---|
200 |
OK |
Success. |
401 |
Unauthorized |
No login privilege. |
403 |
Forbidden |
No reference privilege. |
404 |
Not Found |
The resource was not fournd. |
412 |
Precondition Failed |
The server is not available. |
500 |
Internal Server Error |
Server processing error. |
Example code
[Request Header] GET /Analytics/v1/objects/Groups/10/actions/updateTargetResource 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 09:04:21 GMT Server: Cosminexus HTTP Server Cache-Control: no-cache WWW-Authenticate: HSSO ba4d83751660bee033d1ccdaf4d78e97f6c893a_WVlGcHsLfg5ffg0I_V0810 X-Frame-Options: SAMEORIGIN Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "name" : "updateTargetResource", "href" : "http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke", "method" : "POST", "type" : "application/json", "parameters" : [ { "volumeIDs" : [ ], "vmIDs" : [ 97 ], "resourceIDs" : [ ] } ] }