Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.12.1 Obtaining Container Cluster List

The API acquires a list of container clusters.

Execution permission

Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/ContainerClusters

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "data":[{
            "name":"...",
            "status":"...",
            "pluginId":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

ContainerCluster[]

A list of ContainerCluster objects. For details about ContainerCluster, see the table below.

pagination

Pagination

Page information. This parameter is displayed only when the relevant resource exists.

count

int

Number of data items that meet the conditions.

data (Type: ContainerCluster)

Attribute

Type

Description

name

string

Name of the container cluster

status

enum

Status of container cluster

(For details about the specifiable values, see the table NodeStatusType in List of enumerators.)

The specifiable values are as follows:

  • Normal
  • Warning
  • Error
  • Unreachable
  • Unknown
  • NotMonitored

pluginId

string

ID for the plug-in applied to the container cluster.

description

string

Description

collectorID

long

ID for identifying a collector used for detection.

collectorName

string

Name of a collector used for detection.

pagination (Type: Pagination)

Attribute

Type

Description

page

integer

page

pageSize

integer

Size of the pages

numPages

integer

Number of the pages

totalCount

integer

Number of the objects

Status codes

Status code

Reason phrase

Description

200

OK

<default en>

401

Unauthorized

<default en>

412

Precondition Failed

<default en>

500

Internal Server Error

<default en>

Example code

[Request Header]
GET /Analytics/v1/objects/ContainerClusters/ HTTP/1.1
Authorization: HSSO e1ae4524b8ff0eb6560dda6af26e6a258ac92f6_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 04 Sep 2020 09:27:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO e1ae4524b8ff0eb6560dda6af26e6a258ac92f6_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 633

[Response Body]
{
  "data" : [ {
    "instanceID" : 1000001,
    "name" : "Kubernetes Cluster",
    "status" : "Normal",
    "pluginId" : "com.hitachi.software.ias.KubernetesPlugin",
    "collectorID": 50,
    "collectorName": "k8s_1" 
  } ],
  "count" : 1
}