Performing performance monitoring of a pool

REST API Reference Guide for Virtual Storage Platform 5000, Virtual Storage Platform E Series, and Virtual Storage Platform G/F Series

Version
93-07-0x
90-09-0x
88-08-10
Audience
anonymous
Part Number
MK-98RD9014-17
The following request starts or ends performance monitoring of an HDT pool. By performing performance monitoring, you can collect the I/O performance on each page of a pool as monitoring information to understand the characteristics of the I/O performance on each page allocated to an HDT volume. Perform performance monitoring before tier relocation.

Execution permission

Storage Administrator (Provisioning)

Request line

POST base-URL/v1/objects/pools/object-ID/actions/monitor/invoke

Request message

Object ID

Specify the poolId value obtained by getting information about pools.

Attribute

Type

Description

poolId

int

(Required) Pool number

Query parameters
None.
Body
{
  "parameters": {
    "operationType": "start"
  }
}

Attribute

Type

Description

operationType

string

(Required) Specify the operation of performance monitoring.
  • start: Start performance monitoring.
  • stop: End performance monitoring.

Response message

Body

A job object is returned. For details on attributes other than affectedResources, see the section explaining job objects.

Attribute

Description

affectedResources

URL of the pool for which performance monitoring was started or ended

Action template

GET base-URL/v1/objects/pools/object-ID/actions/monitor

Status codes

The following table explains the meanings of the status codes for this API. For details on other status codes, see the section explaining HTTP status codes.

Status code

Message

Description

412

Precondition Failed

The specified action cannot be run because the pool meets either of the following conditions:

  • The pool is not an HDT pool.
  • The execution mode for the pool is auto (AUT).

Coding example

To get an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X GET https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/monitor

To run the API request after getting an action template:

curl -v -H "Accept:application/json" -H "Content-Type:application/json" -H "Authorization:Session d7b673af189048468c5af9bcf3bbbb6f" -X POST --data-binary @./InputParameters.json https://192.0.2.100/ConfigurationManager/v1/objects/pools/3/actions/monitor/invoke