Returns CMC performance usage data for the managed systems.
Important: The versions v1 and v2 have the same response syntax. The information explained in this document uses the latest version v2. The same information also applies to v1. To use version v1 of this API, replace v2 by v1.
Resource Information
| Response formats | JSON |
| Requires authentication? | Yes |
| Rate limited? | All API calls are automatically rate limited to a maximum of 10 calls per second. |
Request Syntax
- For all managed systems: GET /v2/cm/usage/ManagedSystem
- For a particular managed system: GET /v2/cm/usage/ManagedSystem/{ms-uuid}
URI Request Parameters
The request uses the following URI parameters:
| Parameter | Required? | Description |
| StartTS | Yes | Start time with zero offset format (yyyy-MM-ddTHH:mm:ssZ) |
| EndTS | Yes | End time with zero offset format (yyyy-MM-ddTHH:mm:ssZ) |
| Frequency | Yes |
Frequency can be Minute, 5Minute, 2Hour, or Daily. For the redundant HMC set up, the extra usage samples for the 5Minute, 2Hour, and Daily frequency might be included in the API response. This happens when the usage data is generated at different timestamps by these HMCs. |
| ms-uuid | Optional | The UUID of the managed system. |
Important: Consider the following conditions, while specifying the frequency for the StartTS and EndTS parameters:
- For Minute frequency, data of a maximum of 60 minutes can be queried.
- For 5Minute frequency, data of a maximum of 2 hours can be queried.
- For 2Hour frequency, data of a maximum of 1 day can be queried.
- For Daily frequency, data of a maximum of 30 days data can be queried.
Request headers
Authenticate the API by completing the following steps:
- Set your client ID value in the X-CMC-Client-Id header in every request.
- Set the client secret value in the X-CMC-Client-Secret header in every request.
To form the CMC API full URL, append the relative path of the endpoint you want to use to the Base URL.
For example: https://<base-url>/api/public/v2/cm/usage/ManagedSystem/{uuid}
Request body
This request does not have a request body.
Response Syntax and Description
To review the response schema and for information about the parameters, see Response schema and parameter description for /usage/ManagedSystem.
Errors
The following errors are the common errors for this API:
NotFoundException
The requested resource is not found. Make sure that the request URI is correct.
HTTP Status Code: 404
TooManyRequestsException
The request has reached its throttling limit. Retry after the specified time.
HTTP Status Code: 429
UnauthorizedException
The request is denied because the caller has insufficient permissions.
HTTP Status Code: 401
Sample Request
Review the following examples to understand how the API request and response work.
Sample request for all managed systems
GET /api/public/v2/cm/usage/ManagedSystem?Frequency=5Minute&StartTS=2023-09-07T09:00:00Z&EndTS=2023-09-07T11:00:00Z HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Sample request for a particular managed system
GET /api/public/v2/cm/usage/ManagedSystem/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx?Frequency=2Hour&StartTS=2023-09-07T09:00:00Z&EndTS=2023-09-07T11:00:00Z HTTP/1.1
Host: xxxxxxxxxxxx.powercmc.com
x-cmc-client-id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
x-cmc-client-secret: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Sample Response
The following response is a sample response for a particular managed system.
{
"ManagedSystems": [
{
"MTMS": {
"MachineType": "9009",
"Model": "22A",
"SerialNumber": "xxxxxxx"
},
"Name": "xxxxxxxx",
"State": "operating",
"UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"ManagingHMCs": [
{
"MTMS": {
"MachineType": "V357",
"Model": "f6d",
"SerialNumber": "xxxxxxx"
},
"Name": "xxxxxxxx",
"State": "Active",
"UUID": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
],
"Tags": [
{
"Name": "Test"
}
],
"Usage": {
"CoreUsage": {
"Average": 0.39,
"Min": 0.39,
"Max": 0.39
},
"MemoryUsage": {
"Average": 136192,
"Min": 136192,
"Max": 136192
},
"NetworkUsage": {
"SentBytes": {
"Average": 41239,
"Min": 41239,
"Max": 41239
},
"ReceivedBytes": {
"Average": 47135,
"Min": 47135,
"Max": 47135
},
"SentPackets": {
"Average": 66,
"Min": 66,
"Max": 66
},
"ReceivedPackets": {
"Average": 133,
"Min": 133,
"Max": 133
},
"SRIOVUsage": {
"SentBytes": {
"Average": 0,
"Min": 0,
"Max": 0
},
"ReceivedBytes": {
"Average": 0,
"Min": 0,
"Max": 0
},
"SentPackets": {
"Average": 0,
"Min": 0,
"Max": 0
},
"ReceivedPackets": {
"Average": 0,
"Min": 0,
"Max": 0
}
}
},
"StorageUsage": {
"ReadBytes": {
"Average": 13249,
"Min": 13249,
"Max": 13249
},
"WriteBytes": {
"Average": 415403,
"Min": 415403,
"Max": 415403
},
"NumOfReads": {
"Average": 6,
"Min": 6,
"Max": 6
},
"NumOfWrites": {
"Average": 18,
"Min": 18,
"Max": 18
}
},
"PowerUsage": {
"Average": 189.5,
"Min": 189.5,
"Max": 189.5
},
"Frequency": "2Hour",
"Usage": [
{
"StartTime": "2023-09-07T07:55:00Z",
"CoreUsage": 0.39,
"MemoryUsage": 136192,
"NetworkUsage": {
"SentBytes": 41239,
"ReceivedBytes": 47135,
"SentPackets": 66,
"ReceivedPackets": 133,
"SRIOVUsage": {
"SentBytes": 0,
"ReceivedBytes": 0,
"SentPackets": 0,
"ReceivedPackets": 0
}
},
"StorageUsage": {
"ReadBytes": 13249,
"WriteBytes": 415403,
"NumOfReads": 6,
"NumOfWrites": 18
},
"PowerUsage": 189.5
}
]
}
}
]
}
Comments
0 comments
Please sign in to leave a comment.