Getting information about a specific CLPR

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
Obtain information about a specific CLPR by specifying the CLPR ID. You can obtain information such as the cache capacity, cache usage rate, and resident cache capacity.

Execution permission

Storage Administrator (View Only)

Request line

GET base-URL/v1/objects/clprs/object-ID

Request message

Object ID

Specify the value of clprId that was obtained by the processing to get information about CLPRs.

Attribute

Type

Description

clprId

int

(Required) CLPR ID

Query parameters

None.

Body

None.

Response message

Body
{
  "clprId": 2,
  "clprName": "CLPRGRP",
  "cacheMemoryCapacity": 12288,
  "cacheMemoryUsedCapacity": 0,
  "writePendingDataCapacity": 0,
  "sideFilesCapacity": 0,
  "cacheUsageRate": 0,
  "writePendingDataRate": 0,
  "sideFilesUsageRate": 0
}

Attribute

Type

Description

clprId

int

CLPR ID

clprName

string

CLPR name

cacheMemoryCapacity

long

Cache size (MB)

cacheMemoryUsedCapacity

long

Used cache size (MB)

writePendingDataCapacity

long

Amount of data waiting to be written (MB)

sideFilesCapacity

long

Size of side files (MB)

cacheUsageRate

int

Cache usage rate (%)

writePendingDataRate

int

Rate of data waiting to be written (%)

sideFilesUsageRate

int

Side file usage rate (%)

Status codes

For details on the status codes of the request for this operation, see the description of HTTP status codes.

Coding example

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/clprs/2