Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


2.13.1 Obtaining Container Node List

The API acquires a list of container nodes.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:
{
        "data":[{
            "name":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "clusterName":"...",
            "role":"...",
            "labels":"...",
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "pluginId":"...",
            "pluginName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

ContainerNode[]

A list of ContainerNode objects. For details about ContainerNode, 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: ContainerNode)

Attribute

Type

Description

name

string

Name of the container node

status

enum

Status of the container node

(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

monitorStatus

enum

Monitor status of the container node

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

The specifiable values are as follows:

  • New
  • Manage
  • ignore
  • MonitorOff

description

string

Detailed information about the container node

clusterName

string

Name of the Cluster that the container node belongs to

role

string

Role of the container node

labels

string

Labels of the container node

collectorID

long

ID for identifying a collector used for detection

collectorName

string

Name of a collector used for detection

autoCollectionType

enum

Type of a collector used for detection

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

The specifiable values are as follows:

  • AutoConnect
  • NotAutoConnect

usedCredentialID

long

ID for authentication information used for detection

usedCredentials

string

Name of authentication information used for detection

accessPointType

enum

Type of the protocol or collector for authentication information used for detection.

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

The specifiable values are as follows:

  • HTTP

accessPointIpAddress

string

IP address or host name used for connections to monitoring targets or management software

accessPointUser

string

User ID used for connections to monitoring targets or management software

pluginId

string

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

pluginName

string

Name for the plug-in applied to the container node.

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

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/ContainerNodes HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja


[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json


[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "k8s-master.local",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "clusterName" : "zzops",
    "role" : "agent,master,tomato,worker",
    "labels" : "beta.kubernetes.io/arch:amd64,beta.kubernetes.io/os:linux,kubernetes.io/hostname:k8s-master.local,node-role.kubernetes.io/agent:agent,node-role.kubernetes.io/master:master,node-role.kubernetes.io/tomato:tomato,node-role.kubernetes.io/worker:worker",
    "collectorID" : 0,
    "collectorName" : "kubernetes",
    "autoCollectionType" : "AutoConnect",
    "accessPointType" : "HTTP",
    "accessPointIpAddress" : "10.197.101.177",
    "accessPointUser" : "system",
    "pluginId" : "com.hitachi.software.ias.KubernetesPlugin",
    "pluginName" : "Kubernetes Plugin A"
  } ],
  "count" : 1
}