Skip to main content

We've Moved!

Product Documentation has moved to docs.hitachivantara.com
Hitachi Vantara Knowledge

Administrative management resources

This module describes the administrative management resources.

Get serial number

You can retrieve the current serial number of your HCP for cloud scale system.

HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/serial_number/get
Request structure

Not applicable.

Response structure

The response body is shown below:

{
  "value": "serial_number"
}

Parameter

Type

Description

value String The serial number of your HCP for cloud scale system.
Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied due to invalid credentials.
405 Method Not Allowed The specified HTTP method is not allowed for administrative data. Resend using POST.
Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/serial_number/get

JSON response:

{
  "value": "SerialNumber48692"
}

Get system events

You can retrieve the 100 most recent system events.

HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/system/info
Request structure

Not applicable.

Response structure

The response body is shown below:

{
  "events": [
    {
      "severity": "INFO|WARNING|SEVERE",
      "subject": "event_subject",
      "message": "event_message",
      "subsystem": "event_subsystem",
      "timestamp": date_time
    },
    .
    .
    .
  ]
}

Parameter

Type

Description

severityString The severity of the event:
  • INFO
  • WARNING
  • SEVERE
subjectStringSummary of the event.
messageStringDetails about the event.
subsystemStringThe event category (for example, User, Bucket, or S3 settings).
timestamp 64-bit integerThe date and time, in milliseconds since 1 January 1970 GMT, when the event was generated.
Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied due to invalid credentials.
405 Method Not Allowed The specified HTTP method is not allowed for administrative data. Resend using POST.
Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/system/info

JSON response:

{
  "events": [
    {
      "severity": "INFO",
      "subject": "User admin@company.com authenticated",
      "message": "User admin@company.com with Id d3c01db4-ac18-4d90-a321-899bb210baf7 authenticated successfully to the Administration App.",
      "subsystem": "User",
      "timestamp": 1559547959735
    },
    {
      "severity": "INFO",
      "subject": "Unexpectedly failed authentication request by user admin@company.com",
      "message": "An authentication request unexpectedly failed for username admin@company.com.",
      "subsystem": "User",
      "timestamp": 1559547646844
    }
  ]
}

Refresh client certificates

If your system uses the HTTPS protocol and you change an SSL certificate, you need to refresh the certificates on storage components.

HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/certificates/refresh
Request structure

Not applicable.

Response structure

Not applicable.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied due to invalid credentials.
405 Method Not Allowed The specified HTTP method is not allowed for administrative data. Resend using POST.
Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/certificates/refresh

Set serial number

You can set the serial number of your HCP for cloud scale system. A valid serial number is required for the system to function.

HTTP request syntax (URI)
POST https://host_ip:9099/mapi/v1/serial_number/set
Request structure

The request body is shown below:

{
  "value": "serial_number"
}
ParameterRequiredTypeDescription
valueYesStringThe serial number of your HCP for cloud scale system.
Response structure

The response returns the same parameter as the request.

Return codes

Status code

HTTP name

Description

200 OK The request was executed successfully.
401 Unauthorized Access was denied due to invalid credentials.
405 Method Not Allowed The specified HTTP method is not allowed for administrative data. Resend using POST.
Example

Request example:

POST https://10.10.24.195:9099/mapi/v1/serial_number/set

JSON request:

{
  "value": "SerialNumber48692"
}

JSON response:

{
  "value": "SerialNumber48692"
}