Hitachi IOportal Rest-API Documentation

This is the documentation of the Hitachi IOportal Rest-API.

Authorization

Get authorization token by sending username and password

Endpoint

POST /api/auth/login

Parameters

Name Description
email required The email of the user
password required Password

Request

Route

POST /api/auth/login

Headers

Content-Type: application/x-www-form-urlencoded

Body

email=user17%40domain.com&password=Password123

cURL

curl "https://www.hitachi-ioportal.com/api/auth/login" -d 'email=user17%40domain.com&password=Password123' -X POST \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: request_method=POST; path=/
_session_id=9c51cbf69d623e2246e1755596ea1dbc; path=/; HttpOnly
X-Request-Id: 88717e87-7aea-4302-9309-226ef4c29f40
X-Runtime: 0.009810
Content-Length: 145

Body

{
  "status": "success",
  "auth_token": "eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzgxLCJleHAiOjE1MzcwMDQ3MDV9.lppt1n6q8QNuwJG0tyziAKORfBihof5GuAZE35D4OXg"
}

When sending wrong credentials

Endpoint

POST /api/auth/login

Parameters

Name Description
email required The email of the user
password required Password

Request

Route

POST /api/auth/login

Headers

Content-Type: application/x-www-form-urlencoded

Body

email=rachell%40borer.net&password=KlO8KrK8

cURL

curl "https://www.hitachi-ioportal.com/api/auth/login" -d 'email=rachell%40borer.net&password=KlO8KrK8' -X POST \
	-H "Content-Type: application/x-www-form-urlencoded"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: request_method=POST; path=/
_session_id=15c17efc49269fa675583494d0f01ea7; path=/; HttpOnly
X-Request-Id: 23a8999b-aad3-4e23-a5ed-1d73a8917b70
X-Runtime: 0.006640
Content-Length: 57

Body

{
  "status": "unauthorized",
  "message": "Invalid credentials"
}

Customers

Get Details of a Customer

Endpoint

GET /api/customers/:id

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/3312

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzM5LCJleHAiOjE1MzcwMDQ2OTl9.emPuDcolpdYFA1VtKKIOlCj-ILibJgZik0_mGs98ojw

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/3312" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzM5LCJleHAiOjE1MzcwMDQ2OTl9.emPuDcolpdYFA1VtKKIOlCj-ILibJgZik0_mGs98ojw"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=4cfbc70c24dca2b171e743fb822f3b05; path=/; HttpOnly
X-Request-Id: 53d7ff5c-7185-4841-bebf-02bda8907f9f
X-Runtime: 0.018946
Content-Length: 255

Body

{
  "status": "success",
  "message": "Loaded customer 'customer_3'",
  "data": {
    "id": "3312",
    "type": "customer",
    "attributes": {
      "cust_short": "c3",
      "name": "customer_3",
      "capacity_subscription": null,
      "cust_status": "active",
      "confidentiality": false,
      "proactive_service": false
    }
  }
}

Get all StorageArrays of a Customer

Endpoint

GET /api/customers/:id/storage_arrays

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/3315/storage_arrays

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzQxLCJleHAiOjE1MzcwMDQ2OTl9.-ZisEwyS79Cr6JRKP6Y07I7YjT-Aa6vxB6G23wt2Tbc

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/3315/storage_arrays" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzQxLCJleHAiOjE1MzcwMDQ2OTl9.-ZisEwyS79Cr6JRKP6Y07I7YjT-Aa6vxB6G23wt2Tbc"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=73ec696bcc61709e53123e4b64420005; path=/; HttpOnly
X-Request-Id: b6b9cb50-f331-4055-b6e5-b15f3a706e81
X-Runtime: 0.016675
Content-Length: 437

Body

{
  "status": "success",
  "message": "Loaded storage_arrays for customer 'customer_6'",
  "data": [
    {
      "id": "4794",
      "type": "storage_array",
      "attributes": {
        "box": "sa_10013",
        "nickname": null,
        "serial_number": 10013,
        "machine_type": "R700",
        "os_platform": "OPEN",
        "customer_id": 3315
      }
    },
    {
      "id": "4795",
      "type": "storage_array",
      "attributes": {
        "box": "sa_10014",
        "nickname": null,
        "serial_number": 10014,
        "machine_type": "R700",
        "os_platform": "OPEN",
        "customer_id": 3315
      }
    }
  ],
  "count": 2
}

Listing Customers

Endpoint

GET /api/customers

Request

Route

GET /api/customers

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzQwLCJleHAiOjE1MzcwMDQ2OTl9.7oqO46A-vBZNdLeMi3-O5wcIe5_LMXYaC5SWffR-tM8

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzQwLCJleHAiOjE1MzcwMDQ2OTl9.7oqO46A-vBZNdLeMi3-O5wcIe5_LMXYaC5SWffR-tM8"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=20983d934618eece980da9402ae0008a; path=/; HttpOnly
X-Request-Id: 1d31595a-aa28-40a4-b5d3-fd7652b483d2
X-Runtime: 0.017425
Content-Length: 153

Body

{
  "status": "success",
  "message": "Loaded customers",
  "data": [
    {
      "id": "3314",
      "type": "customer",
      "attributes": {
        "cust_short": "c5",
        "name": "customer_5"
      }
    }
  ],
  "count": 1
}

Try to get details for a non authorized Customer

Endpoint

GET /api/customers/:id

Parameters

Name Description
id required ID of the Customer

Request

Route

GET /api/customers/3310

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzM4LCJleHAiOjE1MzcwMDQ2OTl9.LBujuxSMzLr_T3bphYbGYEksnZUeoCEJ8jZTmpf49xA

cURL

curl -g "https://www.hitachi-ioportal.com/api/customers/3310" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzM4LCJleHAiOjE1MzcwMDQ2OTl9.LBujuxSMzLr_T3bphYbGYEksnZUeoCEJ8jZTmpf49xA"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=f9bbb28c4b14dadbc4169f161e4b5c40; path=/; HttpOnly
X-Request-Id: 08141793-a19f-4b92-bf80-38c0c2643713
X-Runtime: 0.020777
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}

Kpis

Get Details of a KPI

Endpoint

GET /api/kpis/:id

Parameters

Name Description
id required ID of the Kpi

Request

Route

GET /api/kpis/55

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY2LCJleHAiOjE1MzcwMDQ3MDN9.NZVplWr5HyRxiU9mc7vNMou0anPsdevGZLkgxuJ-7l0

cURL

curl -g "https://www.hitachi-ioportal.com/api/kpis/55" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY2LCJleHAiOjE1MzcwMDQ3MDN9.NZVplWr5HyRxiU9mc7vNMou0anPsdevGZLkgxuJ-7l0"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=5224bc9a291776cfcaf5650d145fc30e; path=/; HttpOnly
X-Request-Id: 0b8c8ed8-7a89-4439-9cab-3cb2565b5966
X-Runtime: 0.039018
Content-Length: 7470

Body

{
  "status": "success",
  "message": "Loaded KPI",
  "data": {
    "id": "55",
    "type": "dashboard_report",
    "attributes": {
      "start_time": "2018-09-13T02:00:00.000+02:00",
      "end_time": "2018-09-14T01:59:59.000+02:00",
      "kpi_capacity": "111.0",
      "kpi_impact": "222.0",
      "kpi_threshold": "333.0",
      "storage_array": {
        "data": {
          "id": "4823",
          "type": "storage_array",
          "attributes": {
            "box": "sa_10042",
            "nickname": null,
            "serial_number": 10042,
            "machine_type": "R700",
            "os_platform": "OPEN",
            "customer_id": 3343
          }
        }
      },
      "dashboard_box_loads": {
        "data": [
          {
            "id": "45",
            "type": "dashboard_box_load",
            "attributes": {
              "iops_sec": "111111.1",
              "mio_iops_day": "22222222.2",
              "tput_mb_sec": "3333.3",
              "tput_tb_day": "444444.4",
              "wtim_sec_sec": "555.5",
              "wtim_h_day": "6666.6",
              "svct_ms": "7.7",
              "blsz_kb": "88.8",
              "count_data": "999.9",
              "exp_data": "111.1"
            }
          }
        ]
      },
      "dashboard_datapoints": {
        "data": [
          {
            "id": "249",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "PhyCMPK",
              "count_data": 267
            }
          },
          {
            "id": "250",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "PhyPG",
              "count_data": 267
            }
          },
          {
            "id": "251",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "PhyProc",
              "count_data": 267
            }
          },
          {
            "id": "252",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "Port",
              "count_data": 267
            }
          },
          {
            "id": "253",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "RemoteCopy",
              "count_data": 267
            }
          },
          {
            "id": "254",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "UniversalReplicator",
              "count_data": 267
            }
          },
          {
            "id": "255",
            "type": "dashboard_datapoint",
            "attributes": {
              "resource": "LU",
              "count_data": 267
            }
          }
        ]
      },
      "dashboard_frontends": {
        "data": [
          {
            "id": "306",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Server",
              "name": "Server-10",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "305",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Port",
              "name": "CL9-B",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "304",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Server",
              "name": "Server-8",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "303",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Server",
              "name": "Server-7",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "302",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Port",
              "name": "CL6-F",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "301",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Server",
              "name": "Server-5",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "300",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Port",
              "name": "CL4-E",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "299",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Server",
              "name": "Server-3",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "298",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Server",
              "name": "Server-2",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          },
          {
            "id": "297",
            "type": "dashboard_frontend",
            "attributes": {
              "object": "Port",
              "name": "CL1-D",
              "max_svct_ms": "1.1",
              "occurred": "2018-09-13T11:44:57.832+02:00",
              "iops_sec": "2222.2",
              "tput_mb_sec": "33.3",
              "wtim_sec": "4.4",
              "svct_ms": "5.5",
              "blsz": "66.6"
            }
          }
        ]
      },
      "dashboard_backends": {
        "data": [
          {
            "id": "161",
            "type": "dashboard_backend",
            "attributes": {
              "object": "PG",
              "name": "PG-1",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "162",
            "type": "dashboard_backend",
            "attributes": {
              "object": "Cwpr",
              "name": "Cwpr-2",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "163",
            "type": "dashboard_backend",
            "attributes": {
              "object": "Xbar",
              "name": "Xbar-3",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "164",
            "type": "dashboard_backend",
            "attributes": {
              "object": "PG",
              "name": "PG-4",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "165",
            "type": "dashboard_backend",
            "attributes": {
              "object": "PG",
              "name": "PG-5",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "166",
            "type": "dashboard_backend",
            "attributes": {
              "object": "Xbar",
              "name": "Xbar-6",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "167",
            "type": "dashboard_backend",
            "attributes": {
              "object": "Cwpr",
              "name": "Cwpr-7",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "168",
            "type": "dashboard_backend",
            "attributes": {
              "object": "MP",
              "name": "MP-8",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "169",
            "type": "dashboard_backend",
            "attributes": {
              "object": "Cwpr",
              "name": "Cwpr-9",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          },
          {
            "id": "170",
            "type": "dashboard_backend",
            "attributes": {
              "object": "Xbar",
              "name": "Xbar-10",
              "max_value": "11.0",
              "occurred": "2018-09-13T23:44:57.833+02:00",
              "avg_value": "22.0",
              "pct": "3.0"
            }
          }
        ]
      },
      "dashboard_thresholds": {
        "data": [
          {
            "id": "161",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyPG",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "162",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyProc",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "163",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyCMPK",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "164",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyPG",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "165",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyPG",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "166",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyCMPK",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "167",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyCMPK",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "168",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyProc",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "169",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyProc",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          },
          {
            "id": "170",
            "type": "dashboard_threshold",
            "attributes": {
              "resource": "PhyCMPK",
              "metric": null,
              "warning": "40.0",
              "critical": "60.0",
              "count_warning": "3.0",
              "count_critical": "1.0"
            }
          }
        ]
      }
    }
  }
}

Try to get details for a non authorized KPI

Endpoint

GET /api/kpis/:id

Parameters

Name Description
id required ID of the Kpi

Request

Route

GET /api/kpis/56

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY3LCJleHAiOjE1MzcwMDQ3MDR9.m1GmEmZ7_9mfR7g4eYxlHBGWkA8sA9akijJEw6lYvfo

cURL

curl -g "https://www.hitachi-ioportal.com/api/kpis/56" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY3LCJleHAiOjE1MzcwMDQ3MDR9.m1GmEmZ7_9mfR7g4eYxlHBGWkA8sA9akijJEw6lYvfo"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=c3624f2caa1ca27429c61dbffcfe412e; path=/; HttpOnly
X-Request-Id: 24daa2a7-453d-47fe-bcec-d8e9ee40ed8a
X-Runtime: 0.014417
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}

Pools

Get Details of a Pool

Endpoint

GET /api/pools/:id

Parameters

Name Description
id required ID of the Pool

Request

Route

GET /api/pools/3363

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzcwLCJleHAiOjE1MzcwMDQ3MDR9.ReezmFUbCkli66XS_G0nPGvpVhOyz6kXqEefp2ocrsc

cURL

curl -g "https://www.hitachi-ioportal.com/api/pools/3363" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzcwLCJleHAiOjE1MzcwMDQ3MDR9.ReezmFUbCkli66XS_G0nPGvpVhOyz6kXqEefp2ocrsc"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=879f7e6e04f1a2968a2cea1a5feae5f5; path=/; HttpOnly
X-Request-Id: 2e2bf8f4-6122-4c95-8c4b-f85497263de4
X-Runtime: 0.016882
Content-Length: 995

Body

{
  "status": "success",
  "message": "Loaded customer 'pool_29 (sa_10056 / 29)'",
  "data": {
    "id": "3363",
    "type": "pool",
    "attributes": {
      "name": "pool_29",
      "pool_status": "POLN",
      "pool_type": "OPEN",
      "storage_array_id": 4837,
      "pm": "N",
      "usage_rate": 0,
      "volume_count": 3,
      "ldev_nr": 100,
      "capacity_in_kb": 41220071424,
      "available_capacity_in_kb": 41220071424,
      "threshold": 95,
      "vcap": 100,
      "snap": null,
      "se_saving_in_blk": 0,
      "pl_saving_in_blk": 0,
      "pl_pre_used_in_blk": 0,
      "ses_in_perc": 0,
      "ddp_in_perc": 0,
      "cmp_in_perc": 0,
      "pls_in_perc": 0,
      "num_dedup_vols": 0,
      "num_dedup_sys_vols": null,
      "u_in_perc": "0.0",
      "act_av_in_mb": 40253976,
      "act_tp_in_mb": 40253976,
      "fr_in_perc": "0.0",
      "fmc_log_used_in_blk": 0,
      "fmc_act_used_in_blk": 0,
      "warning": 90,
      "lcnt": 3,
      "rcnt": 0,
      "av_cap_in_mb": 40253976,
      "tp_cap_in_mb": 40253976,
      "tl_cap_in_mb": 256620,
      "tr_cap_in_mb": 0,
      "bm": "FB",
      "storage_array": {
        "data": {
          "id": "4837",
          "type": "storage_array",
          "attributes": {
            "box": "sa_10056",
            "nickname": null,
            "serial_number": 10056,
            "machine_type": "R700",
            "os_platform": "OPEN",
            "customer_id": 3350
          }
        }
      }
    }
  }
}

Listing Pools

Endpoint

GET /api/pools

Request

Route

GET /api/pools

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY4LCJleHAiOjE1MzcwMDQ3MDR9.ant_hs6kQaaxJGt4n_I0FMbOiR2AKvgtBUnoZKvMV2A

cURL

curl -g "https://www.hitachi-ioportal.com/api/pools" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY4LCJleHAiOjE1MzcwMDQ3MDR9.ant_hs6kQaaxJGt4n_I0FMbOiR2AKvgtBUnoZKvMV2A"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=e96d168a1747119633add31639ed53a3; path=/; HttpOnly
X-Request-Id: 8ef77315-fb55-4b15-b7a3-a16577178dbb
X-Runtime: 0.017219
Content-Length: 564

Body

{
  "status": "success",
  "message": "Loaded customers",
  "data": [
    {
      "id": "3351",
      "type": "pool",
      "attributes": {
        "name": "pool_17",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 4831
      }
    },
    {
      "id": "3353",
      "type": "pool",
      "attributes": {
        "name": "pool_19",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 4832
      }
    },
    {
      "id": "3354",
      "type": "pool",
      "attributes": {
        "name": "pool_20",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 4832
      }
    },
    {
      "id": "3352",
      "type": "pool",
      "attributes": {
        "name": "pool_18",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 4831
      }
    }
  ],
  "count": 4
}

Try to get details for a non authorized Pool

Endpoint

GET /api/pools/:id

Parameters

Name Description
id required ID of the Pool

Request

Route

GET /api/pools/3355

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY5LCJleHAiOjE1MzcwMDQ3MDR9.zbyTr__73qaoFGDeIU09HF-7yclCif19qko4KF_a4X4

cURL

curl -g "https://www.hitachi-ioportal.com/api/pools/3355" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzY5LCJleHAiOjE1MzcwMDQ3MDR9.zbyTr__73qaoFGDeIU09HF-7yclCif19qko4KF_a4X4"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=d51df79b62113c8abd19cbfff5ff6810; path=/; HttpOnly
X-Request-Id: 37a3e929-e690-4c9b-966d-29eca8db6485
X-Runtime: 0.017728
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}

StorageArrays

Get Details of a StorageArray

Endpoint

GET /api/storage_arrays/:id

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/4846

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc1LCJleHAiOjE1MzcwMDQ3MDV9.LeUecKVqtMgsMnGNxGrIlM72mY3YQyJyxpcC67HkH9U

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/4846" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc1LCJleHAiOjE1MzcwMDQ3MDV9.LeUecKVqtMgsMnGNxGrIlM72mY3YQyJyxpcC67HkH9U"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=c2adbe2ca9894cd09dce6230fe589c9a; path=/; HttpOnly
X-Request-Id: 560bfa92-a4d8-4554-bd38-3da94f0c9841
X-Runtime: 0.016635
Content-Length: 355

Body

{
  "status": "success",
  "message": "Loaded storage_array 'sa_10065 (10065)'",
  "data": {
    "id": "4846",
    "type": "storage_array",
    "attributes": {
      "box": "sa_10065",
      "nickname": null,
      "serial_number": 10065,
      "machine_type": "R700",
      "os_platform": "OPEN",
      "customer_id": 3356,
      "customer": {
        "data": {
          "id": "3356",
          "type": "customer",
          "attributes": {
            "cust_short": "c17",
            "name": "customer_17"
          }
        }
      }
    }
  }
}

Get all KPIs of a StorageArray

Endpoint

GET /api/storage_arrays/:id/kpis

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/4854/kpis

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc4LCJleHAiOjE1MzcwMDQ3MDV9.tLGUY2Wyq4zMJoOY6ypZUFKKrhk3rj39J0k9ZkGpluk

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/4854/kpis" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc4LCJleHAiOjE1MzcwMDQ3MDV9.tLGUY2Wyq4zMJoOY6ypZUFKKrhk3rj39J0k9ZkGpluk"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=311421248797d7924caf868ec2bf16ec; path=/; HttpOnly
X-Request-Id: 4813aa1e-e16f-4637-86ab-54acc77ec082
X-Runtime: 0.015679
Content-Length: 241

Body

{
  "status": "success",
  "message": "Loaded KPIs for storage_array 'sa_10073 (10073)'",
  "data": [
    {
      "id": "57",
      "type": "dashboard_report",
      "attributes": {
        "start_time": "2018-09-13T02:00:00.000+02:00",
        "end_time": "2018-09-14T01:59:59.000+02:00"
      }
    }
  ],
  "count": 1
}

Get all Pools of a StorageArray

Endpoint

GET /api/storage_arrays/:id/pools

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/4852/pools

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc3LCJleHAiOjE1MzcwMDQ3MDV9.RzGVp1YA9QL16J4VmB5ZfRxYl1AhUVk6WqpB2c-5XH4

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/4852/pools" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc3LCJleHAiOjE1MzcwMDQ3MDV9.RzGVp1YA9QL16J4VmB5ZfRxYl1AhUVk6WqpB2c-5XH4"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=6780aaa3693370d68c3ae4449ed4c49c; path=/; HttpOnly
X-Request-Id: 9cf9192a-5f01-458b-bb6e-96598fd3022a
X-Runtime: 0.019692
Content-Length: 1929

Body

{
  "status": "success",
  "message": "Loaded Pools for storage_array 'sa_10071 (10071)'",
  "data": [
    {
      "id": "3387",
      "type": "pool",
      "attributes": {
        "name": "pool_53",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 4852,
        "pm": "N",
        "usage_rate": 0,
        "volume_count": 3,
        "ldev_nr": 100,
        "capacity_in_kb": 41220071424,
        "available_capacity_in_kb": 41220071424,
        "threshold": 95,
        "vcap": 100,
        "snap": null,
        "se_saving_in_blk": 0,
        "pl_saving_in_blk": 0,
        "pl_pre_used_in_blk": 0,
        "ses_in_perc": 0,
        "ddp_in_perc": 0,
        "cmp_in_perc": 0,
        "pls_in_perc": 0,
        "num_dedup_vols": 0,
        "num_dedup_sys_vols": null,
        "u_in_perc": "0.0",
        "act_av_in_mb": 40253976,
        "act_tp_in_mb": 40253976,
        "fr_in_perc": "0.0",
        "fmc_log_used_in_blk": 0,
        "fmc_act_used_in_blk": 0,
        "warning": 90,
        "lcnt": 3,
        "rcnt": 0,
        "av_cap_in_mb": 40253976,
        "tp_cap_in_mb": 40253976,
        "tl_cap_in_mb": 256620,
        "tr_cap_in_mb": 0,
        "bm": "FB",
        "storage_array": {
          "data": {
            "id": "4852",
            "type": "storage_array",
            "attributes": {
              "box": "sa_10071",
              "nickname": null,
              "serial_number": 10071,
              "machine_type": "R700",
              "os_platform": "OPEN",
              "customer_id": 3359
            }
          }
        }
      }
    },
    {
      "id": "3388",
      "type": "pool",
      "attributes": {
        "name": "pool_54",
        "pool_status": "POLN",
        "pool_type": "OPEN",
        "storage_array_id": 4852,
        "pm": "N",
        "usage_rate": 0,
        "volume_count": 3,
        "ldev_nr": 100,
        "capacity_in_kb": 41220071424,
        "available_capacity_in_kb": 41220071424,
        "threshold": 95,
        "vcap": 100,
        "snap": null,
        "se_saving_in_blk": 0,
        "pl_saving_in_blk": 0,
        "pl_pre_used_in_blk": 0,
        "ses_in_perc": 0,
        "ddp_in_perc": 0,
        "cmp_in_perc": 0,
        "pls_in_perc": 0,
        "num_dedup_vols": 0,
        "num_dedup_sys_vols": null,
        "u_in_perc": "0.0",
        "act_av_in_mb": 40253976,
        "act_tp_in_mb": 40253976,
        "fr_in_perc": "0.0",
        "fmc_log_used_in_blk": 0,
        "fmc_act_used_in_blk": 0,
        "warning": 90,
        "lcnt": 3,
        "rcnt": 0,
        "av_cap_in_mb": 40253976,
        "tp_cap_in_mb": 40253976,
        "tl_cap_in_mb": 256620,
        "tr_cap_in_mb": 0,
        "bm": "FB",
        "storage_array": {
          "data": {
            "id": "4852",
            "type": "storage_array",
            "attributes": {
              "box": "sa_10071",
              "nickname": null,
              "serial_number": 10071,
              "machine_type": "R700",
              "os_platform": "OPEN",
              "customer_id": 3359
            }
          }
        }
      }
    }
  ],
  "count": 2
}

Listing StorageArrays

Endpoint

GET /api/storage_arrays

Request

Route

GET /api/storage_arrays

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc0LCJleHAiOjE1MzcwMDQ3MDR9.zoTv7gZH2Cfc3ckFo8ZkY-Tbz-Fi7OO_cHvXgpR-658

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc0LCJleHAiOjE1MzcwMDQ3MDR9.zoTv7gZH2Cfc3ckFo8ZkY-Tbz-Fi7OO_cHvXgpR-658"

Response

Simulated Response

Status

200

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=a13dd4df54241d6da51a6ecc93a1e182; path=/; HttpOnly
X-Request-Id: 438be124-bfdd-4276-b3cf-fa209c0397c3
X-Runtime: 0.018546
Content-Length: 411

Body

{
  "status": "success",
  "message": "Loaded storage_arrays",
  "data": [
    {
      "id": "4844",
      "type": "storage_array",
      "attributes": {
        "box": "sa_10063",
        "nickname": null,
        "serial_number": 10063,
        "machine_type": "R700",
        "os_platform": "OPEN",
        "customer_id": 3355
      }
    },
    {
      "id": "4845",
      "type": "storage_array",
      "attributes": {
        "box": "sa_10064",
        "nickname": null,
        "serial_number": 10064,
        "machine_type": "R700",
        "os_platform": "OPEN",
        "customer_id": 3355
      }
    }
  ],
  "count": 2
}

Try to get details for a non authorized StorageArray

Endpoint

GET /api/storage_arrays/:id

Parameters

Name Description
id required ID of the StorageArray

Request

Route

GET /api/storage_arrays/4848

Headers

Accept: application/vnd.sam4h.v1+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc2LCJleHAiOjE1MzcwMDQ3MDV9.ewIU0udr-u1M4Osf5VP-mRI9qW2eZI9UvNORRUXM2M0

cURL

curl -g "https://www.hitachi-ioportal.com/api/storage_arrays/4848" -X GET \
	-H "Accept: application/vnd.sam4h.v1+json" \
	-H "Authorization: eyJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoyNzc2LCJleHAiOjE1MzcwMDQ3MDV9.ewIU0udr-u1M4Osf5VP-mRI9qW2eZI9UvNORRUXM2M0"

Response

Simulated Response

Status

401

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: Fri, 01 Jan 1990 00:00:00 GMT
Content-Type: application/json; charset=utf-8
Set-Cookie: _session_id=67736a3fccb3b3689255abbf9acc80a1; path=/; HttpOnly
X-Request-Id: 53899c9a-1579-4b0b-b663-6d5c8f3e4d89
X-Runtime: 0.014517
Content-Length: 81

Body

{
  "status": "unauthorized",
  "message": "You are not authorized to access this page."
}