JP1 Version 12 JP1/Operations Analytics REST API Reference Guide

3021-3-D63-30(E)

Notices

Relevant program products

P-2A2C-DCCL JP1/Operations Analytics 12-60 (for Windows Server 2012, Windows Server 2012 R2, Windows Server 2016 and Windows Server 2019)

Trademarks

HITACHI, HiRDB, and JP1 are either trademarks or registered trademarks of Hitachi, Ltd. in Japan and other countries.

AIX is a trademark of International Business Machines Corporation, registered in many jurisdictions worldwide.

Amazon Web Services, the “Powered by AWS” logo, and Amazon EC2 are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.

Amazon Web Services, the “Powered by AWS” logo, and AWS are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.

DB2 is a trademark of International Business Machines Corporation, registered in many jurisdictions worldwide.

Hyper-V is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.

Microsoft is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

Red Hat is a registered trademark of Red Hat, Inc. in the United States and other countries.

Red Hat Enterprise Linux is a registered trademark of Red Hat, Inc. in the United States and other countries.

RSA and BSAFE are either registered trademarks or trademarks of EMC Corporation in the United States and/or other countries.

SAP and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP SE in Germany and other countries.

SQL Server is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

WebSphere is a trademark of International Business Machines Corporation, registered in many jurisdictions worldwide.

Windows is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

Windows Server is either a registered trademark or trademark of Microsoft Corporation in the United States and/or other countries.

JP1/Operations Analytics includes RSA BSAFE(R) Cryptographic software of EMC Corporation.

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

1. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit. (http://www.openssl.org/)

2. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com)

3. This product includes software written by Tim Hudson (tjh@cryptsoft.com)

4. This product includes the OpenSSL Toolkit software used under OpenSSL License and Original SSLeay License. OpenSSL License and Original SSLeay License are as follow:

LICENSE ISSUES

==============

The OpenSSL toolkit stays under a dual license, i.e. both the conditions of

the OpenSSL License and the original SSLeay license apply to the toolkit.

See below for the actual license texts. Actually both licenses are BSD-style

Open Source licenses. In case of any license issues related to OpenSSL

please contact openssl-core@openssl.org.

OpenSSL License

---------------

/* ====================================================================

* Copyright (c) 1998-2016 The OpenSSL Project. All rights reserved.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

*

* 1. Redistributions of source code must retain the above copyright

* notice, this list of conditions and the following disclaimer.

*

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in

* the documentation and/or other materials provided with the

* distribution.

*

* 3. All advertising materials mentioning features or use of this

* software must display the following acknowledgment:

* "This product includes software developed by the OpenSSL Project

* for use in the OpenSSL Toolkit. (http://www.openssl.org/)"

*

* 4. The names "OpenSSL Toolkit" and "OpenSSL Project" must not be used to

* endorse or promote products derived from this software without

* prior written permission. For written permission, please contact

* openssl-core@openssl.org.

*

* 5. Products derived from this software may not be called "OpenSSL"

* nor may "OpenSSL" appear in their names without prior written

* permission of the OpenSSL Project.

*

* 6. Redistributions of any form whatsoever must retain the following

* acknowledgment:

* "This product includes software developed by the OpenSSL Project

* for use in the OpenSSL Toolkit (http://www.openssl.org/)"

*

* THIS SOFTWARE IS PROVIDED BY THE OpenSSL PROJECT ``AS IS'' AND ANY

* EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR

* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OpenSSL PROJECT OR

* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT

* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,

* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)

* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED

* OF THE POSSIBILITY OF SUCH DAMAGE.

* ====================================================================

*

* This product includes cryptographic software written by Eric Young

* (eay@cryptsoft.com). This product includes software written by Tim

* Hudson (tjh@cryptsoft.com).

*

*/

Original SSLeay License

-----------------------

/* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)

* All rights reserved.

*

* This package is an SSL implementation written

* by Eric Young (eay@cryptsoft.com).

* The implementation was written so as to conform with Netscapes SSL.

*

* This library is free for commercial and non-commercial use as long as

* the following conditions are aheared to. The following conditions

* apply to all code found in this distribution, be it the RC4, RSA,

* lhash, DES, etc., code; not just the SSL code. The SSL documentation

* included with this distribution is covered by the same copyright terms

* except that the holder is Tim Hudson (tjh@cryptsoft.com).

*

* Copyright remains Eric Young's, and as such any Copyright notices in

* the code are not to be removed.

* If this package is used in a product, Eric Young should be given attribution

* as the author of the parts of the library used.

* This can be in the form of a textual message at program startup or

* in documentation (online or textual) provided with the package.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

* 1. Redistributions of source code must retain the copyright

* notice, this list of conditions and the following disclaimer.

* 2. Redistributions in binary form must reproduce the above copyright

* notice, this list of conditions and the following disclaimer in the

* documentation and/or other materials provided with the distribution.

* 3. All advertising materials mentioning features or use of this software

* must display the following acknowledgement:

* "This product includes cryptographic software written by

* Eric Young (eay@cryptsoft.com)"

* The word 'cryptographic' can be left out if the rouines from the library

* being used are not cryptographic related :-).

* 4. If you include any Windows specific code (or a derivative thereof) from

* the apps directory (application code) you must include an acknowledgement:

* "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"

*

* THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND

* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE

* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE

* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE

* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL

* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS

* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)

* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT

* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY

* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF

* SUCH DAMAGE.

*

* The licence and distribution terms for any publically available version or

* derivative of this code cannot be changed. i.e. this code cannot simply be

* copied and put under another distribution licence

* [including the GNU Public Licence.]

*/

Oracle and Java are registered trademarks of Oracle and/or its affiliates.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by IAIK of Graz University of Technology.

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by the Java Apache Project for use in the Apache JServ servlet engine project (http://java.apache.org/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

Other company and product names mentioned in this document may be the trademarks of their respective owners.

Issued

Jan. 2022: 3021-3-D63-30(E)

Copyright

All Rights Reserved. Copyright (C) 2019, 2022, Hitachi, Ltd.

Summary of amendments

The following table lists changes in this manual (3021-3-D63-30(E)) and product changes related to this manual.

Changes

Location

Descriptions of the collectorType of collectors (Collectors resource) were changed.

1.3.7, 2.5.1, 2.5.2, 2.5.3, 2.5.4

The following members were added to the authentication information used by collectors (CollectorCredential resource):

useProxy

proxyHostAddr

proxyPort

proxyUser

updateProxyPassword

proxyPassword

In accordance with this addition, API requests related to the collector were changed.

1.3.8, 2.5.3, 2.5.4

Descriptions of the following members of the authentication information used by collectors (CollectorCredential resource) were changed.

optionalInformation1

optionalInformation2

optionalInformation3

1.3.8, 2.5.3, 2.5.4

Descriptions of the following members of the user profile threshold (UserThresholdValue resource) and system profile threshold (SystemThresholdValue resource) were changed.

thresholdValueOfWarning

thresholdValueOfError

1.3.13, 1.3.15, 1.8.4, 1.8.5, 2.8.1, 2.8.2, 2.8.3, 2.8.4, 2.9.1, 2.9.2, 2.9.3, 2.9.4

Datastore resource was added. In accordance with this addition, the following API requests were added.

Obtaining Datastore List

Obtaining Datastore Operation List

Obtaining Datastore Monitoring Status Change Information

Changing Datastore Monitoring Status

1.3.28, 1.4, 1.5, 1.6, 2.19

In addition to the above changes, minor editorial corrections were made.

Preface

This manual describes the API functions of JP1/Operations Analytics.

Intended readers

This manual is intended for:

System administrators who are responsible for introducing and operating JP1/Operations Analytics.

Organization of this manual

PART 1: Overview

This part gives an overview of API.

PART 2: List of API functions

This part is an API reference for the APIs provided by JP1/OA.

APPENDIX A: Version Changes

This part describes the changes in each version.

Microsoft product name abbreviations

This manual uses the following abbreviations for Microsoft product names.

Abbreviation

Full name or meaning

Hyper-V

Microsoft(R) Windows Server(R) 2012 Hyper-V(R)

Microsoft(R) Windows Server(R) 2012 R2 Hyper-V(R)

Microsoft(R) Windows Server(R) 2016 Hyper-V(R)

Microsoft(R) Windows Server(R) 2019 Hyper-V(R)

Windows Server 2012

Microsoft(R) Windows Server(R) 2012 Datacenter

Microsoft(R) Windows Server(R) 2012 Standard

Windows Server 2012 R2

Microsoft(R) Windows Server(R) 2012 R2 Datacenter

Microsoft(R) Windows Server(R) 2012 R2 Standard

Windows Server 2016

Microsoft(R) Windows Server(R) 2016 Datacenter

Microsoft(R) Windows Server(R) 2016 Standard

Windows Server 2019

Microsoft(R) Windows Server(R) 2019 Datacenter

Microsoft(R) Windows Server(R) 2019 Standard

Windows Server 2019, Windows Server 2016, Windows Server 2012 R2, and Windows Server 2012 are sometimes collectively abbreviated as "Windows".

Conventions: Abbreviations for product names

This manual uses the following abbreviations for product names.

Abbreviation

Full name or meaning

ESX

VMware vSphere(R) ESXi(TM)

JP1/AJS3

JP1/Automatic Job Management System 3

JP1/IM

JP1/Integrated Management

JP1/Integrated Management 2

JP1/OA

JP1/Operations Analytics

JP1/PFM

JP1/Performance Management

Linux

A generic term used to refer to the following OSs monitored by JP1/OA: CentOS, Oracle Linux(R), Red Hat Enterprise Linux(R), and SUSE Linux(R)

UNIX

UNIX(R)

vCenter Server or vCenter

VMware vCenter Server(R)

VMware

VMware(R)

Conventions: Acronyms

This manual uses the following acronyms.

Acronym

Full name or meaning

FC

Fibre Channel

SMI-S

Storage Management Initiative - Specification

SMTP

Simple Mail Transfer Protocol

SNMP

Simple Network Management Protocol

SSH

Secure Shell

SSL

Secure Sockets Layer

VM

Virtual Machine

WBEM

Web-Based Enterprise Management

WMI

Windows Management Instrumentation

Conventions: KB, MB, GB, and TB

This manual uses the following conventions: 1 KB (kilobyte) is 1,024 bytes, 1 MB (megabyte) is 1,024² bytes, 1 GB (gigabyte) is 1,024³ bytes, and 1 TB (terabyte) is 1,024⁴ bytes.

1 Overview

This chapter describes the overview of the APIs provided by JP1/OA.

1.1 API architecture

The API functions enable you to use HTTP or HTTPS to collect various types of information such as information about devices monitored by JP1/OA.

The API functions of JP1/OA conform to the REST (Representational State Transfer) architecture style.

Compliance with the REST architecture style has the following benefits:

Does not depend on the platform or language.

Adheres to the standard HTTP interface. (The GET, PUT, POST, and DELETE methods are available.)

Enables the use of security tools for HTTP.

Returns standard HTTP status codes, making error processing easy.

Uses a URI (Uniform Resource Identifier) for each resource, making it easy to access resources. The relationships between resources are easy to understand.

1.2 Common specifications of the API functions

The following specifications are common to the API functions provided by JP1/OA.

1.2.1 Communication protocols and port numbers

The following lists the communication protocols and port numbers that are used by APIs:

Communication protocol

The HTTP and HTTPS are supported by APIs. An API uses a protocol that is used by JP1/OA for communicating with a Web browser. The supported version of HTTP or HTTPS is version 1.1. For details on communication protocols, see the following standards:

For the HTTP:

RFC 2616

For the HTTPS:

RFC 2818

Port number

The default setting of the port number depends on the communication protocol.

For the HTTP:

22015

For the HTTPS:

22016

If you want to change the port number, see the section describing how to change the port number between JP1/OA server and the web browser, in the JP1/Operations Analytics Configuration and Administration Guide.

1.2.2 Security and authentication

User authentication is required in order to send an API request and receive the response. JP1/OA API functions use Basic authentication (Basic Access Authentication) or authentication by using the HSSO token.

The HSSO token is necessary for Single Sign-On. The HSSO token times out after 1,000 seconds.

In the request header, specify the authentication information to be used for user authentication.

Basic authentication requires you to specify the authentication header indicating "Basic" (authentication method) followed by a string consisting of the user name and password separated by a colon (ASCII: 0x3A), encoded with Base64 (referred to as "basic token").

Example for basic authentication:

Authorization: Basic△c3lzdGVtOm1hbmFnZXI=

Legend: △: Single-byte space

The HSSO token authentication requires you to specify the authorization header indicating "HSSO" (authentication method) followed by an HSSO token.

Example for authentication using the HSSO token:

Authorization:HSSO△32bd25936120d68dceabcb49493079f8ef82a4_V0300

Legend: △: Single-byte space

For unauthorized requests, JP1/OA servers return status code "401".

Note

If you use Basic authentication or authentication using the HSSO token to connect to the JP1/OA server, WWW-Authenticate: HSSO hsso token is returned in the response header. If you want to reconnect with the JP1/OA server by using the same session to run an API function, specify the request header as follows:

Authorization:HSSO△hsso_token

Legend: △: Single-byte space

JP1/OA servers return the status code "401" for unauthorized requests, and request user authentication.

1.2.3 Request and response formats

The JSON format is available as the data format for API requests and responses. Specify a data format in the request header. Use UTF-8 character encoding for the input and output format.

Example:

Accept:application/json
Content-Type:application/json

1.2.4 Request format of the API

A request format contains a URI, method, request line, and request header. The request formats to use JP1/OA's features through APIs are as follows:

(1) URI format

Use URIs to specify resources for API functions. A URI contains a basic URI (from <schema> to <version>) and a relative URI (<domain> and followings). Resources are identified with the relative URI (starting from <domain>).

See the following example format and URI components list:

Format of a URI:

<scheme>//<host>:<port>/<application>/<version>/<domain>/<object-type>[?<query-string>]

or

<scheme>//<host>:<port>/<application>/<version>/<domain>/<object-type>/actions/[<action-identifier>[/invoke]]

In this manual, "<scheme>//<host>:<port>/<application>" may transcribe it into "baseURL".

The following list describes the URI components.

Item

Description

<scheme>

Protocol. Specify "HTTP" or "HTTPS".

<host>

Host name or IP address of the JP1/OA host accessed from an API client.

<port>

Port number of the JP1/OA host accessed from an API client. The default port number is 22015 for HTTP, and 22016 for HTTPS.

<application>

Name of the application that provides the API functions. Specify the fixed value of "Analytics".

<version>

Your version of the API functions. For details, see the API version of each API function.

<domain>

Category of the resource specified for the API function. For details, see the list of resources managed through the API.

<object-type>

Indicates the resource or service. For details, see the list of resources managed through the API.

<query-string>

Query parameter that specifies a query parameter. This specifies a condition for reducing or sorting <object-type>. The available query parameters depend on resources. The query parameters can be in any order. For details, see the description of HQL syntax relationships and operators.

<action-identifier>

This indicates the action for the resource.

The components and other details of URIs vary for each API function. For more information, see the descriptions of the applicable API function.

Related topics

1.2.9 HQL syntax relationships and operators

1.4 Resources managed through the API

(2) Supported HTTP methods

Among the handling methods defined in HTTP, the GET, POST, PUT, and DELETE methods are supported.

The available methods depend on the resources. For details about the available methods, see the description for each API.

(3) Request Line format description

The request line consists of the following items:

Method△Request Path (URI)△Query△HTTP Version

△: Single-byte space

Item

Description

Example

Method

Request method

GET

Request Path (URI)

Path for the resource

/Analytics/v1/objects/Credentials

Query

Query parameters in the request

?$query=instanceId+eq+50

HTTP Version

String indicating the HTTP version

HTTP/1.1

A request line is limited to 8,190 or fewer bytes. For request lines larger than the maximum, the status code 414 (Request-URI Too Long) is returned.

(4) Information in the request header

A request header includes a data format and the language code of the responses.

Header

Description

Specifiable value

Required or not

Host

The following host information:

Host name or IP address: Host name or IP address of the JP1/OA server

Port number: Port number API uses to connect with JP1/OA

Depends on the user's environments

Optional

Accept

Data format of the response data.

application/json

Required

Accept-Language

Language of the response data.

Specify this if with the GET, POST, or PUT method.

ja: Japanese

en: English

Required

Content-Type

Format of the request bodies for the POST or PUT method.

application/json

Required

Authorization

Authentication information.

Basic authentication:

User information

HSSO token:

hsso token

Required

Content-Length

The request body size as a decimal number for the POST or PUT method.

Request body size (unit: bytes)

Required

1.2.5 Response format of the API

A response for a request contains a status line, response header, and response body.

(1) Status description

A status line contains the elements listed below.

Item

Description

Reference

Protocol

Displays the communication protocol used by the API.

--

Protocol version

Displays the version of the communication protocol used by the API.

--

Status code

Result of the request in a status code.

See the status codes of each API. For details, see 1.2.6 HTTP status codes description.

Message

Displays the content of the status code

--: Not applicable.

(2) Response headers descriptions

Header

Description

Cache-Control

Controls the response information in the cache for the API where the GET method was specified.

Content-Type

Data format of response data.

Language

Language code of response data.

WWW-Authenticate

Outputs the authenticated HSSO token.

Warning

When the API completes successfully but there is a problem with the status of the server, details display in U.S. English (only U.S. English is allowed in the HTTP standard specification).

(3) Response body description

The response body includes the response data returned when an API function is called. The data format of the response data is defined in the request header. The format of the response data depends on the API function. See the description for each API function.

1.2.6 HTTP status codes description

Status code

Name

Description

200

OK

Request processed normally

201

Created

Returned instead of 200 when a resource is successfully created

204

No Content

Returned instead of 200 when a request was successful but there is no response to return

303

See Other

Returned instead of 200 if another URI processes the request

400

Bad Request

The request is invalid. This includes invalid values specified for the query parameter.

401

Unauthorized

Notifies you that access to the resource requires authentication. The authentication method is shown in the WWW-Authenticate header. If the request including the authorization header is already applied, this code indicates that the authentication for the user information or the HSSO token was rejected. Possible reasons include incorrect user information (user ID or password) incorrect HSSO token, and a lack of rights to use JP1/OA.

403

Forbidden

The user does not have the permissions required to do the operation.

404

Not found

The specified resource or operation was not found.

405

Method Not Allowed

A valid method was not available for the specified resource. Always list the available methods.

406

Not Acceptable

The specified response format is not supported.

409

Conflict

Conflicts with other data in the server prevent the request from completing.

412

Precondition Failed

The request was not accepted because of a failure in the preconditions.

414

Request-URI Too Long

The request line is too long.

415

Unsupported Media Type

The specified request format is not supported.

500

Server-Side Error

An error occurred in a server process.

503

Service Unavailable

An error occurred on the repository server.

For the status codes of 4XX and 5XX, a response body might be returned in "text/html" or "text/plain" form. In this case, "Content-Type: text/html" or "Content-Type: text/plain" is in a response header.

Responses provide more detailed contents of errors for which causes are hard to identify only with the status codes of 4XX and 5XX.

Whether to use these status codes depend on the APIs. See the description for each API.

1.2.7 Error information for errors in API requests

If an error occurs in an API request, the schema in the following table is returned as the response information. For details on error information for schemas other than the schema in the following table, see the JP1/Operations Analytics Messages.

Attribute

Data type

Description

errorSource

string

API function for which the error occurred.

message

string

Message about the error.

messageID

string

Message ID of the error. If an error occurs in a request because of a reason such as incorrect JSON syntax, the message ID is "generic error."

application

string

Information about the application that provides the API function for which the error occurred (Analytics).

1.2.8 Query parameters in the API

If you add search conditions to a request by using query parameters, you can filter or sort the output results of the response.

(1) Query parameter for all APIs

Parameter

Description

Value

Default value

Alt

Specify input/output data format in the same way as the Content-Type header and Accept header in a request.

json

Not applicable.

(2) Query parameters for some APIs

The following table lists the parameters you can specify in the requests to obtain a list of resources (for example, monitored profiles and virtual machines). The parameters depend on the APIs. See the description for each API.

Parameter

Description

Value#

Default value

$query

Filters the output results by using the specified conditions.

See 1.2.9 HQL syntax relationships and operators.

Not applicable.

$order-by

Sorts the output results by the specified attribute.

attribute [{ASC| DESC}](, attribute [{ASC| DESC}])

ASC: Ascending order

DESC: Descending order

ASC

$offset

Specifies the position of the initial object of the range of information collection. Specify the maximum number of objects in a response with $count. page is given priority over $offset.

0 to 2147483647

0

$count

Specifies the maximum number of objects in a response, starting from the initial object's position specified by $offset. pageSize has priority over $count. If the sum of $count and $offset exceeds 2,147,483,647, the IDs of the obtained objects range from the value of $offset to 2,147,483,647.

1 to 2147483647

100

page

Gets information about a specific page when resources are divided into pages. You also need to specify pageSize. page has priority over $offset.

1 to 2147483647

Not applicable.

pageSize

Specifies the maximum number of objects to be displayed on one page. pageSize has priority over $count.

1 to 2147483647

Not applicable.

#: If you want to specify a character string that cannot be expressed as a URL, use UTF-8 encoding and encode the character string.

pageSize refers to the maximum number of objects in one page. Page refers to the page number to display. If you set page and pageSize, the pagination object receives the total number of resources and pages. This value enables you to see whether there are any of the following pages:

As shown in the expression below, page and pageSize are converted the values of $offset.

$offset=pageSize*(page-1)

The status code 400 (Bad Request) is returned if page and pageSize are out of the range of $offset.

1.2.9 HQL syntax relationships and operators

HQL is a query language that can filter collections of data by using various query parameters, including $query and supported operators.

Use UTF-8 encoding and encode characters and symbols that cannot be expressed as a URL.

Syntax

To define a collection of a resource request, use the following expressions:

expression ::= "(" expression ")" | binary-expression | expression junction expression
junction ::= ( "and" | "or" )

binary-expression ::= (compare-expression | tuple-expression)

compare-expression ::= name-expression compare-operation value-expression

name-expression ::= property-name | "[" property-name "]"
compare-operation ::= ( "eq" | "=" | "ne" | "<>" | "!=" | "gt" | ">" | "lt" | "<" | "ge" |">=" | "le" |"<=" | "starts" | "ends" )
value-expression ::= ( string-expression | number-expression | boolean-expression )

string-expression ::= "'" ([^'] | [']{2})* "'"
number-expression::= ( "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" )+
boolean-expression::= "true" | "false" |"TRUE" | "FALSE"

tuple-expression ::= name-expression tuple-operation tuple-value-expression

tuple-value-expression ::= "[" value-expression ("," value-expression)* "]"

tuple-operation ::= ( "in" | "not in" )

property-name is an attribute defined in a resource.

value-expression displays a string expression, number expression, or Boolean expression. This value is different from the actual data type of the attribute defined in a resource. The "ISO8601String" type, for example, is dealt with as a string in ISO 8601 format. As a result, it displays as a string-expression.

The following table describes the relationship between the data types and expression formats:

Type

Expression

int/long/float

number-expression

enum

string-expression

String

string-expression

ISO8601String

string-expression

URLString

string-expression

boolean

boolean-expression

The following table lists and describes the operators supported by HQL in priority as indicated in the Priority column.

Operator

Description

Expression

Priority (1-3)

eq

Equal

number-expression,

string-expression (string, enum),

boolean-expression

1

ne

Not equal

number-expression,

string-expression (string, enum),

boolean-expression

1

gt

Greater than

number-expression,

string-expression (string, enum),

1

lt

Smaller than

number-expression,

string-expression (string, enum),

1

ge

Equal or greater than

number-expression,

string-expression (string, enum),

1

le

Equal or smaller than

number-expression,

string-expression (string, enum),

1

starts#

Start value

string-expression (string, excluding ISO8601String)

1

ends#

End value

string-expression (string, excluding ISO8601String)

1

likes#

Included

string-expression (string, excluding ISO8601String)

1

in

Included

number-expression,

string-expression (string, enum),

boolean-expression

1

not in

Not included

number-expression,

string-expression (string, enum),

boolean-expression

1

and

Both true

compare-expression, tuple-expression

2

or

Either of them true

compare-expression, tuple-expression

3

# The operator name is not case sensitive.

Example:

Before URL encoding:

...?$query=instanceID in [1000,1001,1002] and status eq 'Warning'

After URL encoding:

...?$query=instanceID%20in%20%5b1000%2c1001%2c1002%5d%20and%20status%20eq%20%27Warning%27

1.2.10 Domain object format

A domain refers to the storage location supported by JP1/OA. A domain object refers to a resource.

Supported data type

The following table describes the supported data types.

Type

Description

boolean

True or false

float

Floating-point decimal

int

32-bit signed integer

long

64-bit signed integer

string

Text data

ISO8601String, URLString, and enum are extended expressions for the string type.

Date and time format

To specify the date and time, use ISO 8601 format. In this format, you can omit all information except year (yyyy). If the date or time is omitted, the minimum value is automatically added. If the time zone is omitted, the time zone set for the JP1/OA server is the default.

Note, however, that you cannot omit the date and time if you use $query to specify them. If you get time information in JSON format, the time is output in a format where a colon is not used for time zone information (for example, 2014-12-09T18:50:30.500+0900). To specify the time information in JSON format as an input for an API, add a colon in the time zone (for example, 2014-12-09T18:50:30.500+09:00). If you do not add a colon, an error occurs.

If the data type of an attribute is "ISO8601String," the year, month, date, time, and time zone display in the response body in the format shown in the following table:

Format

Example

Time processed by JP1/OA

yyyy-mm-ddThh:mm:ss.mmmTZD

2015-12-09T18:50:30.500+09:00

2015-12-09T18:50:30.500+09:00

yyyy-mm-ddThh:mm:ss.mmm

2015-12-09T18:50:30.500.000

2015-12-09T18:50:30.500.000[time-zone-of-the host-server]

yyyy-mm-ddThh:mm:ssTZD

2015-12-09T18:50:30+09:00

2015-12-09T18:50:30.000+09:00

yyyy-mm-ddThh:mmTZD

2015-12-09T18:50+09:00

2015-12-09T18:50:00.000+09:00

yyyy-mm-ddThhTZD

2015-12-09T18+09:00

2015-12-09T18:00:00.000+09:00

yyyy-mm-dd

2015-12-09

2015-12-09T00:00:00.000[time-zone-of-the host-server]

yyyy-mm

2015-12

2015-12-01T00:00:00.000[time-zone-of-the host-server]

yyyy

2015

2015-01-01T00:00:00.000[ time-zone-of-the host-server]

1.3 Resource members

Functions provided by JP1/OA are categorized as resources. As a member, you can acquire information about resources through response bodies. The following tables show the member names, data types, and descriptions of the resources to be returned, and whether each member is applicable to $query and $order-by for each function.

Points:

When a response is returned and the value of a member does not exist, the member might be omitted in the response body.

JP1/OA might return unsupported members. For details about supported members, see the tables for each function below.

When you acquire the list of resources, the members of each function are acquired as a list. For details about the list format, see 1.3.35 Members of an acquired list of resources.

Unless otherwise specified, specify dates according to 1.2.10 Domain object format.

1.3.1 Members of the authentication information

This section explains the Members of the authentication information (Credentials resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Name of authentication information
Y
Y
Y

credentialType
enum
Protocol used for connections to monitoring targets. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

N
Y (only to eq, ne, in, not in)
N

userId
string
Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.
Y
Y
N

password
string
Password used for authentication.Specify a Base64 encoded string of 255 or fewer bytes.
Y
N
N

passwordNotRequired
boolean
Whether a password is needed for authentication.

true: A password is not needed

false: A password is needed

If this member is omitted, false is set.This setting takes effect only if WMI is used for connection to the monitoring target.
Y
N
N

portNumber
integer
Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.
Y
N
N

rootPassword
string
Root password used for authentication. Specify a Base64 encoded string of 255 or fewer bytes.This member is only enabled when SSH is used for connections to monitoring targets.
Y
N
N

updatePassword
boolean
Whether to change the password (password).

true: Password is changed

false: Password is not changed

If this member is omitted, false is set.
Y
N
N

updateRootPassword
boolean
Whether to change the root password (rootPassword).

true: Root password is changed

false: Root password is not changed

If this member is omitted, false is set.This member is only enabled when SSH is used for connections to monitoring targets.
Y
N
N

ssl
boolean
Whether to use SSL (HTTPS) for connections to monitoring targets.

true: SSL is used

false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.
Y
N
N

domainname
string
Domain name. This member is only enabled when WMI is used for connections to monitoring targets.
Y
N
N

namespace
string
Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.
Y
N
N

community
string
Community name. This member is only enabled when SNMP is used for connections to monitoring targets.
Y
N
N

snmpVersion
enum
SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
Y
N
N

username
string
User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

authenticationEnabled
boolean
Whether to perform SMTP authentication.

true: SMTP authentication is enabled

false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

authenticationPassphrase
string
Authentication pass phrase. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

updateAuthenticationPassphrase
boolean
Whether to change the authentication pass phrase.

true: Authentication pass phrase is changed

false: Authentication pass phrase is not changed

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

authenticationProtocol
enum
Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets. For details about the specifiable values, see the table AuthenticationProtocol in 1.6 List of enumerators.
Y
N
N

privacyEnabled
boolean
Whether to enable privacy.

true: Privacy is enabled

false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

privacyPassphrase
string
Pass phrase for privacy. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

updatePrivacyPassphrase
boolean
Whether to change the pass phrase for privacy.

true: Pass phrase is changed

false: Pass phrase is not changed

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

privacyProtocol
string
Protocol for privacy.

DES: DES is used

AES128: AES128 is used

Only specify this member when using SNMP v3 for connections to monitoring targets.
Y
N
N

numOfRelatedResources
integer
Number of resources found by using authentication information
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.2 Members of a plug-in

This section explains the Members of a plug-in (Plugins resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Name of the plug-in
N
Y
Y

pluginId
string
ID for identifying the plug-in
N
Y
Y

protocolType
enum
Protocol used for connections to monitoring targets. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

SNMP

N
Y
N

formatversion
string
Format version of the plug-in
N
Y
Y

pluginversion
string
Version of the plug-in
N
Y
Y

pluginType
enum
Type of the plug-in. For details about the specifiable values, see the table PluginType in 1.6 List of enumerators.

The specifiable values are as follows:

NODE_PLUGIN

N
Y
N

numOfRelatedResources
int
Number of resources found by using the plug-in
N
N
N

isCollector
boolean
Whether it is Collector
N
Y
Y

status
enum
Status of the plug-in. For details about the specifiable values, see the table PluginStatusType in 1.6 List of enumerators.
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.3 Members of the search range

This section describes the members of the search range (IpAddrRanges resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long

ID for identifying the instance

N
N
N

name
string

Name of the search range

Y
N
N

ipAddrRange
string[]

Search range. Specify the start IP address of the search in the number 0 item of the list. Specify the end IP address of the search in the number 1 item of the list.

Y
N
N

usePing
boolean

Specify whether to execute ping on the target devices during retrieval.

true: Use ping.

false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

Y
N
N

aliveMonitoring
boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

true: Register as alive-monitoring targets.

false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

Y
N
N

useAllCredential
boolean

Whether to use all Credential resources

true: All Credential resources are used.

false: Not all Credential resources are used.

Y
N
N

selectedCredentials
Credential[]

List of authentication information items to be used in a search

Y
N
N

useAllPlugin
boolean

Whether to use all Plug-in resources

true: All Plug-inresources are used.

false: Not all Plug-in resources are used.

Y
N
N

selectedPlugins
Plugin[]
A list of plug-in information to be used to perform searches
Y
N
N

deviceClassificationLabel
string
Name of the classification label assigned to the device
Y
N
N

numOfRelatedPluginResources
int
Number of plug-in resources found by using retrieval range.
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.4 Members of the Discovered Resources

This section explains the Members of the Discovered Resources (DiscoveryLogResource resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
int
Instance ID of the discovered-resource information. This is different from the instance ID of a resource.
N
N
N

ipAddress
string
IP address of the resource
N
N
N

name
string
Name of the IP address range used in the discovery
N
N
N

nodeName
string
Resource name
N
N
N

monitorStatus
enum
Management status of the resource. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
N
N

deviceType
enum
Device type of the resource. For details about the specifiable values, see the table ArgusNodeType in 1.6 List of enumerators.

The specifiable values are as follows:

SERVER_WINDOWS

SERVER_LINUX

SWITCH_FC

SWITCH_IP

STORAGE_OTHER

GENERIC_COMPUTER

GENERIC_STORAGE

SERVER_SOLARIS

SERVER_HYPERV

SERVER_HPUX

SERVER_AIX

GENERIC_HYPERVISOR

N
N
N

credentialType
enum
Type of authentication credentials used in the discovery. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

N
N
N

nodeInformationGettableLevel
enum
Result of the authentication credentials used in the discovery. This property is set when discoveryLogCategory is NoResponse or Failed. For details about the specifiable values, see the table NodeInformationGettableLevel in 1.6 List of enumerators.
N
N
N

discoveryLogCategory
enum
Category of discovered resources. For details about the specifiable values, see the table DiscoveryLogCategory in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

autoManage
boolean
To automatically manage discovered resources, set true.
N
N
N

credentialName
string
Name of the authentication credentials used in the discovery
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.5 Members of the execution result of the Discovery

This section explains the Members of the execution result of the Discovery(DiscoveryLog resource).

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
status | enum | Discovery progress status. If a discovery has not been run, properties other than the status are not output. For details about the specifiable values, see the table DiscoveryStatusType in 1.6 List of enumerators. | N | N | N
autoManage | boolean | To automatically manage discovered resources, set true. | N | N | N
startTime | datetime | Discovery start time | N | N | N
completionTime | datetime | Discovery end time. If the discovery is in progress, this value is null. | N | N | N
elapsedTime | int | Time elapsed during discovery (in seconds) | N | N | N
discoveredResources | int | Number of discovered resources | N | N | N
failedProtocols | int | Number of resources for which discovery failed | N | N | N
noResponseIpAddresses | int | Number of resources for which there was no response | N | N | N
skippedResources | int | Number of skipped resources | N | N | N
denominatorForProgress | int | Denominator for the progress calculation | N | N | N
numeratorForProgress | int | Numerator for the progress calculation. This is the number of IP addresses (from among the discovery targets) for which processing is complete. | N | N | N
lastTime | datetime | Time when the discovery status was last checked | N | N | N
discoverdLogTargetIPRange | DiscoveryLogTargetIPRange[] | List of IP-address ranges included in the discovery results | N | N | N

(Legend) Y: Applicable, N: Not applicable

1.3.6 Members of the IP-address ranges included in the discovery results

This section explains the Members of the IP-address ranges included in the discovery results (DiscoveryLogTargetIPRange resource).

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
name | string | Name of IPAddrRange | N | N | N

(Legend) Y: Applicable, N: Not applicable

1.3.7 Members of collectors

This section explains the Members of collectors (Collectors resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Collector name
Y
Y
Y

collectorType
boolean
Collector type. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

N
Y (only to eq, ne, not in)
N

osType
enum
Type of OS. This member is only set when the collectorType is AJS, PFM, or IM. For details about the specifiable values, see the table CollectorOsType in 1.6 List of enumerators.
N
N
N

autoCollectionType
enum
Settings for periodic executions of the collector. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

connectResult
enum
Last execution result of the collector. For details about the specifiable values, see the table ConnectStatusType in 1.6 List of enumerators.

The specifiable values are as follows:

NoConnect

Succeeded

Failed

N
Y (only to eq, ne, in, not in)
N

refreshStatus
enum
Execution status of the collector. For details about the specifiable values, see the table ConnectStatusType in 1.6 List of enumerators.

The specifiable values are as follows:

NoConnect

InProgress

N
N
N

message
string
Message of the execution result of the collector
N
N
N

lastRefreshed
ISO8601String
The date and time when information for the following was last updated:

refreshDateForInventory

refreshDateForPerformance

refreshDateForState

N
N
N

refreshDateForInventory
ISO8601String
Refresh date and time for the configuration information
N
N
N

refreshDateForPerformance
ISO8601String
Refresh date and time for the performance information
N
N
N

refreshDateForState
ISO8601String
Date and time when the state information is to be refreshed. This value can be obtained when all of the following conditions are met:

The type of collector is VCENTER.

The collection interval settings of "State Monitoring (VM/Hypervisor)" are enabled.

N
N
N

numOfHypervisors
int
Number of hypervisors found by the collector
N
N
N

numOfVms
int
Number of virtual machines found by the collector
N
N
N

numOfApplications
int
Number of applications found by the collector
N
N
N

numOfServices
integer
Number of services found by the collector
N
N
N

numOfContainers
int
Number of container nodes found by the collector
N
N
N

numOfResources
int
Number of management resources found by the collector
N
N
N

collectorCredentials
CollectorCredential[]
Authentication information used for connections to monitoring targets. For details, see 1.3.8 Members of authentication information used by collectors.
--
--
--

productName
string
Collected-product name
N
Y
Y

providerName
string
Provider name
N
Y
Y

refreshDateForApp
ISO8601String
Date definition was applied
N
N
N

plugin
plugin
Defail information of the plug-in applied to the collector
N
N
N

(Legend) Y: Applicable, N: Not applicable, --: Not supported

1.3.8 Members of authentication information used by collectors

This section explains the Members of authentication information used by collectors (CollectorCredential resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

requireHostAddress
boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

Y
N
N

instanceID
long
ID for identifying instances
N
N
N

ipAddress
string
IP address or host name used for connections to management software
N
N
N

accessTargetIdentification
string
Access-target identification key (when no IP address is specified)
Y
Y
Y

userId
string
User ID used for connections to management software. Specify a string of 255 or fewer bytes.
Y
N
N

password
string
Password used for connections to management software. Encode a string of 255 or fewer bytes in Base64.
Y
N
N

updatePassword
boolean
Whether to change the password used for connections to management software.

true: Password is changed

false: Password is not changed

If this member is omitted, false is set.
Y
N
N

portNumber
int
Port number used for connections to management software
Y
N
N

optionalInformation1
string
Option information for information acquisition that can be used in the plug-in. The value set for the first option. Encode a string in Base64.
N
N
N

updateOptionalInformation1
boolean
To change option 1, set "true". Use this only for updates.
Y
N
N

optionalInformation2
string
Option information for information acquisition that can be used in the plug-in. The value set for the second option. Encode a string in Base64.
N
N
N

updateOptionalInformation2
boolean
To change option 2, set "true". Use this only for updates.
Y
N
N

optionalInformation3
string

Option information for information acquisition that can be used in the plug-in.

The value set for the third option. Encode a string in Base64.

N
N
N

updateOptionalInformation3
boolean
To change option 3, set "true". Use this only for updates.
Y
N
N

hypertextTransferProtocolType
enum
Whether to use SSL (HTTPS) for connections to management software.For details about the specifiable values, see the table HypertextTransferProtocolType in 1.6 List of enumerators. If this member is omitted, false is set.
N
N
N

domainName
string
Domain name: Used for application linkage when Windows is selected.
Y
N
N

rootPassword
string
root password: Used for application linkage when Unix is selected.
Y
N
N

updateRootPassword
boolean
To change the password, set true. Use only for updates.
Y
N
N

useAdministrativeShares
boolean
To share management, set true.
Y
N
N

shareName
string
share Name
Y
N
N

sharedFolder
string
shared Folder
Y
N
N

logicalHostName
string
Logical Host Name
Y
N
N

useLogicalHostName
boolean
To use logical host name, set true.
Y
N
N

useProxy
boolean
Specify true when connecting to a custom collector via a proxy.
Y
N
N

proxyHostAddr
string
Proxy host address when using a proxy
Y
N
N

proxyPort
int
Proxy port when using a proxy
Y
N
N

proxyUser
string
The authenticated user of the proxy when using the proxy
Y
N
N

updateProxyPassword
boolean
Set true to the proxy password. Used only when updating.
Y
N
N

proxyPassword
string
Proxy authentication password when using a proxy. Encode a string in Base64.
Y
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.9 Members of the collection-interval settings

This section describes the members of the collection-interval settings (the MonitoringIntervalSettings resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long

Instance ID

N
N
N

configurationEnabled
boolean

Whether Configuration Monitoring is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

N
N
N

configurationLastDuration
int

Length of the most recent Configuration Monitoring period (minutes)

If collection was never performed, -1 is returned.

N
N
N

configurationMaxDuration
int

Length of the longest Configuration Monitoring period (minutes)

If collection has never been done, -1 is returned.

N
N
N

configurationInterval
int

Interval between Configuration Monitoring periods (days)

N
N
N

configurationStartHour
int

Start time of Configuration Monitoring (hour)

N
N
N

configurationStartMinutes
int

Start time of Configuration Monitoring (minute)

N
N
N

performanceEnabled
boolean

Whether Performance Monitoring is enabled

true: Monitoring is enabled.

false: Monitoring is disabled.

N
N
N

performanceLastDuration
int

Length of the most recent Performance Monitoring period (minutes)

If collection has never been done, -1 is returned.

N
N
N

performanceMaxDuration
int

Length of the longest Performance Monitoring period (minutes)

If collection has never been done, -1 is returned.

N
N
N

performanceInterval
int

Interval between Performance Monitoring periods (minutes)

N
N
N

hypervisorVMEnabled
boolean

Whether Configuration Monitoring (VM/Hypervisor) is enabled

true: Monitoring is enabled.

false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

Y
N
N

hypervisorVMLastDuration
int

Length of the most recent Configuration Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

N
N
N

hypervisorVMMaxDuration
int

Length of the longest Configuration Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

N
N
N

hypervisorVMInterval
int

Interval between Configuration Monitoring periods (VM/Hypervisor) (minutes/hours/days)

The specifiable values range from 1 to 9999. The execution cycle type is specified by the value for "hypervisorVMScheduleCycleType". If this setting is omitted, the value already set for this item is not changed.

Y
N
N

hypervisorVMScheduleCycleType
enum

Type of execution cycle for Configuration Monitoring (VM/Hypervisor). For details about the specifiable values, see the table ScheduleCycleType in 1.6 List of enumerators.

The specifiable values are as follows:

Minutely

Hourly

Daily

Y
N
N

hypervisorVMStartHour
int

Start time of Configuration Monitoring (VM/Hypervisor) (hour)

The specifiable values range from 0 to 23. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

Y
N
N

hypervisorVMStartMinutes
int

Start time of Configuration Monitoring (VM/Hypervisor) (minute)

The specifiable values range from 0 to 59. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

Y
N
N

applicationEventEnabled
boolean

Whether Event Monitoring (Application) is enabled

true: Monitoring is enabled.

false: Monitoring is disabled.

N
N
N

applicationEventLastDuration
int

Length of the most recent Event Monitoring period (Application) (minutes)

If collection has never been done, -1 is returned.

N
N
N

applicationEventMaxDuration
int

Length of the longest Event Monitoring period (Application) (minutes)

If collection has never been done, -1 is returned.

N
N
N

applicationEventInterval
int

Interval between Event Monitoring periods (Application) (minutes)

N
N
N

stateOfHypervisorVMEnabled
boolean

Whether State Monitoring (VM/Hypervisor) is enabled

true: Monitoring is enabled.

false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

Y
N
N

stateOfHypervisorVMLastDuration
int

Length of the most recent State Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

N
N
N

stateOfHypervisorVMMaxDuration
int

Length of the longest State Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

N
N
N

stateOfHypervisorVMInterval
int

Interval between State Monitoring periods (VM/Hypervisor) (minutes)

The specifiable values are 1 to 9999. If this setting is omitted, the value already set for this item is not changed.

Y
N
N

1.3.10 Members of the user settings information

This section describes the members of the user settings information (the UserCustomSettings resource).

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
instanceID | long | ID of User Custom Setting | N | N | N
userName | string | User name | N | N | N
guiDisplayParams | GuiDisplayParam[] | List of GUI display parameters set by the user. For details, see 1.3.11 Members of GUI-display settings set by users. | Y | N | N

1.3.11 Members of GUI-display settings set by users

This section describes the members of the GUI-display settings set by users (the GuiDisplayParam resource).

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
screenKey | string | screen key | N | N | N
screenSettingValue | string | setting value for the screen display | Y | N | N

1.3.12 Members of a user profile

This section explains the Members of a user profile (UserThresholdProfiles resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

profileName
string
User profile name. Use 128 or fewer characters.
Y
Y
Y

description
string
Description of the user profile. Use 256 or fewer characters.
Y
Y
Y

resourceType
string
Resource type to which the user profile can be applied.The following value can be specified.

VM: Virtual machine

VOLUME: Volume

WINDOWS: Windows

LINUX_UNIX: Linux/UNIX

Y (only when a new profile is created)
Y (only to eq)
N

profileType
string
Change type of the user profile.

User: Profile is created by a user

Default: Profile is registered by default

Preset: Profile for which the initial settings are set

N(Specify User when creating a new profile)
Y (only to eq, ne, in, not in)
N

thresholdValues
UserThresholdValue[]
Details of the threshold set in the user profile. For details, see 1.3.13 Members of a user profile threshold.
--
--
--

numOfResources
integer
Number of resources to which the user profile is assigned
N
N
N

autoAssignFilters
string[]
Name of the automatic assignment rule
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

appliedPlugins
Plugin[]
List of the plig-in applied to the profile
N
N
N

(Legend) Y: Applicable, N: Not applicable, --: Not supported

1.3.13 Members of a user profile threshold

This section explains the Members of a user profile threshold (UserThresholdValue resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
N
N

monitoring
boolean
Whether the threshold is monitored.

true: Threshold is monitored

false: Threshold is not monitored

If this member is omitted, false is set.
Y
N
N

metricType
string
Identifier of the threshold. This member is not supported.
N
N
N

displayName
string
Display name of the threshold
N
N
N

unit
string
String indicating the unit of the threshold
N
N
N

proportion
boolean
Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

N
N
N

thresholdValueOfWarning
float
Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

Multiple of stepSize

Less than or equal to max

Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

Y
N
N

thresholdValueOfError
float
Threshold for showing errors. You need to specify this threshold according to the following conditions:

Multiple of stepSize

Less than or equal to max

Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

Y
N
N

stepSize
float
Increment for the threshold
N
N
N

max
float
Maximum value that can be specified for the threshold
N
N
N

min
float
Minimum value that can be specified for the threshold
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.14 Members of a system profile

This section explains the Members of a system profile (SystemThresholdProfiles resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

profileName
string
System profile name. Use 128 or fewer characters.
Y
Y
Y

description
string
Description of the system profile. Use 256 or fewer characters.
Y
Y
Y

resourceType
string
Resource type to which the system profile can be applied.The following value can be specified.

ESX: ESX

HYPERV: Hyper-V

IPSWITCH: IP Switch

FCSWITCH: FC Switch

CLUSTER: Clutser

Y (only when a new profile is created)
Y (only to eq)
N

profileType
string
Change type of the system profile.

User: Profile is created by a user

Default: Profile is registered by default

Preset: Profile for which the initial settings are set

N(Specify User when creating a new profile)
Y (only to eq, ne, in, not in)
N

thresholdValues
SystemThresholdValue[]
Details of the threshold set in the system profile. For details, see 1.3.15 Members of a system profile threshold.
--
--
--

numOfResources
integer
Number of resources to which the system profile is assigned
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

appliedPlugins
Plugin[]
List of the plig-in applied to the profile
N
N
N

(Legend) Y: Applicable, N: Not applicable, --: Not supported

1.3.15 Members of a system profile threshold

This section explains the Members of a system profile threshold (SystemThresholdValue resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
N
N

monitoring
boolean
Whether the threshold is monitored.

true: Threshold is monitored

false: Threshold is not monitored

If this member is omitted, false is set.
Y
N
N

metricType
string
Identifier of the threshold. This member is not supported.
N
N
N

displayName
string
Display name of the threshold.
N
N
N

unit
string
String indicating the unit of the threshold.
N
N
N

proportion
boolean
Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

N
N
N

thresholdValueOfWarning
float
Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

Multiple of stepSize

Less than or equal to max

Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

Y
N
N

thresholdValueOfError
float
Threshold for displaying errors. You need to specify this threshold according to the following conditions:

Multiple of stepSize

Less than or equal to max

Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

Y
N
N

stepSize
float
Increment for the threshold
N
N
N

max
float
Maximum value that can be specified for the threshold
N
N
N

min
float
Minimum value that can be specified for the threshold
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.16 Members of a consumer

This section explains the Members of a consumer (Groups resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Consumer name. Use 128 or fewer characters.
Y
Y
Y

status
enum
Status of the consumer. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.

The specifiable values are as follows:

Normal

Warning

Error

N
N
N

gradeKey
string
ID for identifying grades
Y
Y
Y

gradeName
string
Grade name
N
N
N

gradeDisplayOrder
integer
Priority of the grade
N
N
N

description
string
Description of the consumer. Use 1000 or fewer characters.
Y
Y
Y

urls
string[]
URL
Y
N
N

urlDisplayNames
string[]
Character string displayed for the URL
Y
N
N

templateCreatorType
enum
Change type of the consumer. For details about the specifiable values, see the table TemplateCreatorType in 1.6 List of enumerators.
Y (only when a new profile is created)
Y (only to eq, ne, in, not in)
N

vmAutoAssignment
boolean
Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically
Y
N
N

applicationAssignFollow
boolean
Set true if you assign a application under the resource that belong to this Group automatically
Y
N
N

numOfVolumes
integer
Number of volumes to which the consumer is assigned.
N
N
N

numOfVMs
integer
Number of virtual machines to which the consumer is assigned
N
N
N

numOfHosts
integer
Number of hosts to which the consumer is assigned
N
N
N

numOfHypervisors
integer
Number of hypervisors to which the consumer is assigned
N
N
N

numOfApplications
integer
Number of applications to which the consumer is assigned
N
N
N

numOfPods
integer
Number of pods to which the consumer is assigned
N
N
N

numOfInstances
integer
Number of instances to which the consumer is assigned.
N
N
N

vmAutoAssignFilters
string[]
Name of the automatic assignment rule set for the virtual machines
N
N
N

hostAutoAssignFilters
string[]
Name of the automatic assignment rule set for the hosts
N
N
N

podAutoAssignFilters
string[]
Name of the automatic assignment rule set for the pods
N
N
N

instanceAutoAssignFilters
string[]
Name of the automatic assignment rule set for the instances
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.17 Members of a grade

This section explains the Members of a grade (Grade resource).

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
gradeKey | string | ID for identifying grades | N | Y | Y
name | string | Grade name | N | Y | Y
displayOrder | string | Priority of the grade | N | Y | Y

(Legend) Y: Applicable, N: Not applicable

1.3.18 Members of the application

This section explains the Members of the application (Applications resource).

Member name | Data type | Description | Whether to change | Application to filter conditions ($query) | Application to sort conditions ($order-by)
instanceID | long | ID for identifying instances | N | N | N
name | string | Name of the detected application | N | N | N
applicationType | enum | Application type. For details about the specifiable values, see the table ApplicationType in 1.6 List of enumerators. | N | N | N
applicationDetailType | string | Type of the custom application | N | N | N
ipAddress | string | IP address of the application | N | N | N
description | string | Detailed information about the application | N | N | N
collectorID | long | ID identifying the collector used for detection | N | N | N
collectorName | string | Name of the collector used for detection | N | N | N
applicationHosts | ApplicationHost[] | Resources to which the application belongs | N | N | N
applicationContainers | ApplicationContainer[] | Containers to which the application belongs | N | N | N
autoCollectionType | enum | Settings for periodic execution of the collector. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators. | N | N | N
groupIDs | long[] | ID identifying the consumer to which the application is allocated | N | N | N
groupNames | string[] | Name of the consumer to which the application is allocated | N | N | N
gradeNames | string[] | Grade of the consumer to which the application is allocated | N | N | N
gradeOrders | int[] | Priority of the grade of the consumer to which the application is allocated | N | N | N
usedCredentialID | int[] | ID identifying the authentication information used at detection | N | N | N
usedCredentials | string | Authentication information used at detection | N | N | N
accessPointType | enum | Type of collector used at detection. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators. | N | N | N
accessPointIpAddress | string | IP address or host name of the authentication information | N | N | N
accessPointUser | string | User ID used to connect to monitoring targets or management software | N | N | N

(Legend) Y: Applicable, N: Not applicable

1.3.19 Members of application resource information

This section explains the Members of application resource information (ApplicationHost resource).

Member name
Data type
Description
Whether to change
Application to filter conditions ($query)
Application to sort conditions ($order-by)

resourceID
long
ID of the resource to which the application belongs
N
N
N

resourceType
enum
Type of the resource to which the application belongs. For details about the specifiable values, see the table ApplicationResourceType in 1.6 List of enumerators.

The specifiable values are as follows:

VirtualMachine

Host

ServiceInstance

N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.20 Members of application container information

This section explains the Members of application container information (ApplicationContainer resource).

Member name
Data type
Description
Whether to change
Application to filter conditions ($query)
Application to sort conditions ($order-by)

resourceID
long
ID of the resource to which the application belongs
N
N
N

resourceType
enum
Type of the resource to which the application belongs. For details about the specifiable values, see the table ApplicationResourceType in 1.6 List of enumerators.

The specifiable values are as follows:

Pod

N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.21 Members of a container cluster

This section explains the Members of a container cluster (ContainerCluster resource).

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
instanceID | long | ID of the container cluster | N | Y | Y
name | string | Name of the container cluster | N | Y | Y
status | enum | Status of the container cluster. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators. | N | Y (only to eq, ne, in, not in) | N
pluginId | string | ID for the plug-in applied to the container cluster. | N | Y | Y
description | string | Description | N | N | N
collectorID | long | ID for identifying a collector used for detection. | N | N | N
collectorName | string | Name of a collector used for detection. | N | N | N

(Legend) Y: Applicable, N: Not applicable

1.3.22 Members of a container node

This section explains the Members of a container node (ContainerNodes resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID of the container node
N
Y
Y

name
string
Name of the container node
N
Y
Y

status
enum
Status of the container node. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitor status of the container node. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the container node
N
Y
Y

clusterName
string
Name of the Cluster that the container node belongs to
N
Y
Y

role
string
Role of the container node
N
Y
Y

labels
string
Labels of the container node
N
Y
Y

collectorID
long
ID for identifying a collector used for detection.
N
N
N

collectorName
string
Name of a collector used for detection.
N
N
N

autoCollectionType
enum
Type of a collector used for detection. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

usedCredentialID
long
ID for authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

HTTP

N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

pluginId
string
ID for the plug-in applied to the container node.
N
Y
Y

pluginName
string
Name for the plug-in applied to the container node.
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.23 Members of a pod

This section explains the Members of a pod (pods resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID of the pod
N
Y
Y

name
string
Name of the pod
N
Y
Y

status
enum
Status of the pod. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitor status of the pod. For details about the specifiable values, see the table ComponentMonitorType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

nodeID
long
ID of the container node that the pod belongs to
N
Y
Y

nodeName
string
Name of the Cluster that the pod belongs to
N
Y
Y

nodeMonitorStatus
enum
Monitor status of the container node that the pod belongs to. For details about the specifiable values, see the table ManagementLevelType 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

clusterName
string
Name of the Container node that the pod belongs to
N
Y
Y

namespace
string
Namespace of the container pod
N
Y
Y

ownerReferences
string
Control source of the container pod
N
Y
Y

labels
string
Labels of the container pod
N
Y
Y

groupIDs
long[]
ID of the consumer assigned to the pod
N
N
N

groupNames
string[]
Name of the consumer assigned to the pod
N
N
N

gradeNames
string[]
Name of the grade of the consumer assigned to the pod
N
N
N

gradeOrders
integer[]
Priority of the grade of the consumer assigned to the pod
N
N
N

collectorID
long
ID for identifying a collector used for detection.
N
N
N

collectorName
string
Name of a collector used for detection.
N
N
N

autoCollectionType
enum
Type of a collector used for detection. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

usedCredentialID
long
ID for authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

HTTP

N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

pluginId
string
ID for the plug-in applied to the pod.
N
Y
Y

pluginName
string
Name for the plug-in applied to the pod.
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.24 Members of a cluster

This section explains the Members of a cluster (Cluster resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID of the cluster
N
Y
Y

name
string
Name of the cluster
N
Y
Y

status
enum
Status of the cluster. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

componentType
enum
Type of the cluster. For details about the specifiable values, see the table ComponentType in 1.6 List of enumerators.

The specifiable values are as follows:

HYPERVISOR_CLUSTER

GENERIC_HYPERVISOR_CLUSTER

N
Y (only to eq, ne, in, not in)
N

thresholdProfileID
long
ID of the threshold profile assigned to the cluster
N
N
N

thresholdProfileName
string
Name of the threshold profile assigned to the cluster
N
N
N

originalThresholdProfileID
string
Original threshold profile ID of the threshold profile assigned to the cluster
N
N
N

pluginId
string
ID for the plug-in applied to the cluster.
N
Y
Y

description
string
Description
N
Y
Y

collectorID
long
ID for identifying a collector used for detection.
N
N
N

collectorName
string
Name of a collector used for detection.
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.25 Members of a hypervisor

This section explains the Members of a hypervisor (Hypervisors resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Name of the hypervisor
N
Y
Y

ipAddress
string
IP address of the hypervisor
N
N
N

status
enum
Status of the hypervisor. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the hypervisor. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the hypervisor
N
Y
Y

collectorID
long
ID for identifying a collector used for detection
N
N
N

collectorName
string
Name of a collector used for detection
N
N
N

autoCollectionType
enum
Settings for periodic executions of the collector. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

clusterName
string
Name of the cluster where the hypervisor is registered
N
Y
Y

clusterStatus
enum
Status of the cluster to which the hypervisor belongs. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

usedCredentialID
long
ID for identifying authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

hypervisorType
string
Type of the hypervisor.

SERVER_ESX: ESX server

SERVER_HYPERV: Hyper-V server

GENERIC_HYPERVISOR: Hypervisor defined by plug-in

N
Y (only to eq, ne, in, not in)
N

hypervisorDetailType
string
Type of the hypervisor that is defined by using the plug-in.
N
N
N

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

WMI

SNMP

VCENTER

N
N
N

accessPointSnmpVersion
enum
SNMP version of credential. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

groupIDs
long[]
ID of the consumer assigned to the hypervisor
N
N
N

groupNames
string[]
Name of the consumer assigned to the hypervisor
N
N
N

gradeNames
string[]
Name of the grade of the consumer assigned to the hypervisor
N
N
N

gradeOrders
integer[]
Priority of the grade of the consumer assigned to the hypervisor
N
N
N

pluginId
string
ID for the plug-in applied to the hypervisor
N
Y
Y

(Legend) Y: Applicable, N: Not applicable

1.3.26 Members of a virtual machine

This section explains the Members of a virtual machine (VirtualMachines resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Virtual machine name
N
Y
Y

ipAddress
string
IP address of the virtual machine
N
N
N

status
enum
Status of the virtual machine. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the virtual machine. For details about the specifiable values, see the table ComponentMonitorType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the virtual machine
N
Y
Y

componentType
enum
Type of the virtual machine. For details about the specifiable values, see the table ComponentType in 1.6 List of enumerators.

The specifiable values are as follows:

VIRTUAL_MACHINE

GENERIC_VIRTUALMACHINE

N
Y (only to eq, ne, in, not in)
N

collectorID
long
ID for identifying a collector used for detection
N
N
N

collectorName
string
Name of a collector used for detection
N
N
N

autoCollectionType
enum
Settings for periodic executions of the collector. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

clusterName
string
Cluster environment where the virtual machine is registered
N
Y
Y

hypervisorType
enum
Type of hypervisor to which the virtual machine belongs. For details about the specifiable values, see the table ArgusNodeType in 1.6 List of enumerators.

The specifiable values are as follows:

SERVER_ESX

SERVER_HYPERV

GENERIC_HYPERVISOR

N
Y (only to eq, ne, in, not in)
N

hypervisorDetailType
string
Type of the hypervisor that is defined by using the plug-in.
N
N
N

hypervisorID
long
ID for identifying the hypervisor to which the virtual machine belongs
N
Y
Y

hypervisorName
string
Name of the hypervisor to which the virtual machine belongs
N
Y
Y

hypervisorMonitorStatus
enum
Monitoring status of the hypervisor. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

hostName
string
Name of a host running on the virtual machine
N
Y
Y

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

groupIDs
long[]
ID for identifying the assigned consumer
N
N
N

groupNames
integer[]
Name of the assigned consumer
N
N
N

gradeNames
string[]
Name of the grade of the consumer assigned to the virtual machine
N
N
N

gradeOrders
integer[]
Priority of the grade of the consumer assigned to the virtual machine
N
N
N

usedCredentialID
long
ID for identifying authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

WMI

SNMP

VCENTER

N
N
N

accessPointSnmpVersion
enum
SNMP version of credential. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

pluginId
string
ID for the plug-in applied to the hypervisor that the virtual machine belongs to.
N
Y
Y

(Legend) Y: Applicable, N: Not applicable

1.3.27 Members of a host

This section explains the Members of a host (Hosts resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Host name
N
Y
Y

ipAddress
string
IP address of the host
N
N
N

osType
string
OS type of the host.

SERVER_WINDOWS: The OS is Windows.

SERVER_LINUX: The OS is Linux.

SERVER_SOLARIS: The OS is Solaris.

SERVER_HPUX: The OS is HP-UX.

SERVER_AIX: The OS is AIX.

GENERIC_COMPUTER: This is a host for which information is collected by a plug-in.

UNKNOWN: A host about which information is collected as an alive-monitoring target, or a host that is an SNMP trap-notification source registered as a management target.

N
Y (only to eq, ne, in, not in)
N

status
enum
Status of the host. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the host. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the host
N
Y
Y

vmName
string
Name of the virtual machine if the host is running on a virtual machine
N
Y
Y

usedCredentialID
long
ID for identifying authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

groupIDs
long[]
ID for identifying the assigned consumer
N
N
N

groupNames
string[]
Name of the assigned consumer
N
N
N

gradeNames
string[]
Name of the grade of the consumer assigned to the host
N
N
N

gradeOrders
integer[]
Priority of the grade of the consumer assigned to the host
N
N
N

deviceClassificationLabel
string
Name of the classification label assigned to the host
N
N
N

accessPointType
enum
Type of authentication information used for detection. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

WMI

SSH

SNMP

N
N
N

accessPointSnmpVersion
enum
SNMP version of credential. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
N
N
N

accessPointIpAddress
string
IP address used for connections to monitoring targets
N
N
N

accessPointUser
string
User ID used for connections to monitoring targets
N
N
N

pluginId
string
ID for the plug-in applied to the host
N
Y
Y

creatorType
enum
The type of creator that added the host as a monitoring target. This member is enabled only if osType is UNKNOWN. For details about the specifiable values, see the table NodeCreatorType in 1.6 List of enumerators.
N
Y(only to eq, ne, in, not in)
N

(Legend) Y: Applicable, N: Not applicable

1.3.28 Members of a datastore

This section explains the Members of a datastore (Datastore resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
instanceID
ID of the datastore
N
Y
Y

name
string
Name of the datastore
N
Y
Y

status
enum
Status of the datastore. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the datastore. For details about the specifiable values, see the table ComponentMonitorType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Description of the datastore
N
N
N

datastoreUrl
string
URL of the datastore defined in monitoring targets or management software
N
Y
Y

identificationNumber
string
Identification Number of the datastore defined in monitoring targets or management software
N
Y
Y

clusterName
string
Name of the cluster that the datastore belongs to
N
Y
Y

collectorID
long
ID for identifying a collector used for detection
N
N
N

collectorName
string
Name of a collector used for detection
N
N
N

autoCollectionType
enum
Settings for periodic execution of the collector. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

usedCredentialID
long
Name of authentication information used for detection
N
N
N

usedCredentials
string
Name for authentication information used for detection
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

SNMP

VCENTER

N
N
N

accessPointSnmpVersion
enum
SNMP version of credential. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.29 Members of an IP Switch

This section explains the Members of an IP Switch (IPSwitches resource).

Member name
Data type
Description
Whether to change
Application to filter conditions ($query)
Application to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
IP Switch name
N
Y
Y

ipAddress
string
IP address of the IP Switch
N
N
N

status
enum
Status of the IP Switch. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the IP Switch. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the IP Switch
N
Y
Y

usedCredentialID
long
ID for identifying authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

accessPointType
enum
Type of authentication information used for detection. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

SNMP

N
N
N

accessPointSnmpVersion
enum
Version of SNMP used for detection. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
N
N
N

accessPointIpAddress
string
IP address used for connections to monitoring targets
N
N
N

accessPointUser
string
User ID used for connections to monitoring targets
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.30 Members of an FC Switch

This section explains the Members of an FC Switch (FCSwitches resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
FC Switch name
N
Y
Y

ipAddress
string
IP address of the FC Switch
N
N
N

status
enum
Status of the FC Switch. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the FC Switch. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the FC Switch
N
Y
Y

usedCredentialID
long
ID for identifying authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

wwn
string
WWN assigned to the FC Switch
N
Y
Y

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

accessPointType
enum
Type of authentication information used for detection. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

WBEM

SNMP

N
N
N

accessPointIpAddress
string
IP address used for connections to monitoring targets
N
N
N

accessPointUser
string
User ID used for connections to monitoring targets
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.31 Members of a storage system

This section explains the Members of a storage system (StorageSystems resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

name
string
Storage system name
N
Y
Y

ipAddress
string
IP address of the storage system
N
N
N

status
enum
Status of the storage system. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the storage system. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

description
string
Detailed information about the storage system
N
Y
Y

usedCredentialID
long
ID for authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

accessPointType
enum
Type of authentication information used for detection. For details about the specifiable values, see the table ProtocolType in 1.6 List of enumerators.

The specifiable values are as follows:

WBEM

SNMP

N
N
N

accessPointSnmpVersion
enum
SNMP version of credential. For details about the specifiable values, see the table SnmpVersion in 1.6 List of enumerators.
N
N
N

accessPointIpAddress
string
IP address used for connections to monitoring targets
N
N
N

accessPointUser
string
User ID used for connections to monitoring targets
N
N
N

pluginId
string
ID for the plug-in applied to the storage system
N
Y
Y

(Legend) Y: Applicable, N: Not applicable

1.3.32 Members of a volume

This section explains the Members of a volume (Volumes resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID for identifying instances
N
Y
Y

status
enum
Status of the volume. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.

The specifiable values are as follows:

Normal

Warning

Error

Unreachable

Unknown

N
Y (only to eq, ne, in, not in)
N

ldev
string
LDEV name of the volume
N
Y
Y

storageSubsystemID
long
ID for identifying the storage system to which the volume belongs
N
N
N

storageSubsystem
string
Name of the storage system to which the volume belongs
N
N
N

storageSubsystemMonitorStatus
enum
Monitoring status of the storage system to which the volume belongs. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

thresholdProfileID
long
ID for identifying the assigned profile
N
N
N

thresholdProfileName
string
Name of the assigned profile
N
N
N

originalThresholdProfileID
string
ID for identifying the original profile of the assigned profile
N
N
N

groupIDs
long[]
ID for identifying the assigned consumer
N
N
N

groupNames
string[]
Name of the assigned consumer
N
N
N

gradeNames
string[]
Name of the grade of the consumer assigned to the volume
N
N
N

gradeOrders
integer[]
Priority of the grade of the consumer assigned to the volume
N
N
N

(Legend) Y: Applicable, N: Not applicable

1.3.33 Members of a Service Resource

This section explains the Members of a Service Resource (ServiceResource resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID of the service resource
N
Y
Y

name
string
Name of the service resource
N
Y
Y

status
enum
Status of the service resource. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the service resource. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

serviceType
enum
Type of the service resource. For details about the specifiable values, see the table PluginServiceType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

region
string
Region of the service resource
N
Y
Y

zone
string
Zone of the service resource
N
Y
Y

serviceDetailType
string
Detailed type of the service resource
N
Y
Y

description
string
Description of the service resource
N
N
N

collectorID
long
ID for identifying a collector used for detection
N
N
N

collectorName
string
Name of a collector used for detection
N
N
N

autoCollectionType
enum
Type of a collector used for detection. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

usedCredentialID
long
ID for authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

HTTP

N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

accessTargetIdentification
string
Access-target identification key used for connections to monitoring targets or management software
N
N
N

pluginId
string
ID for the plug-in applied to the service resource
N
Y
Y

pluginName
string
Name for the plug-in applied to the service resource
N
Y
Y

(Legend) Y: Applicable, N: Not applicable

1.3.34 Members of a Service Instance

This section explains the Members of a Service Instance (ServiceInstance resource).

Member name
Data type
Description
Whether to change
Whether applicable to filter conditions ($query)
Whether applicable to sort conditions ($order-by)

instanceID
long
ID of the service instance
N
Y
Y

name
string
name of the service instance
N
Y
Y

status
enum
Status of the service instance. For details about the specifiable values, see the table NodeStatusType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

monitorStatus
enum
Monitoring status of the service instance. For details about the specifiable values, see the table ComponentMonitorType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

serviceType
enum
Type of the service resource that the service instance belongs to. For details about the specifiable values, see the table PluginServiceType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

region
string
Region of the service resource that the service instance belongs to
N
Y
Y

zone
string
Zone of the service resource that the service instance belongs to
N
Y
Y

serviceID
long
ID of the service resource that the service instance belongs to
N
Y
Y

serviceName
string
Name of the service resource that the service instance belongs to
N
Y
Y

serviceMonitorStatus
enum
Monitor status of the service resource that the service instance belongs to. For details about the specifiable values, see the table ManagementLevelType in 1.6 List of enumerators.
N
Y (only to eq, ne, in, not in)
N

serviceDetailType
string
Detailed type of the service instance
N
Y
Y

tag
string
Tag of the service instance
N
Y
Y

description
string
Description of the service instance
N
N
N

instanceIdentifier
string
Identifier of the service instance defined in monitoring targets or management software
N
N
N

groupIDs
long[]
ID of the consumer assigned to the service instance
N
N
N

groupNames
string[]
Name of the consumer assigned to the service instance
N
N
N

gradeNames
string[]
Name of the grade of the consumer assigned to the service instance
N
N
N

gradeOrders
integer[]
Priority of the grade of the consumer assigned to the service instance
N
N
N

collectorID
long
ID for identifying a collector used for detection
N
N
N

collectorName
string
Name of a collector used for detection
N
N
N

autoCollectionType
enum
Type of a collector used for detection. For details about the specifiable values, see the table ConnectType in 1.6 List of enumerators.
N
N
N

usedCredentialID
long
ID for authentication information used for detection
N
N
N

usedCredentials
string
Name of authentication information used for detection
N
N
N

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 1.6 List of enumerators.

The specifiable values are as follows:

HTTP

N
N
N

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

accessPointUser
string
User ID used for connections to monitoring targets or management software
N
N
N

accessTargetIdentification
string
Access-target identification key used for connections to monitoring targets or management software
N
N
N

pluginId
string
ID for the plug-in applied to the service instance
N
Y
Y

pluginName
string
Name for the plug-in applied to the service instance
N
Y
Y

(Legend) Y: Applicable, N: Not applicable

1.3.35 Members of an acquired list of resources

This section explains the Members of an acquired list of resources.

Member name | Data type | Description | Whether to change | Whether applicable to filter conditions ($query) | Whether applicable to sort conditions ($order-by)
data | object[] | The list of acquired resources is set. | N | N | N
page | integer | page (page number) specified in the request | N | N | N
pageSize | integer | pageSize (maximum number of objects that can be contained in a page) specified in the request | N | N | N
numPages | integer | Total number of pages (page number) | N | N | N
totalCount | integer | Total number of returned resources | N | N | N
count | integer | Number of data items according to the query parameter condition | N | N | N

(Legend) Y: Applicable, N: Not applicable

1.4 Resources managed through the API

JP1/OA supports the following API resources:

Resource

Domain

Applications

objects

Clusters

objects

Collectors

objects

ContainerClusters

objects

ContainerNodes

objects

ContainerNodes

services

Credentials

objects

Datastores

objects

Datastores

services

Discoveries

services

DiscoveryLogResources

objects

DiscoveryLogs

objects

E2EView

services

Events

services

FCSwitches

objects

FCSwitches

services

Grades

objects

Groups

objects

Hosts

objects

Hosts

services

Hypervisors

objects

Hypervisors

services

IPSwitches

objects

IPSwitches

services

IpAddrRanges

objects

MonitoringIntervalSettings

objects

PerfComponents

services

Plugins

objects

Pods

objects

Pods

services

ServiceInstances

objects

ServiceInstances

services

ServiceResources

objects

ServiceResources

services

StorageSystems

objects

StorageSystems

services

SystemThresholdProfiles

objects

UserCustomSettings

objects

UserCustomSettings

services

UserThresholdProfiles

objects

VirtualMachines

objects

VirtualMachines

services

Volumes

objects

version

configuration

1.5 API request list

The JP1/OA API supports the following requests and HTTP methods:

Applications(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Application List

GET

/v1/objects/Applications

Admin, Modify

Clusters(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Cluster List

GET

/v1/objects/Clusters

Admin, Modify

Collectors(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Collector List

GET

/v1/objects/Collectors

Admin, Modify

Creating Collector

POST

/v1/objects/Collectors

Admin

Obtaining Collector Information

GET

/v1/objects/Collectors/{id}

Admin, Modify

Updating Collector

PUT

/v1/objects/Collectors/{id}

Admin

Deleting Collector

DELETE

/v1/objects/Collectors/{id}

Admin

ContainerClusters(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Container Cluster List

GET

/v1/objects/ContainerClusters

Modify

ContainerNodes(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Container Node List

GET

/v1/objects/ContainerNodes

Admin, Modify

ContainerNodes(Domain : services)

Request

Method

URI

Execution permission

Obtaining Container Node Operation List

GET

/v1/services/ContainerNodes/actions

Admin, Modify

Obtaining Container Node Monitoring Status Change Information

GET

/v1/services/ContainerNodes/actions/changeManagedType

Admin, Modify

Changing Container Node Monitoring Status

POST

/v1/services/ContainerNodes/actions/changeManagedType/invoke

Admin, Modify

Credentials(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Authentication

GET

/v1/objects/Credentials

Admin

Creating Authentication

POST

/v1/objects/Credentials

Admin

Obtaining Authentication Information

GET

/v1/objects/Credentials/{id}

Admin

Updating Authentication

PUT

/v1/objects/Credentials/{id}

Admin

Deleting Authentication

DELETE

/v1/objects/Credentials/{id}

Admin

Datastores(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Datastore List

GET

/v1/objects/Datastores

Admin, Modify

Datastores(Domain : services)

Request

Method

URI

Execution permission

Obtaining Datastore Operation List

GET

/v1/services/Datastores/actions

Admin, Modify

Obtaining Datastore Monitoring Status Change Information

GET

/v1/services/Datastores/actions/changeManagedType

Admin, Modify

Changing Datastore Monitoring Status

POST

/v1/services/Datastores/actions/changeManagedType/invoke

Admin, Modify

Discoveries(Domain : services)

Request

Method

URI

Execution permission

Obtaining Discovery Operation List

GET

/v1/services/Discoveries/actions

Admin

Obtaining the Information Necessary To Run a Discovery

GET

/v1/services/Discoveries/actions/submit

Admin

Running a Discovery

POST

/v1/services/Discoveries/actions/submit/invoke

Admin

Obtaining the Information Necessary To Stop a Discovery

GET

/v1/services/Discoveries/actions/stop

Admin

Stopping a Discovery

POST

/v1/services/Discoveries/actions/stop/invoke

Admin

DiscoveryLogResources(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Information about Discovered Resources

GET

/v1/objects/DiscoveryLogResources

Modify

DiscoveryLogs(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Discovery History

GET

/v1/objects/DiscoveryLogs

Modify

E2EView(Domain : services)

Request

Method

URI

Execution permission

Collecting the information required to collect, into a CSV file, information about specified resources or a list of related resources

GET

/v1/services/E2EView/actions/getNodesDataCSV

Admin, Modify

Collecting, into a CSV file, information about specified resources or a list of related resources

POST

/v1/services/E2EView/actions/getNodesDataCSV/invoke

Admin, Modify

Events(Domain : services)

Request

Method

URI

Execution permission

Collecting the information required to collect, into a CSV file, a list of events

GET

/v1/services/Events/actions/getEventDataCSV

Admin, Modify

Collecting, into a CSV file, a list of events

POST

/v1/services/Events/actions/getEventDataCSV/invoke

Admin, Modify

FCSwitches(Domain : objects)

Request

Method

URI

Execution permission

Obtaining FC Switch List

GET

/v1/objects/FCSwitches

Admin, Modify

FCSwitches(Domain : services)

Request

Method

URI

Execution permission

Obtaining FC Switch Operation List

GET

/v1/services/FCSwitches/actions

Admin, Modify

Obtaining FC Switch Monitoring Status Change Information

GET

/v1/services/FCSwitches/actions/changeManagedType

Admin, Modify

Changing FC Switch Monitoring Status

POST

/v1/services/FCSwitches/actions/changeManagedType/invoke

Admin, Modify

Grades(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Grade List

GET

/v1/objects/Grades

Admin, Modify

Groups(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Consumer List

GET

/v1/objects/Groups

Admin, Modify

Creating consumer

POST

/v1/objects/Groups

Admin, Modify

Getting specific consumer information

GET

/v1/objects/Groups/{id}

Admin, Modify

Updating consumer

PUT

/v1/objects/Groups/{id}

Admin, Modify

Deleting specific consumer

DELETE

/v1/objects/Groups/{id}

Admin, Modify

Obtaining Consumer Operation List

GET

/v1/objects/Groups/{id}/actions

Admin, Modify

Obtaining Consumer Allocation Information

GET

/v1/objects/Groups/{id}/actions/updateTargetResource

Admin, Modify

Allocating Consumer

POST

/v1/objects/Groups/{id}/actions/updateTargetResource/invoke

Admin, Modify

Obtaining Consumer Allocation Information with a Specified Resource Allocation Category

GET

/v1/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType

Admin, Modify

Allocating Consumers that Have a Resource Allocation Category Specified

POST

/v1/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType/invoke

Admin, Modify

Hosts(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Host List

GET

/v1/objects/Hosts

Admin, Modify

Hosts(Domain : services)

Request

Method

URI

Execution permission

Obtaining Host Operation List

GET

/v1/services/Hosts/actions

Admin, Modify

Obtaining Host Monitoring Status Change Information

GET

/v1/services/Hosts/actions/changeManagedType

Admin, Modify

Changing Host Monitoring Status

POST

/v1/services/Hosts/actions/changeManagedType/invoke

Admin, Modify

Hypervisors(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Hypervisor List

GET

/v1/objects/Hypervisors

Admin, Modify

Hypervisors(Domain : services)

Request

Method

URI

Execution permission

Obtaining Hypervisor Operation List

GET

/v1/services/Hypervisors/actions

Admin, Modify

Obtaining Hypervisor Monitoring Status Change Information

GET

/v1/services/Hypervisors/actions/changeManagedType

Admin, Modify

Changing Hypervisor Monitoring Status

POST

/v1/services/Hypervisors/actions/changeManagedType/invoke

Admin, Modify

IPSwitches(Domain : objects)

Request

Method

URI

Execution permission

Obtaining IP Switch List

GET

/v1/objects/IPSwitches

Admin, Modify

IPSwitches(Domain : services)

Request

Method

URI

Execution permission

Obtaining IP Switch Operation List

GET

/v1/services/IPSwitches/actions

Admin, Modify

Obtaining IP Switch Monitoring Status Change Information

GET

/v1/services/IPSwitches/actions/changeManagedType

Admin, Modify

Changing IP Switch Monitoring Status

POST

/v1/services/IPSwitches/actions/changeManagedType/invoke

Admin, Modify

IpAddrRanges(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Retrieval Ranges

GET

/v1/objects/IpAddrRanges

Admin

Creating Retrieval Ranges

POST

/v1/objects/IpAddrRanges

Admin

Obtaining Retrieval Range Information

GET

/v1/objects/IpAddrRanges/{id}

Admin

Updating Retrieval Ranges

PUT

/v1/objects/IpAddrRanges/{id}

Admin

Deleting Retrieval Ranges

DELETE

/v1/objects/IpAddrRanges/{id}

Admin

MonitoringIntervalSettings(Domain : objects)

Request

Method

URI

Execution permission

Getting monitoring interval information

GET

/v1/objects/MonitoringIntervalSettings

Admin

Updating monitoring interval

PUT

/v1/objects/MonitoringIntervalSettings/1

Admin

PerfComponents(Domain : services)

Request

Method

URI

Execution permission

Collecting the information required to collect, into a CSV file, the performance values in a time series of specified performance information

GET

/v1/services/PerfComponents/actions/getGraphDataCSV

Admin, Modify

Collecting, into a CSV file, the performance values in a time series of specified performance information

POST

/v1/services/PerfComponents/actions/getGraphDataCSV/invoke

Admin, Modify

Collecting the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds

GET

/v1/services/PerfComponents/actions/getNodesGraphDataCSV

Admin, Modify

Collecting, into a CSV file, the latest value in the performance information that a specified resource holds

POST

/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

Admin, Modify

Plugins(Domain : objects)

Request

Method

URI

Execution permission

Obtaining a List of Plug-in Information

GET

/v1/objects/Plugins

Admin

Obtaining Plug-in Information

GET

/v1/objects/Plugins/{id}

Admin

Pods(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Pod List

GET

/v1/objects/Pods

Admin, Modify

Pods(Domain : services)

Request

Method

URI

Execution permission

Obtaining Pod Operation List

GET

/v1/services/Pods/actions

Admin, Modify

Obtaining Pod Monitoring Status Change Information

GET

/v1/services/Pods/actions/changeManagedType

Admin, Modify

Changing Pod Monitoring Status

POST

/v1/services/Pods/actions/changeManagedType/invoke

Admin, Modify

ServiceInstances(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Service Instance List

GET

/v1/objects/ServiceInstances

Admin, Modify

ServiceInstances(Domain : services)

Request

Method

URI

Execution permission

Obtaining Service Instance Operation List

GET

/v1/services/ServiceInstances/actions

Admin, Modify

Obtaining Service Instance Monitoring Status Change Information

GET

/v1/services/ServiceInstances/actions/changeManagedType

Admin, Modify

Changing Service Instance Monitoring Status

POST

/v1/services/ServiceInstances/actions/changeManagedType/invoke

Admin, Modify

ServiceResources(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Service Resource List

GET

/v1/objects/ServiceResources

Admin, Modify

ServiceResources(Domain : services)

Request

Method

URI

Execution permission

Obtaining Service Resource Operation List

GET

/v1/services/ServiceResources/actions

Admin, Modify

Obtaining Service Resource Monitoring Status Change Information

GET

/v1/services/ServiceResources/actions/changeManagedType

Admin, Modify

Changing Service Resource Monitoring Status

POST

/v1/services/ServiceResources/actions/changeManagedType/invoke

Admin, Modify

StorageSystems(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Storage System List

GET

/v1/objects/StorageSystems

Admin, Modify

StorageSystems(Domain : services)

Request

Method

URI

Execution permission

Obtaining Storage System Operation List

GET

/v1/services/StorageSystems/actions

Admin, Modify

Obtaining Storage System Monitoring Status Change Information

GET

/v1/services/StorageSystems/actions/changeManagedType

Admin, Modify

Changing Storage System Monitoring Status

POST

/v1/services/StorageSystems/actions/changeManagedType/invoke

Admin, Modify

SystemThresholdProfiles(Domain : objects)

Request

Method

URI

Execution permission

Obtaining System Profile List

GET

/v1/objects/SystemThresholdProfiles

Admin, Modify

Creating System Profile

POST

/v1/objects/SystemThresholdProfiles

Admin, Modify

Obtaining System Profile Information

GET

/v1/objects/SystemThresholdProfiles/{id}

Admin, Modify

Updating System Profile

PUT

/v1/objects/SystemThresholdProfiles/{id}

Admin, Modify

Delete System Profiles

DELETE

/v1/objects/SystemThresholdProfiles/{id}

Admin, Modify

Obtaining System Profile Operation List

GET

/v1/objects/SystemThresholdProfiles/{id}/actions

Admin, Modify

Obtaining System Profile Allocation Information

GET

/v1/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource

Admin, Modify

Allocating System Profile

POST

/v1/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource/invoke

Admin, Modify

UserCustomSettings(Domain : objects)

Request

Method

URI

Execution permission

Acquiring a List of Custom Settings of a User

GET

/v1/objects/UserCustomSettings

Admin, Modify, User Management

Specifying Settings for a User

POST

/v1/objects/UserCustomSettings

Admin, Modify, User Management

UserCustomSettings(Domain : services)

Request

Method

URI

Execution permission

Acquiring a List of Operations for the Custom Settings of a User

GET

/v1/services/UserCustomSettings/actions

User Management

Collecting Information Necessary for Deleting the Custom Settings of a User

GET

/v1/services/UserCustomSettings/actions/clearUserCustomSetting

User Management

Deleting the Custom Settings of a User

POST

/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke

User Management

UserThresholdProfiles(Domain : objects)

Request

Method

URI

Execution permission

Obtaining User Profile List

GET

/v1/objects/UserThresholdProfiles

Admin, Modify

Creating User Profile

POST

/v1/objects/UserThresholdProfiles

Admin, Modify

Obtaining User Profile Information

GET

/v1/objects/UserThresholdProfiles/{id}

Admin, Modify

Updating User Profile

PUT

/v1/objects/UserThresholdProfiles/{id}

Admin, Modify

Delete User Profiles

DELETE

/v1/objects/UserThresholdProfiles/{id}

Admin, Modify

Obtaining User Profile Operation

GET

/v1/objects/UserThresholdProfiles/{id}/actions

Admin, Modify

Obtaining User Profile Allocation Information

GET

/v1/objects/UserThresholdProfiles/{id}/actions/updateTargetResource

Admin, Modify

Allocating User Profile

POST

/v1/objects/UserThresholdProfiles/{id}/actions/updateTargetResource/invoke

Admin, Modify

VirtualMachines(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Virtual Machine List

GET

/v1/objects/VirtualMachines

Admin, Modify

VirtualMachines(Domain : services)

Request

Method

URI

Execution permission

Obtaining Virtual Machine Operation List

GET

/v1/services/VirtualMachines/actions

Admin, Modify

Obtaining Virtual Machine Monitoring Status Change Information

GET

/v1/services/VirtualMachines/actions/changeManagedType

Admin, Modify

Changing Virtual Machine Monitoring Status

POST

/v1/services/VirtualMachines/actions/changeManagedType/invoke

Admin, Modify

Volumes(Domain : objects)

Request

Method

URI

Execution permission

Obtaining Volume List

GET

/v1/objects/Volumes

Admin, Modify

version(Domain : configuration)

Request

Method

URI

Execution permission

Obtaining Version Information

GET

/v1/configuration/version

Admin, Modify

1.6 List of enumerators

The following tables list the enumerators that can be specified for API functions.

ProtocolType

enumerator

Description

WMI

WMI is used

SSH

SSH is used

WBEM

SMI-S WBEM is used

SNMP

SNMP is used

VCENTER

The management software is vCenter

AJS

The management software is JP1/AJS3 - Manager

PFM

The management software is JP1/PFM - Manager

IM

The management software is JP1/IM - Manager

CUSTOM

The management software is custom application

HTTP

HTTP is used

ArgusNodeType

enumerator

Description

NA

Invalid value

UNKNOWN

Unknown

ANY

Any

SERVER_WINDOWS

Windows server

SERVER_LINUX

Linux server

SERVER_ESX

ESX server

SWITCH_FC

FC switch

SWITCH_IP

IP switch

STORAGE_HITACHI

Hitachi storage

STORAGE_OTHER

Non-Hitachi storage systems

GENERIC_COMPUTER

Host defined by plug-in

GENERIC_STORAGE

StorageSystem defined by plug-in

SERVER_SOLARIS

Solaris server

SERVER_HYPERV

Hyper-V server

SERVER_HPUX

HP-UX server

SERVER_VCENTER

vCenter server

SERVER_AIX

AIX server

GENERIC_HYPERVISOR

Hypervisor defined by plug-in

ManagementLevelType

enumerator

Description

New

Newly detected

Manage

Being monitored

ignore

Not monitored

MonitorOff

Monitoring is temporarily stopped

MonitoringOperationType

enumerator

Description

Monitor

Monitoring is start

Ignore

Monitoring is temporarily stopped

ComponentMonitorType

enumerator

Description

InUse

Resource is currently being monitored for performance.

NotMonitored

Resource is not monitored.

DiscoveryStatusType

enumerator

Description

Running

Running

Completed

Completed

Canceled

Canceled

Unexecuted

Unexecuted

Error

Error

ConnectStatusType

enumerator

Description

NoConnect

Not Collected

Waiting

Waiting

InProgress

Currently being executed

Succeeded

Collector Successful

Failed

Collector Failed

ScheduleCycleType

enumerator

Description

Minutely

Every minute

Hourly

Every hour

Daily

Every day

Weekly

Every week

MonthlyWeek

Every month (week)

MonthlyDay

Every month (day)

SnmpVersion

enumerator

Description

V1_V2C

SNMP v1 or v2

V3

SNMP v3

AuthenticationProtocol

enumerator

Description

MD5

MD5 is used

SHA1

SHA1 is used

PrivacyProtocol

enumerator

Description

DES

DES is used

AES128

AES128 is used

ConnectType

enumerator

Description

AutoConnect

Collector is periodically executed

NotAutoConnect

Collector is not periodically executed

HypertextTransferProtocolType

enumerator

Description

HTTP

HTTP is used

HTTPS

HTTPS is used

NodeInformationGettableLevel

enumerator

Description

OK

Basic information was acquired.

ProtocolUnrecognizedError

A protocol-recognition failure error occurred. The information could not be acquired under the conditions set in the discovery criteria.

AuthenticationError

Authentication error. The protocol was identified, but the specified account cannot be used to log in.

UnauthorizedRoleError

An insufficient-privileges error occurred. The user logged in but could not acquire information because the user lacked the required privileges.

OtherError

Other error. The information could not be acquired because of an error other than the above.

ClusterIPAddressNotSupported

Virtual IP address. This cannot be managed because it is a virtual IP address in a cluster environment.

NoResponse

This is an IP address for which a node could not be discovered, because there was no response in the Ping results.

UnsupportDeviceError

The device is not supported.

UnexpectedDeviceError

Failed to acquire information. This indicates that information could not be acquired because of a device problem.

TimeoutError

A timeout occurred during information acquisition.

RequestTooMuchError

Failed to acquire information because of an excessive number of requests. Information could not be acquired because there were too many connection requests by the same protocol.

DiscoveryLogCategory

enumerator

Description

DiscoveredResources

Discovered Resources

NoResponse

No Response

Failed

Failed

Skipped

Skipped

TemplateCreatorType

enumerator

Description

User

User Definition

Default

Default

ComponentType

enumerator

Description

VIRTUAL_MACHINE

Virtual machine

HYPERVISOR_CLUSTER

Cluster

GENERIC_VIRTUALMACHINE

Virtual machine defined by plug-in

GENERIC_HYPERVISOR_CLUSTER

Cluster defined by plug-in

NodeStatusType

enumerator

Description

Normal

Node status is Normal.

Warning

Node status is Warning.

Error

Node status is Critical.

Unreachable

No response

Unknown

Node status is Unknown.

NotMonitored

Node status is not monitored.

E2ENodeType

enumerator

Description

TAG

Consumer

CLUSTER

Cluster

HYPERVISOR

Hypervisor

VM_HOST

Virtual machine or host

VIRTUAL_MACHINE

Virtual machine

CPU

CPU

MEMORY

Memory

NIC

NIC

HBA

HBA

DISK

Disk

HOST

Host

SWITCH

Switch

FC_ZONE

Zone

FC_SWITCH

FC switch

IP_SWITCH

IP switch

STORAGE

Storage

STORAGE_VOLUME

Volume

STORAGE_PORT

Port

STORAGE_MP

Processor

STORAGE_CACHE

Cache

STORAGE_POOL

Pool

STORAGE_PG

Parity Group

APPLICATION

Application

APPLICATION_AJS_MANAGER

AJS-Manager

APPLICATION_AJS_AGENT

AJS-Agent

APPLICATION_PFM

PFM

APPLICATION_OS

OS

APPLICATION_CUSTOM

Custom Application

CONTAINER_CLUSTER

Container Cluster

CONTAINER_NODE

Container Node

CONTAINER_POD

Container Pod

COMPUTING_SERVICE

Computing Service

COMPUTING_INSTANCE

Computing Instance

NETWORKING_SERVICE

Networking Service

NETWORKING_INSTANCE

Networking Instance

STORAGE_SERVICE

Storage Service

STORAGE_INSTANCE

Storage Instance

DATASTORE

Datastore

FILE_SYSTEM

File system

CollectorOsType

enumerator

Description

Windows

OS type is Windows

Unix

OS type is Unix

AssignmentType

enumerator

Description

Occupy

Occupy

Share

Share

NoChange

No Change

ApplicationType

enumerator

Description

AJS_MANAGER

AJS(Manager)

AJS_AGENT

AJS(Agent)

PFM_SERVICERESPONSE

PFM(ServiceResponse)

PFM_AJS3

PFM(AJS3)

PFM_DOMINO

PFM(Domino)

PFM_EXCHANGE

PFM(Exchange)

PFM_SAPSYSTEM

PFM(SAP System)

PFM_IBMWEBSPHEREMQ

PFM(IBMWebSphereMQ)

PFM_OPENTP1

PFM(OpenTP1)

PFM_COSMINEXUS

PFM(Cosminexus)

PFM_IIS

PFM(IIS)

PFM_WEBLOGICSERVER

PFM(WebLogic Server)

PFM_WEBSPHEREAPPLICATIONSERVER

PFM(WebSphere Application Server)

PFM_DB2

PFM(DB2)

PFM_HIRDB

PFM(HiRDB)

PFM_SQL

PFM(SQL)

PFM_RMSQLSERVER

PFM(RM SQLServer)

PFM_ORACLE

PFM(Oracle)

PFM_RMORACLE

PFM(RM Oracle)

PFM_RMPLATFORM

PFM(RM Platform)

PFM_UNIX

PFM(UNIX)

PFM_WINDOWS

PFM(Windows)

IM_OS

IM(OS)

PFM_RMVIRTUALMACHINE

PFM(RM VirtualMachine)

PFM_VIRTUALMACHINE

PFM(VirtualMachine)

CUSTOM

Custom

ApplicationResourceType

enumerator

Description

VirtualMachine

Virtual Machine

Host

Host

Pod

Pod

ServiceInstance

Service Instance

NodeInformationType

enumerator

Description

AllInformation

Acquire basic information and related information

BasicInformation

Acquire Basic Information.Do not acquire related information.

PluginType

enumerator

Description

NODE_PLUGIN

Node Plug-in

NodeCreatorType

enumerator

Description

Discovery

Discovery

Trap

Trap

PluginServiceType

enumerator

Description

computing

Indicates that the service is computing

networking

Indicates that the service is networking

storage

Indicates that the service is storage

PluginStatusType

enumerator

Description

ACTIVE

Status of the plug-in is active.

INACTIVE

Status of the plug-in is inactive.

1.7 API description format

The items below provide descriptions for individual APIs. Note that some items might not be described for some APIs.

Function

Describes the function of an API.

Execution permissions

Indicates the permissions and roles that are required to execute an API.

API version

Indicates the version of an API.

Request format

Describes the request format for requesting the use of an API.

Status code

Describes the status code after you execute an API by using the HTTP or HTTPS protocol. For details about the status code when an error occurs before an API is executed, see 1.2.6 HTTP status codes description.

Response schema

Describes schema information of the response that is returned when an API is successfully completed.

Usage example

Provides examples of the request for the use of API, and its response.

Note that the HTTP protocol is used in the examples. If the HTTPS protocol is used, replace HTTP with HTTPS when you read the description.

1.8 Operating JP1/OA by using the API functions

This section explains how to operate JP1/OA by using the API functions. However, there are some items that are not explained depending on the API function.

1.8.1 Creating authentication information

This section describes the format of requests to be used for creating authentication information and the method for creating a request body.

Procedure

Determine the protocol (such as WMI or SSH) for the authentication information to be created.

Acquire authentication information that has the same protocol as the authentication information that you want to create, so that the acquired authentication information can be used as a template. Issue the request in the following format:

GET http://host:port/Analytics/version/objects/Credentials

Edit the authentication information (Credential resource) acquired in step 2 according to the table below.

Table 1‒1: Changes to the Credential resource

Member to change

Whether to change

Description

name

Required

Change the name to the name of the authentication information to be created.

You must specify a name that does not exist in the authentication information that is already registered.

userId

Required

The user ID to be specified for authentication. When the SNMP v3 protocol is used, the value specified for userName is set.

password

Required

The password to be used for authentication

passwordNotRequired

Optional

Specify true if no password is required for authentication. This item is enabled only when the WMI protocol is used.

portNumber

Optional

The port number to be used for authentication. This item is enabled only when the SSH, SMI-S WBEM, or SNMP protocol is used to connect the management target.

rootPassword

Required

The root password to be used for authentication. This item is enabled only when the SSH protocol is used.

ssl

Optional

Whether SSL (HTTPS) is to be used when connecting the monitoring target. This item is enabled only when SMI-S WBEM is used.

domainname

Optional

The domain name to be used for authentication. This item is enabled only when WMI is used.

namespace

Optional

The namespace to be used for authentication. This item is used only when SMI-S WBEM is used.

community

Optional

The community name to be used for authentication. This item is enabled only when SNMP is used.

snmpVersion

Optional

The version of SNMP. This item is enabled only when SNMP is used.

userName

Optional

The user name to be used for authentication. This item is enabled only when SNMP v3 is used.

authenticationEnabled

Optional

To perform an SMTP authentication, specify true. This item is enabled only when SNMP v3 is used.

authenticationPassphrase

Optional

The passphrase to be used for authentication. This item is enabled only when SNMP v3 is used.

authenticationProtocol

Optional

The protocol to be used for authentication. This item is enabled only when SNMP v3 is used.

privacyEnabled

Optional

To enable the privacy function for authentication, specify true. This item is enabled only when SNMP v3 is used.

privacyPassphrase

Optional

The passphrase to be specified when the privacy function is used for authentication. This item is enabled only when SNMP v3 is used.

privacyProtocol

Optional

This item is enabled only when SNMP v3 is used.

Issue the request in the format shown below. Specify the authentication information you edited in step 3 in the request body.

POST http://host:port/Analytics/version/objects/Credentials

Related topics

2.1.2 Obtaining Authentication Information

2.1.3 Creating Authentication

1.8.2 Creating a search range

This section describes the format of the request to be used for creating a search range and the method for creating a request body.

Procedure

Acquire a search range of your choice, so that the acquired search range can be used as a template. Issue the request in the following format:

GET http://host:port/Analytics/version/objects/IpAddrRanges

Edit the search range (the IpAddrRanges resource) that you acquired in step 1 according to the table below.

Table 1‒2: Changes to the IpAddrRanges resource

Member to change

Whether to change

Description

name

Required

Change the name to the name of the search range to be created.

You must specify a name that does not exist in the search range that is already registered.

ipAddrRange

Required

Specify the IP addresses of the range to search. You muse specify a range that does not exist in the search ranges that are already registered.

usePing

Optional

To use Ping in the search, specify true.

aliveMonitoring

Optional

If the search cannot be performed by using the authentication information that is specified at the time of the search, specify true to register, as alive-monitoring targets, resources for which a connection has been confirmed. This can be specified only when true is specified for usePing.

useAllCredential

Optional

To use all authentication information in the search, specify true.

selectedCredentials

Optional

Specify the authentication information that you want to use. For details on how to specify authentication information, see 1.8.1 Creating authentication information.

useAllPlugin

Optional

To use all plug-in information in the search, specify true.

selectedPlugins

Optional

Specify the plug-in information that you want to use. If you want to specify plug-in information, specify false for useAllPlugin.

deviceClassificationLabel

Optional

Specify the name of the classification label assigned to the device.

Issue the request in the following format. Specify the search range you edited in step 2 in the request body.

POST http://host:port/Analytics/version/objects/IpAddrRanges

Related topics

2.3.3 Creating Retrieval Ranges

2.3.2 Obtaining Retrieval Range Information

1.8.3 Creating a collector

This section describes the format of the request to be used for creating the collector and the method for creating a request body.

Procedure

Determine the type of collector (such as VCENTER or AJS) is to be created.

Acquire a collector that has the same type as the one that you want to create, so that the acquired collector can be used as a template. Issue a request in the following format:

GET http://host:port/Analytics/version/objects/Collectors

Edit the authentication information (Collectors resource, CollectorCredential resource) that you acquired in step 2 according to the table below.

Table 1‒3: Changes to the Collector resource

Member to change

Whether the change is required

Description

name

Required

Change the name to the name of the collector that you want to create.

You must specify a name that does not exist among the collectors that are already registered.

osType

Optional

Specify the type of the OS that is to be monitored.

collectorCredentials

Optional

Specify the authentication information that is used to connect to the target to be monitored. See the table below for the description.

Table 1‒4: Changes to the CollectorCredential resource

Member to change

Whether the change is required

Description

ipAddress

Optional

Specify the IP address or the host name that is used to connect to the management software.

userId

Optional

Specify the user ID that is used to connect to the management software.

password

Optional

Specify the password that is used to connect to the management software.

portNumber

Optional

Specify the port number that is used to connect to the management software.

hypertextTransferProtocolType

Optional

This item can be specified only when the collector type is VCENTER. Specify HTTPS.

domainName

Optional

This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify a domain name.

rootPassword

Optional

This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Unix. Specify the root password.

useAdministrativeShares

Optional

This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify true to use administrative shares. When true is specified, there is no need to specify shareName and sharedFolder.

shareName

Optional

This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify a shared name. This item is enabled only when useAdministrativeShares is false.

sharedFolder

Optional

This item can be specified only when the collector type is AJS, PFM, or IM, and when osType is Windows. Specify the path to the shared folder. This item is enabled only when false is specified for useAdministrativeShares.

Issue a request in the following format. In the request body, specify the collector that you edited in step 3.

POST http://host:port/Analytics/version/objects/Collectors

Related topics

2.5.2 Obtaining Collector Information

2.5.3 Creating Collector

1.8.4 Creating a user profile

This section describes the format of the request to be used for creating a user profile and the method for creating a request body.

Procedure

Determine the type (such as Virtual machine and Volume) for the resource that you want to create.

Acquire a user profile that has the same type as the one that you want to create, so that the acquired user profile can be used as a template. Issue a request in the following format:

GET http://host:port/Analytics/version/objects/UserThresholdProfiles

Edit the user profile (UserThresholdProfiles resource, UserThresholdValue resource) that you acquired in step 2 according to the table below:

Table 1‒5: Changes to the UserThresholdProfiles resource

Member to change

Whether the change is required

Description

name

Required

Change the name to the user profile that you want to create.

You must specify a name that does not exist in the user profile or in the system profile that is already registered.

description

Optional

Enter the description of the user profile that you want to create.

profileType

Required

Specify User.

thresholdValues

Optional

Change the threshold value or the monitoring status. Note that when creating a user profile, you must not delete any values that were acquired, because setting of all UserThresholdValue is required even if no changes are made. For the locations to be changed, see the table below.

Table 1‒6: Changes to the UserThresholdValue resource

Member to change

Whether the change is required

Description

monitoring

Required

Specify whether to monitor.

thresholdValueOfWarning

Optional

Specify the threshold value for a warning. You must specify a value equal to or less than the maximum member, and a value equal to or greater than the minimum member. In addition, the value must be a multiple of the stepSize member. If you specify a value that does not meet the above conditions, the value will be adjusted automatically.

thresholdValueOfError

Optional

Specify the threshold value for an error. You must specify a value equal to or less than the maximum member, and a value equal to or greater than the minimum member. In addition, the value must be a multiple of the stepSize member. If you specify a value that does not meet the above conditions, the value will be adjusted automatically.

Issue a request in the following format. In the request body, specify the collector that you edited in step 3.

POST http://host:port/Analytics/version/objects/UserThresholdProfiles

Related topics

2.8.2 Obtaining User Profile Information

2.8.3 Creating User Profile

1.8.5 Creating a system profile

This section describes the format of the request to be used for creating a system profile and the method for creating a request body.

Procedure

Determine the type of resource (such as ESX and IP Switch) that you want to create.

Acquire a system profile that has the same type as the one that you want to create, so that the acquired system profile can be used as a template. Issue a request in the following format:

GET http://host:port/Analytics/version/objects/SystemThresholdProfiles

Edit the system profile (SystemThresholdProfiles resource, SystemThresholdValue resource) that you acquired in step 2 according to the table below.

Table 1‒7: Changes to the SystemThresholdProfiles resource

Member to change

Whether the change is required

Description

name

Required

Change the name to the name of the system profile that you want to create.

You must specify a name that does not exist in the user profile or in the system profile that is already registered.

description

Optional

Enter a description of the system profile that you want to create.

profileType

Required

Specify User.

thresholdValues

Optional

Change the threshold value or the monitoring status. Note that when creating a system profile, do not delete any values that were acquired because setting of all SystemThresholdValue is required even if there are no changes made. For the locations to be changed, see the table below.

Table 1‒8: Changes to the SystemThresholdValue resource

Member to change

Whether the change is required

Description

monitoring

Required

Specify whether to monitor.

thresholdValueOfWarning

Optional

Specify the threshold value for the warning. You must specify a value equal to or less than the maximum member, and a value equal to or greater than the minimum member. In addition, the value must be a multiple of the value of stepSize. If you specify a value that does not meet the above conditions, the value will be adjusted automatically.

thresholdValueOfError

Optional

Specify the threshold value for an error. You must specify a value equal to or less than the maximum member, and a value equal to or greater than the minimum member. In addition, the value must be a multiple of the value of stepSize. If you specify a value that does not meet the above conditions, the value will be adjusted automatically.

Issue a request in the following format. In the request body, specify the collector that you edited in step 3.

POST http://host:port/Analytics/version/objects/SystemThresholdProfiles

Related topics

2.9.2 Obtaining System Profile Information

2.9.3 Creating System Profile

1.8.6 Creating a consumer

This section describes the format of the request to be used for creating a consumer and the method for creating a request body.

Procedure

Acquire a consumer to use as a template. Issue a request in the following format:

GET http://host:port/Analytics/version/objects/Groups

Edit the consumer (Groups resource) that you acquired in step 1 according to the table below.

Table 1‒9: Changes to the Groups resource

Member to change

Whether the change is required

Description

name

Required

Change the name to the name of the consumer that you want to create.

You must specify a name that is not already registered.

description

Optional

Enter a description of the consumer.

templateCreatorType

Required

Specify User.

gradeKey

Required

Specify the ID to identify the grade. To acquire the ID to identify the grade, see 2.10.3 Obtaining Grade List.

urls

Optional

The URL that can be specified for the consumer.

vmAutoAssignment

Optional

Specify whether to automatically assign, to the consumer, virtual machines on a hypervisor when that hypervisor is assigned to the consumer. To assign virtual machines on a hypervisor, specify true. If nothing is specified, false is assumed.

applicationAssignFollow

Optional

Specify whether to automatically assign, to the consumer, any applications on a virtual machine or virtual host when that virtual machine or virtual host is assigned to the consumer. To assign applications on a virtual machine or virtual host, specify true. If nothing is specified, false is assumed.

Issue a request in the following format. In the request body, specify the consumer you edited in step 2.

POST http://host:port/Analytics/version/objects/Groups

Related topics

2.10.2 Getting specific consumer information

2.10.4 Creating consumer

1.8.7 Assigning a user profile

This section describes the format of the request to be used for assigning resources (virtual machines, hosts, volumes) to a user profile and the contents to be specified in the request body.

Procedure

Issue a request in the following format:

POST http://host:port/Analytics/version/objects/UserThresholdProfiles/id/actions/updateTargetResource

The objects to be specified as members of parameters in the request body are as follows:

Member

Whether the change is required

Description

instanceID

Required

Specify the ID of the monitoring target to which the user profile is to be assigned as a list. You must include the IDs of monitoring targets that are already assigned.

Example specification when applying the user profile only to the monitoring target for instanceID=50:

"parameters" : [ { "instanceID" : 50 } ]

Example specification when adding the monitoring target for instance=51 to the user profile that is already assigned to the monitoring target for instanceID=50 (link and specify all IDs that are to be assigned):

"parameters" : [ { "instanceID" : 50 } , { "instanceID" : 51 } ]

Example specification when canceling assignment from all monitoring targets (use an empty value for parameters):

"parameters" : [ ]

The IDs of the monitoring target that can be specified as member of parameters that can be acquired from the API are indicated in the following references:

Resource type of the profile

Reference

Virtual machine

2.17.1 Obtaining Virtual Machine List

Windows or Linux/UNIX

2.18.1 Obtaining Host List

Volume

2.23.1 Obtaining Volume List

Related topics

2.8.7 Obtaining User Profile Allocation Information

2.8.8 Allocating User Profile

1.8.8 Assigning a system profile

This section describes the format of requests to be used when assigning resources (clusters, hypervisors, IP switches, and FC switches) to the system profile, and the contents to be specified in the request body.

Procedure

Issue a request in the following format:

POST http://host:port/Analytics/version/objects/SystemThresholdProfiles/id/actions/updateTargetResource

The objects to be specified as members of parameters in the request body are as follows:

Member

Whether to specify

Description

instanceID

Optional

Specify the ID of the monitoring target to which the system profile is to be assigned as a list. You must include the IDs of monitoring targets that are already assigned.

Example specification when applying the system profile only to the monitoring target for instanceID=50:

"parameters" : [ { "instanceID" : 50 } ]

Example specification when adding the monitoring target for instanceID=51 to the system profile that is already assigned to the monitoring target for instanceID=50 (link and specify all IDs that are to be assigned):

"parameters" : [ { "instanceID" : 50 } , { "instanceID" : 51 } ]

Example specification when canceling assignment of all monitoring targets (use an empty value for parameters):

"parameters" : [ ]

The IDs of the monitoring targets that can be specified as members of parameters can be acquired from the API functions indicated in the following reference:

Resource type of the profile

Reference

Clutser
2.15.1 Obtaining Cluster List

ESX, Hyper-V or Hypervisor

2.16.1 Obtaining Hypervisor List

IP Switch

2.20.1 Obtaining IP Switch List

FC Switch

2.21.1 Obtaining FC Switch List

Related topics

2.9.7 Obtaining System Profile Allocation Information

2.9.8 Allocating System Profile

1.8.9 Acquiring event information in CSV format

This section explains the format of requests that are used to output event information in CSV format, and the contents to be specified for the request body.

Procedure

Issue a request in the following format:

POST http://host:port/Analytics/version/services/Events/actions/getEventDataCSV/invoke

The object to be specified as the member of parameters in the request body is as follows:

Table 1‒10: Members that can be specified when acquiring the CSV file for the event information

Member to change

Whether the change is required

Description

hqlFilter

Optional

Specify the formula if you want to filter the event to be acquired. Describe the formula in the order of parameter + operator + value. The values that can be specified for the formula are shown in the following table. You can combine expressions with AND or OR.

fqlSort

Optional

Specify this member to sort the events to be acquired.

page

Optional

Specify the number of pages to be acquired.

pageSize

Optional

Specify the number of items to be acquired for a single page.

Table 1‒11: Parameters that can be specified for hqlFilter

Parameters

Operators

Values

status

eq, ne

NOTACK, ACK

level

eq, ne

INFO, WARNING, CRITICAL

category

eq, ne

PERFORMANCE, STATUS,EVENT, SETTING, CHANGE

deviceName

eq, ne, starts, ends, contains

Any character string

deviceType

eq, ne

Server, Storage, NetworkDevice, Collector

componentName

eq, ne, starts, ends, contains

Any character string

componentType

eq, ne

CPU,MEMORY, LAN_PORT, FC_HBA_PORT, [DISK_DRIVE, SCSI_DISK_DRIVE], [STORAGE_CONTROLLER, STORAGE_MPB], STORAGE_FC_PORT, STORAGE_POOL, STORAGE_VOLUME, STORAGE_CACHE, VIRTUAL_MACHINE, HYPERVISOR_CLUSTER, STORAGE_DP_POOL

userName

eq, ne, starts, ends, contains

Any character string

Related topics

2.26.2 Collecting, into a CSV file, a list of events

1.8.10 Acquiring basic information and performance information for resources in CSV format

This section describes the formats of the requests to be used to output the following information in CSV format: basic information of the target resource, the latest performance information of each metric owned by the target resource, and performance information (in chronological order) of a specific metric owned by the target resource. This section also describes the contents to be specified in the request body.

Context

Acquire basic information and performance information for a resource step-by-step. The following is the acquisition procedure:

Use the API function for acquiring the list of resources to acquire the resource ID.

Use the API function for acquiring resource information in CSV format to acquire resource information. Specify the resource ID acquired in step 1 in the request body.

Use the API function for acquiring the latest resource performance information in CSV format to acquire the latest resource performance information. Specify the resource ID acquired in step 1 or step 2 in the request body.

Use the API function for acquiring metric performance information (in chronological order) in CSV format to acquire metric performance information (in chronological order). Specify the metric ID acquired in step 3 in the request body.

The following describes the acquisition procedure by using an example of acquiring the usage of CPU01, a resource of hypervisor 01.

Procedure

Acquire the list of hypervisors to acquire the ID of hypervisor 01, which owns CPU01. Issue the request in the following format:

GET http://host:port/Analytics/version/objects/Hypervisors

In the response body that is output as follows, confirm that the ID of hypervisor 01 is "4".

{
  "data" : [ {
    "instanceID" : 4,
    "name" : "hyperV",
    ...,
  }, ...
}

Specify the ID of hypervisor 01 in the request body to acquire information about hypervisor 01. Issue the request in the following format:

POST http://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV/invoke

The table below shows the objects to be specified as the members of the parameters in the request body.

Table 1‒12: Members to be specified when acquiring basic resource information

Member

Whether to specify

Description

basePointNodes

Required

For nodeID, specify "4", which is the ID acquired in step 1. For nodeType, specify the type of the node. For the values that can be specified as a node type, see the table for E2ENodeType in 1.6 List of enumerators.

getType

Required

To acquire basic information only, specify BasicInformation. To also acquire related information, specify AllInformation. To acquire information about the components, such as the CPU, memory, and NICs, specify AllInformation.

In the response body that is output as follows, confirm that the ID of CPU01 is "4".

{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2019-09-22T11:53:42.188+09:00",
  "updated" : "2019-09-22T11:53:42.354+09:00",
  "completed" : "2019-09-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","121000","UTF-8 (BOM)"\n"#Resource Information"\n...",...,ResourceID,ResourceName,ResourceType,...,cpu4,CPU01,CPU,...,vm1,VM001,VM,...
  } ]
}

Specify the ID of CPU01 in the request body to acquire the latest performance information for the resource. Issue the request in the following format:

POST http://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

The table below shows the objects to be specified as members of parameters in the request body.

Table 1‒13: Members to be specified when acquiring the latest resource performance information

Member

Whether to specify

Description

basePointNodes

Required

For nodeID, specify "4", which is the ID that was acquired in step 2. For nodeType, specify the type of the node. For the values can be specified as a node type, see the table for E2ENodeType in 1.6 List of enumerators.

baseTime

Optional

The time of the base point to acquire performance information. If you omit this item, the time that the API function is executed is used as the base point.

In the response body that is output as follows, confirm that the ID of CPU usage is "2".

{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2019-09-22T11:53:42.188+09:00",
  "updated" : "2019-09-22T11:53:42.354+09:00",
  "completed" : "2019-09-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"\n"#Latest PerformanceInformation"\n...",...,Performance ID,...,1,...,2,...,3,...
  } ]
}

Specify the ID of CPU usage in the request body to acquire resource performance information (in chronological order). Issue the request in the following format:

POST http://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV/invoke

The table below shows the objects to be specified as members of parameters in the request body.

Table 1‒14: Members to be specified when acquiring resource performance information (in chronological order)

Member

Whether to specify

Description

perfComponentIDs

Required

For perfComponentIDs, specify "2", which is the ID acquired in step 3.

baseTime

Optional

The time of the base point to acquire performance information. If you omit this item, the time that the API function is executed is used as the base point.

pointTimeRange

Required

Specify the period (in milliseconds) for acquiring performance information.

Result

You can acquire, in CSV format, basic information of the target resource by performing step 2, the latest performance information of each metric owned by the target resource by performing step 3, and performance information (in chronological order) of a specific metric owned by the target resource by performing step 4.

Related topics

2.16.1 Obtaining Hypervisor List

2.27.2 Collecting, into a CSV file, information about specified resources or a list of related resources

2.28.4 Collecting, into a CSV file, the latest value in the performance information that a specified resource holds

2.28.2 Collecting, into a CSV file, the performance values in a time series of specified performance information

2 List of API functions

This chapter describes the API functions provided by JP1/OA.

2.1 List of API requests related to authentication information

This section describes the operations for authentication information used by JP1/OA for connections to monitored resources.

2.1.1 Obtaining Authentication

This API acquires a list of authentication information to be used by JP1/OA for connections to monitored resources.

Execution permission

Admin

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Credential[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

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/Credentials 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 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1d392a3baad40eab4e3a05ad6e71e3a1fcd577_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 5,
    "name" : "smis",
    "credentialType" : "WBEM",
    "userId" : "smis",
    "portNumber" : 5989,
    "ssl" : true,
    "namespace" : "root/smis/current",
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 4,
    "name" : "snmpv3",
    "credentialType" : "SNMP",
    "userId" : "snmp",
    "portNumber" : 161,
    "community" : "",
    "snmpVersion" : "V3",
    "userName" : "snmp",
    "authenticationEnabled" : true,
    "authenticationProtocol" : "MD5",
    "privacyEnabled" : true,
    "privacyProtocol" : "DES",
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 3,
    "name" : "snmpv1",
    "credentialType" : "SNMP",
    "portNumber" : 161,
    "community" : "public",
    "snmpVersion" : "V1_V2C",
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 2,
    "name" : "ssh",
    "credentialType" : "SSH",
    "userId" : "ssh",
    "portNumber" : 22,
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 1,
    "name" : "wmi",
    "credentialType" : "WMI",
    "userId" : "wmi",
    "domainname" : "workspace",
    "numOfRelatedResources" : 0
  } ],
  "count" : 5
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.1.2 Obtaining Authentication Information

This API acquires the specified authentication information.

Execution permission

Admin

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Credentials/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Credentials/1 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:19:44 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO c0e8bc66dc88c9cd2bc76bb834cbc281e5358_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID": 7,
  "name": "hyper-v-auth",
  "credentialType": "WMI",
  "userId": "Administrator",
  "passwordNotRequired": false,
  "domainname": "workspace",
  "numOfRelatedResources": 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.1.3 Creating Authentication

This API creates an authentication.

Execution permission

Admin

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/Credentials

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "password":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "rootPassword":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationPassphrase":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyPassphrase":"...",
        "privacyProtocol":"..."
}

Credential (Type: Credential)

Attribute

Type

Description

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

password

string

Password used for authentication. Specify a Base64 encoded string of 255 or fewer bytes. To update the password, specify true for updatePassword.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

rootPassword

string

Root password used for authentication. Specify a Base64 encoded string of 255 or fewer bytes.

This member is only enabled when SSH is used for connections to monitoring targets. To update the rootPassword, specify true for updateRootPassword.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationPassphrase

string

Authentication pass phrase. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets. To update the authenticationPassphrase, specify true for updateAuthenticationPassphrase.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyPassphrase

string

Pass phrase for privacy. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets. To update the privacyPassphrase, specify true for updatePrivacyPassphrase.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No create privilege.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST http://localhost:22015/Analytics/v1/objects/Credentials HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Request Body]
{
  "name": "windows-001",
   "credentialType": "WMI",
   "userId": "admin",
   "password": "cGFzc3dvcmQ=",
   "passwordNotRequired": "false",
   "domainname": ""
}

[Response Header]
HTTP/1.1 201 Created
Date: Wed, 07 Dec 2016 10:25:35 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 492298acc985fe9bf3099a9ca1e52548c6c8cdb_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
Location: http://localhost:22015/Analytics/v1/objects/Credentials/7
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "instanceID" : 7,
  "name" : "windows-001",
  "credentialType" : "WMI",
  "userId" : "admin",
  "passwordNotRequired" : false,
  "domainname" : "",
  "numOfRelatedResources" : 0
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.1.4 Updating Authentication

This API updates the user ID and password contained in the specified authentication information.

Execution permission

Admin

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/Credentials/{id}

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "password":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "rootPassword":"...",
        "updatePassword":"...",
        "updateRootPassword":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationPassphrase":"...",
        "updateAuthenticationPassphrase":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyPassphrase":"...",
        "updatePrivacyPassphrase":"...",
        "privacyProtocol":"..."
}

Credential (Type: Credential)

Attribute

Type

Description

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

password

string

Password used for authentication. Specify a Base64 encoded string of 255 or fewer bytes. To update the password, specify true for updatePassword.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

rootPassword

string

Root password used for authentication. Specify a Base64 encoded string of 255 or fewer bytes.

This member is only enabled when SSH is used for connections to monitoring targets. To update the rootPassword, specify true for updateRootPassword.

updatePassword

boolean

Whether to change the password (password).

・true: Password is changed

・false: Password is not changed

If this member is omitted, false is set.

updateRootPassword

boolean

Whether to change the root password (rootPassword).

・true: Root password is changed

・false: Root password is not changed

If this member is omitted, false is set.

This member is only enabled when SSH is used for connections to monitoring targets.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationPassphrase

string

Authentication pass phrase. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets. To update the authenticationPassphrase, specify true for updateAuthenticationPassphrase.

updateAuthenticationPassphrase

boolean

Whether to change the authentication pass phrase.

・true: Authentication pass phrase is changed

・false: Authentication pass phrase is not changed

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyPassphrase

string

Pass phrase for privacy. Encode a string of 255 or fewer bytes in Base64. Only specify this member when using SNMP v3 for connections to monitoring targets. To update the privacyPassphrase, specify true for updatePrivacyPassphrase.

updatePrivacyPassphrase

boolean

Whether to change the pass phrase for privacy.

・true: Pass phrase is changed

・false: Pass phrase is not changed

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/Credentials/13 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 256

[Request Body]
{
  "name" : "WindowsMonitoring",
  "credentialType" : "WMI",
  "userId" : "Administrator",
  "passwordNotRequired" : false,
  "updatePassword" : true,
  "password" : "c3lzdGVtOm1hbmFnZXI=",
  "domainname" : "domain"
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4afe674fe8a4e569aa824d8786b0ac5b53e4a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID":13,
  "name": "WindowsMonitoring",
  "credentialType": "WMI",
  "userId": "Administrator",
  "passwordNotRequired": false,
  "domainname": "domain",
  "numOfRelatedResources": 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.1.5 Deleting Authentication

This API deletes the specified authentication information.

Execution permission

Admin

API version

v1

Request format

DELETE http[s]://host:port/Analytics/version/objects/Credentials/{id}

Request body

Not applicable.

Response body

Not applicable.

Status codes

Status code

Reason phrase

Description

204

No Content

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No delete privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
DELETE http://localhost:22015/Analytics/v1/objects/Credentials/7 HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 204 No Content
Date: Wed, 07 Dec 2016 10:26:30 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 7d842f5055c8b12c777296e3cd4f756ace9b528_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

Related topics

1.3 Resource members

1.6 List of enumerators

2.2 List of API requests related to plug-ins

This section describes the operations of plug-ins registered in JP1/OA.

2.2.1 Obtaining a List of Plug-in Information

This API request obtains a list of the plug-in information registered in JP1/OA.

Execution permission

Admin

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Plugin[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

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 http://localhost:22015/Analytics/v1/objects/Plugins HTTP/1.1
Host: localhost:22015
User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:52.0) Gecko/20100101 Firefox/52.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 02 Aug 2018 05:26:16 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 62acd5efafe957ae5bcf4a65265bae4ebf8b0b1_Vlo8Y30JZAoRFn1MGwZuDwEDfF8=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "data": [
    {
      "instanceID": 50,
      "name": "Sample 002 SNMP Node Plugin",
      "pluginId": "com.hitachi.software.ias.sample002",
      "protocolType": "SNMP",
      "formatversion": "0001",
      "pluginversion": "0001",
      "pluginType": "NODE_PLUGIN",
      "numOfRelatedResources": 2,
      "isCollector": false,
      "status": "ACTIVE"
    },
    {
      "instanceID": 0,
      "name": "Sample 001 SNMP Node Plugin",
      "pluginId": "com.hitachi.software.ias.sample001",
      "protocolType": "SNMP",
      "formatversion": "0001",
      "pluginversion": "0001",
      "pluginType": "NODE_PLUGIN",
      "numOfRelatedResources": 1,
      "isCollector": false,
      "status": "ACTIVE"
    }
  ],
  "count": 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.2.2 Obtaining Plug-in Information

This API request obtains information about the specified plug-in.

Execution permission

Admin

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Plugins/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "pluginId":"...",
        "protocolType":"...",
        "formatversion":"...",
        "pluginversion":"...",
        "pluginType":"...",
        "numOfRelatedResources":"...",
        "isCollector":"...",
        "status":"..."
}

Plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/Plugins/0 HTTP/1.1
Host: localhost:22015
User-Agent: Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:52.0) Gecko/20100101 Firefox/52.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 02 Aug 2018 05:33:31 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO e37f355445f0ffd3983bb9733cd5d3fed36d_Vlo8Y30JZAoRFn1MGwZuDwEDfF8=_V0810
X-Frame-Options: SAMEORIGIN
x-xss-protection=1; mode=block
X-Content-Type-Options=nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding:chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 0,
  "name" : "Sample 001 SNMP Node Plugin",
  "pluginId" : "com.hitachi.software.ias.sample001",
  "protocolType" : "SNMP",
  "formatversion" : "0001",
  "pluginversion" : "0001",
  "pluginType" : "NODE_PLUGIN",
  "numOfRelatedResources" : 1,
  "isCollector": false
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.3 List of API requests related to retrieval ranges (IP address ranges)

This section describes operations related to retrieval ranges.

2.3.1 Obtaining Retrieval Ranges

This API obtains a list of retrieval ranges used by JP1/OA in retrievals of monitoring targets.

Execution permission

Admin

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddrRange":["...", ...],
            "usePing":"...",
            "aliveMonitoring":"...",
            "useAllCredential":"...",
            "selectedCredentials":[{
                "instanceID":"...",
                "name":"...",
                "credentialType":"...",
                "userId":"...",
                "passwordNotRequired":"...",
                "portNumber":"...",
                "ssl":"...",
                "domainname":"...",
                "namespace":"...",
                "community":"...",
                "snmpVersion":"...",
                "userName":"...",
                "authenticationEnabled":"...",
                "authenticationProtocol":"...",
                "privacyEnabled":"...",
                "privacyProtocol":"...",
                "numOfRelatedResources":"..."
            },
            :
            ],
            "useAllPlugin":"...",
            "selectedPlugins":[{
                "instanceID":"...",
                "name":"...",
                "pluginId":"...",
                "protocolType":"...",
                "formatversion":"...",
                "pluginversion":"...",
                "pluginType":"...",
                "numOfRelatedResources":"...",
                "isCollector":"...",
                "status":"..."
            },
            :
            ],
            "deviceClassificationLabel":"...",
            "numOfRelatedPluginResources":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

IPAddrRange[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of a retrieval range

ipAddrRange

string[]

Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1.

usePing

boolean

Specify whether to execute ping on the target devices during retrieval.

- true: Use ping.

- false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

aliveMonitoring

boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

- true: Register as alive-monitoring targets.

- false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

useAllCredential

boolean

Flag indicating whether all the credentials are to be used. To use all the credentials, specify true.

selectedCredentials

Credential[]

List of the authentication information to be used for retrieval

useAllPlugin

boolean

Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true.

selectedPlugins

Plugin[]

A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false.

deviceClassificationLabel

string

Name of the classification label assigned to the device

numOfRelatedPluginResources

int

Number of plug-in resources found by using retrieval range.

selectedCredentials (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

selectedPlugins (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

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.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/IpAddrRanges HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.45.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 10:07:55 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 26216bc4db70cb43c76b534f163a88e165cc2ee_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data": [
    {
      "instanceID": 0,
      "name": "alive monitoring target",
      "ipAddrRange": [
        "10.196.2.10",
        "10.196.2.17"
      ],
      "usePing": true,
      "aliveMonitoring": true,
      "useAllCredential": false,
      "selectedCredentials": []
    },
    {
      "instanceID": 1,
      "name": "IP Range-1",
      "ipAddrRange": [
        "192.168.1.0",
        "192.168.1.254"
      ],
      "usePing": true,
      "aliveMonitoring": true,
      "useAllCredential": false,
      "selectedCredentials": [
        {
          "instanceID": 0,
          "name": "snmp_public",
          "credentialType": "SNMP",
          "portNumber": 161,
          "community": "public",
          "snmpVersion": "V1_V2C",
          "numOfRelatedResources": 3
        }
      ],
      "useAllPlugin": false,
      "selectedPlugins": [
        {
          "instanceID": 0,
          "name": "Sample 001 SNMP Node Plugin",
          "pluginId": "com.hitachi.software.ias.sample001",
          "protocolType": "SNMP",
          "formatversion": "0001",
          "pluginversion": "0001",
          "pluginType": "NODE_PLUGIN",
          "numOfRelatedResources": 1
        }
      ],
      "deviceClassificationLabel": "Plugin Hosts",
      "numOfRelatedPluginResources" : 1
    },
    {
      "instanceID": 2,
      "name": "xx_system",
      "ipAddrRange": [
        "10.197.3.20",
        "10.197.3.250"
      ],
      "usePing": true,
      "aliveMonitoring": true,
      "useAllCredential": false,
      "selectedCredentials": [
        {
          "instanceID": 15,
          "name": "xx_system_linux_credential",
          "credentialType": "SSH",
          "userId": "root",
          "portNumber": 22,
          "numOfRelatedResources": 7
        }
      ],
      "deviceClassificationLabel": "XX System"
    }
  ],
  "count": 3
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.3.2 Obtaining Retrieval Range Information

This API acquires information about the specified retrieval ranges.

Execution permission

Admin

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        },
        :
        ],
        "deviceClassificationLabel":"...",
        "numOfRelatedPluginResources":"..."
}

IPAddrRange (Type: IPAddrRange)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of a retrieval range

ipAddrRange

string[]

Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1.

usePing

boolean

Specify whether to execute ping on the target devices during retrieval.

- true: Use ping.

- false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

aliveMonitoring

boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

- true: Register as alive-monitoring targets.

- false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

useAllCredential

boolean

Flag indicating whether all the credentials are to be used. To use all the credentials, specify true.

selectedCredentials

Credential[]

List of the authentication information to be used for retrieval

useAllPlugin

boolean

Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true.

selectedPlugins

Plugin[]

A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false.

deviceClassificationLabel

string

Name of the classification label assigned to the device

numOfRelatedPluginResources

int

Number of plug-in resources found by using retrieval range.

selectedCredentials (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

selectedPlugins (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

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

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 10:07:55 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 684796b49f478df4995ed24766979cff90f05ea9_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "instanceID": 1,
  "name": "IP Range-1",
  "ipAddrRange": [
    "192.168.1.0",
    "192.168.1.254"
  ],
  "usePing": true,
  "aliveMonitoring": true,
  "useAllCredential": false,
  "selectedCredentials": [
    {
      "instanceID": 0,
      "name": "snmp_public",
      "credentialType": "SNMP",
      "portNumber": 161,
      "community": "public",
      "snmpVersion": "V1_V2C",
      "numOfRelatedResources": 3
    }
  ],
  "useAllPlugin": false,
  "selectedPlugins": [
    {
      "instanceID": 0,
      "name": "Sample 001 SNMP Node Plugin",
      "pluginId": "com.hitachi.software.ias.sample001",
      "protocolType": "SNMP",
      "formatversion": "0001",
      "pluginversion": "0001",
      "pluginType": "NODE_PLUGIN",
      "numOfRelatedResources": 1
    }
  ],
  "deviceClassificationLabel": "Plugin Hosts",
  "numOfRelatedPluginResources": 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.3.3 Creating Retrieval Ranges

This API creates a retrieval ranges.

Execution permission

Admin

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/IpAddrRanges

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

Attribute

Type

Description

name

string

Name of a retrieval range

ipAddrRange

string[]

Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1.

usePing

boolean

Specify whether to execute ping on the target devices during retrieval.

- true: Use ping.

- false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

aliveMonitoring

boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

- true: Register as alive-monitoring targets.

- false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

useAllCredential

boolean

Flag indicating whether all the credentials are to be used. To use all the credentials, specify true.

selectedCredentials

Credential[]

List of the authentication information to be used for retrieval

useAllPlugin

boolean

Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true.

selectedPlugins

Plugin[]

A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false.

deviceClassificationLabel

string

Name of the classification label assigned to the device

selectedCredentials (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

selectedPlugins (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        },
        :
        ],
        "deviceClassificationLabel":"...",
        "numOfRelatedPluginResources":"..."
}

IPAddrRange (Type: IPAddrRange)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of a retrieval range

ipAddrRange

string[]

Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1.

usePing

boolean

Specify whether to execute ping on the target devices during retrieval.

- true: Use ping.

- false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

aliveMonitoring

boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

- true: Register as alive-monitoring targets.

- false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

useAllCredential

boolean

Flag indicating whether all the credentials are to be used. To use all the credentials, specify true.

selectedCredentials

Credential[]

List of the authentication information to be used for retrieval

useAllPlugin

boolean

Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true.

selectedPlugins

Plugin[]

A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false.

deviceClassificationLabel

string

Name of the classification label assigned to the device

numOfRelatedPluginResources

int

Number of plug-in resources found by using retrieval range.

selectedCredentials (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

selectedPlugins (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/IpAddrRanges HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Request Body]
{
  "name": "yy_system_OS",
  "ipAddrRange": [
    "10.197.53.1",
    "10.197.53.200"
  ],
  "usePing": true,
  "aliveMonitoring": false,
  "useAllCredential": false,
  "selectedCredentials": [
    {
      "instanceID": 51
    },
    {
      "instanceID": 52
    }
  ],
  "deviceClassificationLabel": "YY SYSTEM"
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 06 Sep 2019 09:36:53 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6854c0241fe8687e5c5260973a74212b7f61527f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
Location: http://JP1OAServer:22015/Analytics/v1/objects/IpAddrRanges/101
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked

[Response Body]
{
  "instanceID" : 101,
  "name" : "yy_system_OS",
  "ipAddrRange" : [ "10.197.53.1", "10.197.53.200" ],
  "usePing" : true,
  "aliveMonitoring" : false,
  "useAllCredential" : false,
  "selectedCredentials" : [ {
    "instanceID" : 51,
    "name" : "yy_system_linux",
    "credentialType" : "SSH",
    "userId" : "operator",
    "portNumber" : 22,
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 52,
    "name" : "yy_system_windows",
    "credentialType" : "WMI",
    "userId" : "admin",
    "passwordNotRequired" : false,
    "domainname" : "workspace",
    "numOfRelatedResources" : 0
  } ],
  "deviceClassificationLabel" : "YY SYSTEM"
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.3.4 Updating Retrieval Ranges

This API updates the specified retrieval ranges.

Execution permission

Admin

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

Attribute

Type

Description

name

string

Name of a retrieval range

ipAddrRange

string[]

Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1.

usePing

boolean

Specify whether to execute ping on the target devices during retrieval.

- true: Use ping.

- false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

aliveMonitoring

boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

- true: Register as alive-monitoring targets.

- false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

useAllCredential

boolean

Flag indicating whether all the credentials are to be used. To use all the credentials, specify true.

selectedCredentials

Credential[]

List of the authentication information to be used for retrieval

useAllPlugin

boolean

Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true.

selectedPlugins

Plugin[]

A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false.

deviceClassificationLabel

string

Name of the classification label assigned to the device

selectedCredentials (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

selectedPlugins (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "aliveMonitoring":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "useAllPlugin":"...",
        "selectedPlugins":[{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        },
        :
        ],
        "deviceClassificationLabel":"...",
        "numOfRelatedPluginResources":"..."
}

IPAddrRange (Type: IPAddrRange)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of a retrieval range

ipAddrRange

string[]

Specify a retrieval range. The IP address from which retrieval starts is set at position 0 in the list, and the IP address at which retrieval ends is set at position 1.

usePing

boolean

Specify whether to execute ping on the target devices during retrieval.

- true: Use ping.

- false: Do not use ping.

If you specify true for this item, specify a value for aliveMonitoring. If you specify false for this item or if you specify true for this item and false for aliveMonitoring, specify a value for selectedCredentials or specify true for useAllCredential.

aliveMonitoring

boolean

Specify whether to register as alive-monitoring targets the resources for which connection can be confirmed by pinging the target resource, if a search cannot be performed by using the selected credential information. If no credential information is set, the resources for which connection can be confirmed are registered as alive-monitoring targets.

- true: Register as alive-monitoring targets.

- false: Do not register as alive-monitoring targets.

If you specify true for this item, specify true for usePing.

useAllCredential

boolean

Flag indicating whether all the credentials are to be used. To use all the credentials, specify true.

selectedCredentials

Credential[]

List of the authentication information to be used for retrieval

useAllPlugin

boolean

Flag indicating whether all the plug-ins are to be used. To use all the plug-ins, specify true.

selectedPlugins

Plugin[]

A list of plug-in information to be used to perform searches. This list is returned if this list exists and the value for useAllPlugin is false.

deviceClassificationLabel

string

Name of the classification label assigned to the device

numOfRelatedPluginResources

int

Number of plug-in resources found by using retrieval range.

selectedCredentials (Type: Credential)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Name of authentication information

credentialType

enum

Protocol used for connections to monitoring targets.

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

userId

string

Use 64 or fewer characters. If you use SNMP v3 for connections to monitoring targets, the value of the username member is set.

passwordNotRequired

boolean

Whether a password is needed for authentication. If this member is omitted, false is set. This setting takes effect only if WMI is used for connection to the monitoring target.

・true: A password is not needed

・false: A password is needed

portNumber

int

Port number. This member is only set when the protocol used for connections to monitoring targets is SSH, SMI-S WBEM, or SNMP.

ssl

boolean

Whether to use SSL (HTTPS) for connections to monitoring targets.

・true: SSL is used

・false: SSL is not used

If this member is omitted, false is set. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

domainname

string

Domain name. This member is only enabled when WMI is used for connections to monitoring targets.

namespace

string

Name space. This member is only enabled when SMI-S WBEM is used for connections to monitoring targets.

community

string

Community name. This member is only enabled when SNMP is used for connections to monitoring targets.

snmpVersion

enum

SNMP version. This member is only enabled when SNMP is used for connections to monitoring targets.

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

The specifiable values are as follows:

V1_V2C

V3

userName

string

User name used for authentication. Use 64 or fewer characters. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationEnabled

boolean

Whether to perform SMTP authentication.

・true: SMTP authentication is enabled

・false: SMTP authentication is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

authenticationProtocol

enum

Protocol for authentication. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

MD5

SHA1

privacyEnabled

boolean

Whether to enable privacy.

・true: Privacy is enabled

・false: Privacy is disabled

If this member is omitted, false is set. Only specify this member when using SNMP v3 for connections to monitoring targets.

privacyProtocol

enum

Protocol for privacy. Only specify this member when using SNMP v3 for connections to monitoring targets.

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

The specifiable values are as follows:

DES

AES128

numOfRelatedResources

int

Number of resources found by using authentication information.

selectedPlugins (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/IpAddrRanges/101 HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Request Body]
{
  "name": "yy_system_Resources",
  "ipAddrRange": [
    "10.197.53.1",
    "10.197.53.100"
  ],
  "usePing": true,
  "aliveMonitoring": true,
  "useAllCredential": false,
  "selectedCredentials": [
    {
      "instanceID": 51
    },
    {
      "instanceID": 52
    }
  ],
  "useAllPlugin": false,
  "selectedPlugins": [
    {
      "instanceID": 3
    }
  ],
  "deviceClassificationLabel": "YY SYSTEM"
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 06 Sep 2019 09:36:53 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6854c0241fe8687e5c5260973a74212b7f61527f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
Location: http://JP1OAServer:22015/Analytics/v1/objects/IpAddrRanges/101
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked

[Response Body]
{
  "instanceID": 101,
  "name": "yy_system_Resources",
  "ipAddrRange": [
    "10.197.53.1",
    "10.197.53.100"
  ],
  "usePing": true,
  "aliveMonitoring": true,
  "useAllCredential": false,
  "selectedCredentials": [
    {
      "instanceID": 51,
      "name": "yy_system_linux",
      "credentialType": "SSH",
      "userId": "operator",
      "portNumber": 22,
      "numOfRelatedResources": 0
    },
    {
      "instanceID": 52,
      "name": "yy_system_windows",
      "credentialType": "WMI",
      "userId": "admin",
      "passwordNotRequired": false,
      "domainname": "workspace",
      "numOfRelatedResources": 0
    }
  ],
  "useAllPlugin": false,
  "selectedPlugins": [
    {
      "instanceID": 3,
      "name": "YY system embeded OS",
      "pluginId": "com.hitachi.software.ias.sample.host.embeded",
      "protocolType": "SNMP",
      "formatversion": "0001",
      "pluginversion": "0001",
      "pluginType": "NODE_PLUGIN",
      "numOfRelatedResources": 0
    }
  ],
  "deviceClassificationLabel": "YY SYSTEM"
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.3.5 Deleting Retrieval Ranges

This API deletes the specified retrieval ranges.

Execution permission

Admin

API version

v1

Request format

DELETE http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}

Request body

Not applicable.

Response body

Not applicable.

Status codes

Status code

Reason phrase

Description

204

No Content

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No delete privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
DELETE http://localhost:22015/Analytics/v1/objects/IpAddrRanges/50 HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 204 No Content
Date: Wed, 07 Dec 2016 10:13:58 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO f1f0fb1a6ac21a0695f6536ba8950b641c263a4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

Related topics

1.3 Resource members

1.6 List of enumerators

2.4 List of API requests related to discovery

This section describes operations related to discovery.

2.4.1 Obtaining Discovery Operation List

This API request acquires a list of operations that can be run for a discovery.

Execution permission

Admin

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Discoveries/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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 http://localhost:22015/Analytics/v1services/Discoveries/actions/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:46:11 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d3f7add114f629334ca4eb95ffa5f694266411_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 451

[Response Body]
{
  "data" : [ {
    "name" : "submit",
    "href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/submit/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  }, {
    "name" : "stop",
    "href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.4.2 Obtaining the Information Necessary To Run a Discovery

This API request acquires the information necessary to run a discovery.

Execution permission

Admin

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Discoveries/actions/submit

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "autoManage":"...",
            "ipAddrRangeID":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

DiscoveryParam[]

A list of DiscoveryParam objects necessary to execute an operation. For details about DiscoveryParam, see the table below.

parameters (Type: DiscoveryParam)

Attribute

Type

Description

autoManage

boolean

To automatically manage discovered resources, set true.

ipAddrRangeID

long[]

List of instance IDs in the IP address range used for discovery

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 http://localhost:22015/Analytics/v1/services/Discoveries/actions/submit/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:47:16 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ffcce126318d18ca63c8fd870a3bbbde84ca57b_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 274

[Response Body]
{
  "name" : "submit",
  "href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/submit/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "autoManage" : true,
    "ipAddrRangeID" : [ 3, 2, 1, 4, 5, 50 ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.4.3 Running a Discovery

This API run a discovery.

Execution permission

Admin

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Discoveries/actions/submit/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "autoManage":"...",
            "ipAddrRangeID":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

DiscoveryParam[]

A list of DiscoveryParam objects necessary to execute an operation. For details about DiscoveryParam, see the table below.

parameters (Type: DiscoveryParam)

Attribute

Type

Description

autoManage

boolean

To automatically manage discovered resources, set true.

ipAddrRangeID

long[]

List of instance IDs in the IP address range used for discovery

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No execute privilege.

404

Not Found

The resource was not found.

409

Conflict

Executing now.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST http://localhost:22015/Analytics/v1/services/Discoveries/actions/submit/invoke HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 154

[Request Body]
{
  "name":"submit",
  "href":"v1/services/Discoveries/actions/submit/invoke",
  "method":"POST",
  "parameters":[
    {
      "ipAddrRangeID":[3,2,1,4,5,50],
      "autoManage":true
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:53:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 765ce3a1aa398ad2f383653ce37491ea3744085_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 279

[Response Body]
{
  "instanceID" : "ef724ea9-41ad-49d3-afe0-e174f534b846",
  "created" : "2020-05-25T11:53:26.350+09:00",
  "updated" : "2020-05-25T11:53:26.350+09:00",
  "completed" : "2020-05-25T11:53:26.350+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.4.4 Obtaining the Information Necessary To Stop a Discovery

This API request acquires the information necessary to stop a discovery.

Execution permission

Admin

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Discoveries/actions/stop

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects necessary to execute an operation. No value is set.

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 http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:48:17 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8145f2e5623a6863f92284d7419ab4fa89b138_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 192

[Response Body]
{
  "name" : "stop",
  "href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.4.5 Stopping a Discovery

This API stop a discovery.

Execution permission

Admin

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Discoveries/actions/stop/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects necessary to execute an operation. No value is set.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

Discovery is not executing.

401

Unauthorized

No login privilege.

403

Forbidden

No execute privilege.

409

Conflict

Executing now.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 159

[Request Body]
{
  "name":"stop",
  "href":
"http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke",
  "method":"POST",
  "type":"application/json","parameters":[]
}

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:53:56 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5613ce8c7eb2fb4c4f682c32545f5a9136113e_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 279

[Response Body]
{
  "instanceID" : "5732aea6-4208-4467-a548-54df423b603e",
  "created" : "2020-05-25T11:53:56.611+09:00",
  "updated" : "2020-05-25T11:53:56.611+09:00",
  "completed" : "2020-05-25T11:53:56.611+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.4.6 Obtaining Information about Discovered Resources

This API request acquires information about resources discovered in the last discovery.

Execution permission

Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "ipAddress":"...",
            "name":"...",
            "nodeName":"...",
            "monitorStatus":"...",
            "deviceType":"...",
            "credentialType":"...",
            "nodeInformationGettableLevel":"...",
            "discoveryLogCategory":"...",
            "autoManage":"...",
            "credentialName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

DiscoveryLogResource[]

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

Attribute

Type

Description

ipAddress

string

IP address of the resource

name

string

Name of the IP address range used in the discovery

nodeName

string

Resource name

monitorStatus

enum

Management status of the resource

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

The specifiable values are as follows:

New

Manage

ignore

MonitorOff

deviceType

enum

Device type of the resource

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

The specifiable values are as follows:

SERVER_WINDOWS

SERVER_LINUX

SERVER_ESX

SWITCH_FC

SWITCH_IP

STORAGE_HITACHI

STORAGE_OTHER

GENERIC_COMPUTER

GENERIC_STORAGE

SERVER_SOLARIS

SERVER_HYPERV

SERVER_HPUX

SERVER_AIX

GENERIC_HYPERVISOR

credentialType

enum

Type of authentication credentials used in the discovery

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

The specifiable values are as follows:

WMI

SSH

WBEM

SNMP

nodeInformationGettableLevel

enum

Result of the authentication credentials used in the discovery. This property is set when discoveryLogCategory is NoResponse or Failed.

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

The specifiable values are as follows:

OK

ProtocolUnrecognizedError

AuthenticationError

UnauthorizedRoleError

OtherError

ClusterIPAddressNotSupported

NoResponse

UnsupportDeviceError

UnexpectedDeviceError

TimeoutError

RequestTooMuchError

discoveryLogCategory

enum

Category of discovered resources

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

autoManage

boolean

To automatically manage discovered resources, set true.

credentialName

string

Name of the authentication credentials used in the discovery

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.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/DiscoveryLogResources/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:40:47 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO eed864e1af108faf58e4f486be419a1f45fca74_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 305

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "ipAddress" : "192.168.11.1",
    "name" : "test",
    "nodeName" : "test-server",
    "monitorStatus" : "Manage",
    "deviceType" : "SERVER_WINDOWS",
    "discoveryLogCategory" : "Skipped",
    "credentialName" : "test"
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.4.7 Obtaining Discovery History

This API request acquires the results from the last discovery.

Execution permission

Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "status":"...",
            "autoManage":"...",
            "startTime":"...",
            "completionTime":"...",
            "elapsedTime":"...",
            "discoveredResources":"...",
            "failedProtocols":"...",
            "noResponseIpAddresses":"...",
            "skippedResources":"...",
            "denominatorForProgress":"...",
            "numeratorForProgress":"...",
            "lastTime":"...",
            "discoverdLogTargetIPRange":[{
                "name":"..."
            },
            :
            ]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

DiscoveryLog[]

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

Attribute

Type

Description

status

enum

Discovery progress status. If a discovery has not been run, properties other than the status are not output.

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

The specifiable values are as follows:

Running

Completed

Canceled

Unexecuted

Error

autoManage

boolean

To automatically manage discovered resources, set true.

startTime

dateTime

Discovery start time

completionTime

dateTime

Discovery end time. If the discovery is in progress, this value is null.

elapsedTime

int

Time elapsed during discovery (in seconds)

discoveredResources

int

Number of discovered resources

failedProtocols

int

Number of resources for which discovery failed

noResponseIpAddresses

int

Number of resources for which there was no response

skippedResources

int

Number of skipped resources

denominatorForProgress

int

Denominator for the progress calculation

numeratorForProgress

int

Numerator for the progress calculation. This is the number of IP addresses (from among the discovery targets) for which processing is complete.

lastTime

dateTime

Time when the discovery status was last checked

discoverdLogTargetIPRange

DiscoveryLogTargetIPRange[]

List of IP-address ranges included in the discovery results

discoverdLogTargetIPRange (Type: DiscoveryLogTargetIPRange)

Attribute

Type

Description

name

string

Name of IPAddrRange

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.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/DiscoveryLogs/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:37:51 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO eed864e1af108faf58e4f486be419a1f45fca74_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 816

[Response Body]
{
  "data" : [ {
    "status" : "Canceled",
    "autoManage" : true,
    "startTime" : "2020-05-25T10:41:56.389+09:00",
    "completionTime" : "2020-05-25T10:42:03.365+09:00",
    "elapsedTime" : 6,
    "discoveredResources" : 0,
    "failedProtocols" : 0,
    "noResponseIpAddresses" : 0,
    "skippedResources" : 1,
    "denominatorForProgress" : 100,
    "numeratorForProgress" : 12,
    "nextDiscoveryTime" : "2000-01-01T09:00:00.000+09:00",
    "lastTime" : "2020-05-25T11:37:51.529+09:00",
    "discoverdLogTargetIPRange" : [ {
      "name" : "192.168.11.1"
    }, {
      "name" : "test.com"
    }, {
      "name" : "test"
    } ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.5 List of API requests related to collectors

This section describes the operations for collectors used by JP1/OA for connections to management software.

2.5.1 Obtaining Collector List

This API acquires a list of collectors to be used by JP1/OA for connections to management software.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "collectorType":"...",
            "osType":"...",
            "autoCollectionType":"...",
            "connectResult":"...",
            "refreshStatus":"...",
            "message":"...",
            "lastRefreshed":"...",
            "refreshDateForInventory":"...",
            "refreshDateForPerformance":"...",
            "refreshDateForState":"...",
            "numOfHypervisors":"...",
            "numOfVms":"...",
            "numOfHosts":"...",
            "numOfApplications":"...",
            "numOfContainers":"...",
            "numOfServices":"...",
            "numOfResources":"...",
            "collectorCredentials":[{
                "requireHostAddress":"...",
                "ipAddress":"...",
                "accessTargetIdentification":"...",
                "userId":"...",
                "portNumber":"...",
                "hypertextTransferProtocolType":"...",
                "domainName":"...",
                "useAdministrativeShares":"...",
                "shareName":"...",
                "sharedFolder":"...",
                "logicalHostName":"...",
                "useLogicalHostName":"..."
            },
            :
            ],
            "productName":"...",
            "providerName":"...",
            "refreshDateForApp":"...",
            "plugin":{
                "instanceID":"...",
                "name":"...",
                "pluginId":"...",
                "protocolType":"...",
                "formatversion":"...",
                "pluginversion":"...",
                "pluginType":"...",
                "numOfRelatedResources":"...",
                "isCollector":"...",
                "status":"..."
            }
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Collector[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Collector name

collectorType

enum

Collector type.

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

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

osType

enum

Type of OS. This member is only set when the collectorType is AJS, PFM, or IM.

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

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

connectResult

enum

Last execution result of the collector.

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

The specifiable values are as follows:

NoConnect

Succeeded

Failed

refreshStatus

enum

Execution status of the collector.

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

The specifiable values are as follows:

NoConnect

InProgress

message

string

Message of the execution result of the collector

lastRefreshed

dateTime

The date and time when information for the following was last updated:

・refreshDateForInventory

・refreshDateForPerformance

・refreshDateForState

refreshDateForInventory

dateTime

Refresh date and time for the configuration information

refreshDateForPerformance

dateTime

Refresh date and time for the performance information

refreshDateForState

dateTime

Date and time when the state information is to be refreshed. This value can be obtained when all of the following conditions are met:

・The type of collector is VCENTER.

・The collection interval settings of "Status Monitoring (VM/Hypervisor)" are enabled.

numOfHypervisors

int

Number of hypervisors found by the collector

numOfVms

int

Number of virtual machines found by the collector

numOfHosts

int

Number of virtual machines found by the collector

numOfApplications

int

Number of applications found by the collector.

numOfContainers

int

Number of container nodes found by the collector.

numOfServices

int

Number of service resources found by the collector.

numOfResources

int

Number of management resources found by the collector.

collectorCredentials

CollectorCredential[]

Authentication information used for connections to monitoring targets.

productName

string

Collected-product name. This value can be obtained when the collectorType is CUSTOM_APP.

providerName

string

Provider name. This value can be obtained when the collectorType is CUSTOM_APP.

refreshDateForApp

dateTime

Date definition was applied. This value can be obtained when the collectorType is CUSTOM_APP.

plugin

Plugin

Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute

Type

Description

requireHostAddress

boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

ipAddress

string

IP address or host name used for connections to management software.

accessTargetIdentification

string

Access-target identification key (when no IP address is specified)

userId

string

User ID used for connections to management software. Specify a string of 255 or fewer bytes.

portNumber

int

Port number used for connections to management software.

hypertextTransferProtocolType

enum

Whether to use SSL (HTTPS) for connections to management software.

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

The specifiable values are as follows:

HTTP

HTTPS

domainName

string

Domain name: Used for application linkage when Windows is selected.

useAdministrativeShares

boolean

To share management, set true.

shareName

string

share Name

sharedFolder

string

shared Folder

logicalHostName

string

Logical Host Name

useLogicalHostName

boolean

To use logical host name, set true.

plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

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/Collectors 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 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO b9719717b548c1da1798ed5a2b2c22dbda7f40cd_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "192.168.0.115",
    "collectorType" : "VCENTER",
    "autoCollectionType" : "AutoConnect",
    "connectResult" : "Succeeded",
    "refreshStatus" : "NoConnect",
    "lastRefreshed" : "2015-11-27T14:17:09.160+09:00",
    "refreshDateForInventory" : "2015-11-27T13:25:03.943+09:00",
    "refreshDateForPerformance" : "2015-11-27T14:17:09.160+09:00",
    "refreshDateForState": "2015-11-27T13:36:45.725+09:00",
    "numOfHypervisors" : 2,
    "numOfVms" : 27,
    "numOfApplications": 12,
    "numOfContainers": 0,
    "numOfServices": 0,
    "numOfResources": 0,
    "collectorCredentials" : [ {
      "ipAddress" : "192.168.0.115",
      "userId" : "Administrator",
      "portNumber" : 443,
      "hypertextTransferProtocolType" : "HTTPS"
    } ]
  },
  {
    "instanceID": 1,
    "name": "jp1ajs_v11",
    "collectorType": "AJS",
    "osType": "Windows",
    "autoCollectionType": "AutoConnect",
    "connectResult": "Succeeded",
    "refreshStatus": "NoConnect",
    "lastRefreshed": "2017-09-26T00:46:59.296+09:00",
    "refreshDateForInventory": "2017-09-26T00:46:59.296+09:00",
    "numOfHypervisors": 0,
    "numOfVms": 0,
    "numOfApplications": 12,
    "numOfContainers": 0,
    "numOfServices": 0,
    "numOfResources": 0,
    "collectorCredentials":
    [
      {
        "ipAddress": "192.168.1.118",
        "userId": "administrator",
        "domainName": "",
        "useAdministrativeShares": true,
        "useLogicalHostName": false
      }
    ]
  },
  {
    "instanceID": 3,
    "name": "customCollector",
    "collectorType": "CUSTOM",
    "autoCollectionType": "AutoConnect",
    "connectResult": "Succeeded",
    "refreshStatus": "NoConnect",
    "lastRefreshed": "2017-09-26T10:15:26.991+09:00",
    "refreshDateForInventory": "2017-09-26T10:15:26.991+09:00",
    "numOfHypervisors": 0,
    "numOfVms": 0,
    "numOfApplications": 10,
    "numOfContainers": 0,
    "numOfServices": 0,
    "numOfResources": 0,
    "productName": "User Product",
    "providerName": "XXYY System",
    "refreshDateForApp": "2017-08-04T12:10:00.775+09:00"
  }
],
  "count" : 3
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.5.2 Obtaining Collector Information

This API acquires information about the specified collector.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Collectors/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "refreshDateForState":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfHosts":"...",
        "numOfApplications":"...",
        "numOfContainers":"...",
        "numOfServices":"...",
        "numOfResources":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"...",
        "plugin":{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        }
}

Collector (Type: Collector)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Collector name

collectorType

enum

Collector type.

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

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

osType

enum

Type of OS. This member is only set when the collectorType is AJS, PFM, or IM.

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

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

connectResult

enum

Last execution result of the collector.

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

The specifiable values are as follows:

NoConnect

Succeeded

Failed

refreshStatus

enum

Execution status of the collector.

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

The specifiable values are as follows:

NoConnect

InProgress

message

string

Message of the execution result of the collector

lastRefreshed

dateTime

The date and time when information for the following was last updated:

・refreshDateForInventory

・refreshDateForPerformance

・refreshDateForState

refreshDateForInventory

dateTime

Refresh date and time for the configuration information

refreshDateForPerformance

dateTime

Refresh date and time for the performance information

refreshDateForState

dateTime

Date and time when the state information is to be refreshed. This value can be obtained when all of the following conditions are met:

・The type of collector is VCENTER.

・The collection interval settings of "Status Monitoring (VM/Hypervisor)" are enabled.

numOfHypervisors

int

Number of hypervisors found by the collector

numOfVms

int

Number of virtual machines found by the collector

numOfHosts

int

Number of virtual machines found by the collector

numOfApplications

int

Number of applications found by the collector.

numOfContainers

int

Number of container nodes found by the collector.

numOfServices

int

Number of service resources found by the collector.

numOfResources

int

Number of management resources found by the collector.

collectorCredentials

CollectorCredential[]

Authentication information used for connections to monitoring targets.

productName

string

Collected-product name. This value can be obtained when the collectorType is CUSTOM_APP.

providerName

string

Provider name. This value can be obtained when the collectorType is CUSTOM_APP.

refreshDateForApp

dateTime

Date definition was applied. This value can be obtained when the collectorType is CUSTOM_APP.

plugin

Plugin

Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute

Type

Description

requireHostAddress

boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

ipAddress

string

IP address or host name used for connections to management software.

accessTargetIdentification

string

Access-target identification key (when no IP address is specified)

userId

string

User ID used for connections to management software. Specify a string of 255 or fewer bytes.

portNumber

int

Port number used for connections to management software.

hypertextTransferProtocolType

enum

Whether to use SSL (HTTPS) for connections to management software.

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

The specifiable values are as follows:

HTTP

HTTPS

domainName

string

Domain name: Used for application linkage when Windows is selected.

useAdministrativeShares

boolean

To share management, set true.

shareName

string

share Name

sharedFolder

string

shared Folder

logicalHostName

string

Logical Host Name

useLogicalHostName

boolean

To use logical host name, set true.

plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Collectors/0 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:19:44 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d81476c07bc464b6d3c785f80b0b87eb0549f62_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 0,
  "name" : "172.17.17.115",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "Succeeded",
  "refreshStatus" : "NoConnect",
  "lastRefreshed" : "2015-11-27T16:18:41.710+09:00",
  "refreshDateForInventory" : "2015-11-27T15:25:04.098+09:00",
  "refreshDateForPerformance" : "2015-11-27T16:18:41.710+09:00",
  "refreshDateForState": "2015-11-27T15:26:02.097+09:00",
  "numOfHypervisors" : 2,
  "numOfVms" : 27,
  "numOfApplications" : 0,
  "numOfContainers": 0,
  "numOfServices": 0,
  "numOfResources" 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.17.17.115",
    "userId" : "Administrator",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.5.3 Creating Collector

This API creates a collector. However, it cannot create a collector for a custom application.

Execution permission

Admin

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/Collectors

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "password":"...",
            "updatePassword":"...",
            "portNumber":"...",
            "optionalInformation1":"...",
            "updateOptionalInformation1":"...",
            "optionalInformation2":"...",
            "updateOptionalInformation2":"...",
            "optionalInformation3":"...",
            "updateOptionalInformation3":"...",
            "useProxy":"...",
            "proxyHostAddr":"...",
            "proxyPort":"...",
            "proxyUser":"...",
            "updateProxyPassword":"...",
            "proxyPassword":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "rootPassword":"...",
            "updateRootPassword":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "plugin":{
            "instanceID":"..."
        }
}

Collector (Type: Collector)

Attribute

Type

Description

name

string

Collector name

collectorType

enum

Collector type.

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

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

osType

enum

Type of OS. This member is only set when the collectorType is AJS, PFM, or IM.

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

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

collectorCredentials

CollectorCredential[]

Authentication information used for connections to monitoring targets.

plugin

Plugin

Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute

Type

Description

requireHostAddress

boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

ipAddress

string

IP address or host name used for connections to management software.

accessTargetIdentification

string

Access-target identification key (when no IP address is specified)

userId

string

User ID used for connections to management software. Specify a string of 255 or fewer bytes.

password

string

Password used for connections to management software. Encode a string of 255 or fewer bytes in Base64.

updatePassword

boolean

Whether to change the password used for connections to management software.

・true: Password is changed

・false: Password is not changed

If this member is omitted, false is set.

portNumber

int

Port number used for connections to management software.

optionalInformation1

string

Option information for information acquisition that can be used in the plug-in. The value set for the first option. Encode a string in Base64.

updateOptionalInformation1

boolean

To change option 1, set "true". Use this only for updates.

optionalInformation2

string

Option information for information acquisition that can be used in the plug-in. The value set for the second option. Encode a string in Base64.

updateOptionalInformation2

boolean

To change option 2, set "true". Use this only for updates.

optionalInformation3

string

Option information for information acquisition that can be used in the plug-in. The value set for the third option. Encode a string in Base64.

updateOptionalInformation3

boolean

To change option 3, set "true". Use this only for updates.

useProxy

boolean

Specify true when connecting to a custom collector via a proxy.

proxyHostAddr

string

Proxy host address when using a proxy.

proxyPort

int

Proxy port when using a proxy.

proxyUser

string

The authenticated user of the proxy when using the proxy.

updateProxyPassword

boolean

Set true to change the proxy password. Used only when updating.

proxyPassword

string

Proxy authentication password when using a proxy. Encode a string in Base64.

hypertextTransferProtocolType

enum

Whether to use SSL (HTTPS) for connections to management software.

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

The specifiable values are as follows:

HTTP

HTTPS

domainName

string

Domain name: Used for application linkage when Windows is selected.

rootPassword

string

root password: Used for application linkage when Unix is selected.

updateRootPassword

boolean

To change the password, set true. Use only for updates.

useAdministrativeShares

boolean

To share management, set true.

shareName

string

share Name

sharedFolder

string

shared Folder

logicalHostName

string

Logical Host Name

useLogicalHostName

boolean

To use logical host name, set true.

plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "refreshDateForState":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfHosts":"...",
        "numOfApplications":"...",
        "numOfContainers":"...",
        "numOfServices":"...",
        "numOfResources":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"...",
        "plugin":{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        }
}

Collector (Type: Collector)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Collector name

collectorType

enum

Collector type.

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

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

osType

enum

Type of OS. This member is only set when the collectorType is AJS, PFM, or IM.

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

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

connectResult

enum

Last execution result of the collector.

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

The specifiable values are as follows:

NoConnect

Succeeded

Failed

refreshStatus

enum

Execution status of the collector.

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

The specifiable values are as follows:

NoConnect

InProgress

message

string

Message of the execution result of the collector

lastRefreshed

dateTime

The date and time when information for the following was last updated:

・refreshDateForInventory

・refreshDateForPerformance

・refreshDateForState

refreshDateForInventory

dateTime

Refresh date and time for the configuration information

refreshDateForPerformance

dateTime

Refresh date and time for the performance information

refreshDateForState

dateTime

Date and time when the state information is to be refreshed. This value can be obtained when all of the following conditions are met:

・The type of collector is VCENTER.

・The collection interval settings of "Status Monitoring (VM/Hypervisor)" are enabled.

numOfHypervisors

int

Number of hypervisors found by the collector

numOfVms

int

Number of virtual machines found by the collector

numOfHosts

int

Number of virtual machines found by the collector

numOfApplications

int

Number of applications found by the collector.

numOfContainers

int

Number of container nodes found by the collector.

numOfServices

int

Number of service resources found by the collector.

numOfResources

int

Number of management resources found by the collector.

collectorCredentials

CollectorCredential[]

Authentication information used for connections to monitoring targets.

productName

string

Collected-product name. This value can be obtained when the collectorType is CUSTOM_APP.

providerName

string

Provider name. This value can be obtained when the collectorType is CUSTOM_APP.

refreshDateForApp

dateTime

Date definition was applied. This value can be obtained when the collectorType is CUSTOM_APP.

plugin

Plugin

Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute

Type

Description

requireHostAddress

boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

ipAddress

string

IP address or host name used for connections to management software.

accessTargetIdentification

string

Access-target identification key (when no IP address is specified)

userId

string

User ID used for connections to management software. Specify a string of 255 or fewer bytes.

portNumber

int

Port number used for connections to management software.

hypertextTransferProtocolType

enum

Whether to use SSL (HTTPS) for connections to management software.

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

The specifiable values are as follows:

HTTP

HTTPS

domainName

string

Domain name: Used for application linkage when Windows is selected.

useAdministrativeShares

boolean

To share management, set true.

shareName

string

share Name

sharedFolder

string

shared Folder

logicalHostName

string

Logical Host Name

useLogicalHostName

boolean

To use logical host name, set true.

plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

- A format of request body is invalid

- A request is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No create privilege.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/Collectors HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 236

[Request Body]
{
  "name": "test Collector",
  "autoCollectionType": "AutoConnect",
  "collectorType": "VCENTER",
  "collectorCredentials": [
    {
      "ipAddress": "172.17.17.113",
      "userId": "test",
      "password": "dGVzdA==",
      "portNumber": 443,
      "hypertextTransferProtocolType": "HTTPS"
    }
  ]
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 08:23:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO bfb7bb1ac5122d4e95bddc86cfb215f4c04715_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/Collectors/13
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 13,
  "name" : "vCenter_71",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "Succeeded",
  "refreshStatus" : "NoConnect",
  "lastRefreshed" : "2016-11-21T17:17:59.926+09:00",
  "refreshDateForInventory" : "2016-11-21T16:52:03.271+09:00",
  "refreshDateForPerformance" : "2016-11-21T17:17:59.926+09:00",
  "numOfHypervisors" : 3,
  "numOfVms" : 33,
  "numOfApplications" : 0,
  "numOfContainers": 0,
  "numOfServices": 0,
  "numOfResources" 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.25.73.71",
    "userId" : "administrator@vsphere.local",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.5.4 Updating Collector

This API updates the user ID and password contained in the specified collector. However, it cannot update a collector for a custom application.

Execution permission

Admin

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/Collectors/{id}

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "password":"...",
            "updatePassword":"...",
            "portNumber":"...",
            "optionalInformation1":"...",
            "updateOptionalInformation1":"...",
            "optionalInformation2":"...",
            "updateOptionalInformation2":"...",
            "optionalInformation3":"...",
            "updateOptionalInformation3":"...",
            "useProxy":"...",
            "proxyHostAddr":"...",
            "proxyPort":"...",
            "proxyUser":"...",
            "updateProxyPassword":"...",
            "proxyPassword":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "rootPassword":"...",
            "updateRootPassword":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "plugin":{
            "instanceID":"..."
        }
}

Collector (Type: Collector)

Attribute

Type

Description

name

string

Collector name

collectorType

enum

Collector type.

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

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

osType

enum

Type of OS. This member is only set when the collectorType is AJS, PFM, or IM.

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

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

collectorCredentials

CollectorCredential[]

Authentication information used for connections to monitoring targets.

plugin

Plugin

Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute

Type

Description

requireHostAddress

boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

ipAddress

string

IP address or host name used for connections to management software.

accessTargetIdentification

string

Access-target identification key (when no IP address is specified)

userId

string

User ID used for connections to management software. Specify a string of 255 or fewer bytes.

password

string

Password used for connections to management software. Encode a string of 255 or fewer bytes in Base64.

updatePassword

boolean

Whether to change the password used for connections to management software.

・true: Password is changed

・false: Password is not changed

If this member is omitted, false is set.

portNumber

int

Port number used for connections to management software.

optionalInformation1

string

Option information for information acquisition that can be used in the plug-in. The value set for the first option. Encode a string in Base64.

updateOptionalInformation1

boolean

To change option 1, set "true". Use this only for updates.

optionalInformation2

string

Option information for information acquisition that can be used in the plug-in. The value set for the second option. Encode a string in Base64.

updateOptionalInformation2

boolean

To change option 2, set "true". Use this only for updates.

optionalInformation3

string

Option information for information acquisition that can be used in the plug-in. The value set for the third option. Encode a string in Base64.

updateOptionalInformation3

boolean

To change option 3, set "true". Use this only for updates.

useProxy

boolean

Specify true when connecting to a custom collector via a proxy.

proxyHostAddr

string

Proxy host address when using a proxy.

proxyPort

int

Proxy port when using a proxy.

proxyUser

string

The authenticated user of the proxy when using the proxy.

updateProxyPassword

boolean

Set true to change the proxy password. Used only when updating.

proxyPassword

string

Proxy authentication password when using a proxy. Encode a string in Base64.

hypertextTransferProtocolType

enum

Whether to use SSL (HTTPS) for connections to management software.

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

The specifiable values are as follows:

HTTP

HTTPS

domainName

string

Domain name: Used for application linkage when Windows is selected.

rootPassword

string

root password: Used for application linkage when Unix is selected.

updateRootPassword

boolean

To change the password, set true. Use only for updates.

useAdministrativeShares

boolean

To share management, set true.

shareName

string

share Name

sharedFolder

string

shared Folder

logicalHostName

string

Logical Host Name

useLogicalHostName

boolean

To use logical host name, set true.

plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "refreshDateForState":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfHosts":"...",
        "numOfApplications":"...",
        "numOfContainers":"...",
        "numOfServices":"...",
        "numOfResources":"...",
        "collectorCredentials":[{
            "requireHostAddress":"...",
            "ipAddress":"...",
            "accessTargetIdentification":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"...",
        "plugin":{
            "instanceID":"...",
            "name":"...",
            "pluginId":"...",
            "protocolType":"...",
            "formatversion":"...",
            "pluginversion":"...",
            "pluginType":"...",
            "numOfRelatedResources":"...",
            "isCollector":"...",
            "status":"..."
        }
}

Collector (Type: Collector)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

name

string

Collector name

collectorType

enum

Collector type.

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

The specifiable values are as follows:

VCENTER

AJS

PFM

IM

CUSTOM

HTTP

osType

enum

Type of OS. This member is only set when the collectorType is AJS, PFM, or IM.

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

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

connectResult

enum

Last execution result of the collector.

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

The specifiable values are as follows:

NoConnect

Succeeded

Failed

refreshStatus

enum

Execution status of the collector.

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

The specifiable values are as follows:

NoConnect

InProgress

message

string

Message of the execution result of the collector

lastRefreshed

dateTime

The date and time when information for the following was last updated:

・refreshDateForInventory

・refreshDateForPerformance

・refreshDateForState

refreshDateForInventory

dateTime

Refresh date and time for the configuration information

refreshDateForPerformance

dateTime

Refresh date and time for the performance information

refreshDateForState

dateTime

Date and time when the state information is to be refreshed. This value can be obtained when all of the following conditions are met:

・The type of collector is VCENTER.

・The collection interval settings of "Status Monitoring (VM/Hypervisor)" are enabled.

numOfHypervisors

int

Number of hypervisors found by the collector

numOfVms

int

Number of virtual machines found by the collector

numOfHosts

int

Number of virtual machines found by the collector

numOfApplications

int

Number of applications found by the collector.

numOfContainers

int

Number of container nodes found by the collector.

numOfServices

int

Number of service resources found by the collector.

numOfResources

int

Number of management resources found by the collector.

collectorCredentials

CollectorCredential[]

Authentication information used for connections to monitoring targets.

productName

string

Collected-product name. This value can be obtained when the collectorType is CUSTOM_APP.

providerName

string

Provider name. This value can be obtained when the collectorType is CUSTOM_APP.

refreshDateForApp

dateTime

Date definition was applied. This value can be obtained when the collectorType is CUSTOM_APP.

plugin

Plugin

Defail information of the plug-in applied to the collector

collectorCredentials (Type: CollectorCredential)

Attribute

Type

Description

requireHostAddress

boolean

A flag that determines if an IP address or host name is required

- true: An IP address is required. An access-target identification key is not required.

- false: An IP address is not required. An access-target identification key is required.

This is used for the HTTP protocol.

ipAddress

string

IP address or host name used for connections to management software.

accessTargetIdentification

string

Access-target identification key (when no IP address is specified)

userId

string

User ID used for connections to management software. Specify a string of 255 or fewer bytes.

portNumber

int

Port number used for connections to management software.

hypertextTransferProtocolType

enum

Whether to use SSL (HTTPS) for connections to management software.

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

The specifiable values are as follows:

HTTP

HTTPS

domainName

string

Domain name: Used for application linkage when Windows is selected.

useAdministrativeShares

boolean

To share management, set true.

shareName

string

share Name

sharedFolder

string

shared Folder

logicalHostName

string

Logical Host Name

useLogicalHostName

boolean

To use logical host name, set true.

plugin (Type: Plugin)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the plug-in

pluginId

string

ID for identifying the plug-in

protocolType

enum

Protocol used for connections to monitoring targets

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

The specifiable values are as follows:

SNMP

formatversion

string

Format version of the plug-in

pluginversion

string

Version of the plug-in

pluginType

enum

Type of the plug-in

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

The specifiable values are as follows:

NODE_PLUGIN

numOfRelatedResources

int

Number of resources found by using the plug-in

isCollector

boolean

Whether it is Collector

status

enum

Status of the plug-in

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

- A format of request body is invalid

- A request is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/Collectors/11 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 482

[Request Body]
{
  "instanceID" : 11,
  "name" : "vCenterMonitoring",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "NoConnect",
  "refreshStatus" : "NoConnect",
  "numOfHypervisors" : 0,
  "numOfVms" : 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.17.17.116",
    "userId" : "Administrator",
    "updatePassword" : true,
    "password" : "c3lzdGVtOm1hbmFnZXI=",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

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

[Response Body]
{
  "instanceID" : 11,
  "name" : "vCenterMonitoring",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "NoConnect",
  "refreshStatus" : "NoConnect",
  "numOfHypervisors" : 0,
  "numOfVms" : 0,
  "numOfApplications" : 0,
  "numOfContainers": 0,
  "numOfServices": 0,
  "numOfResources" 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.17.17.116",
    "userId" : "Administrator",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.5.5 Deleting Collector

This API deletes the specified collector. However, it cannot delete a collector for a custom application.

Execution permission

Admin

API version

v1

Request format

DELETE http[s]://host:port/Analytics/version/objects/Collectors/{id}

Request body

Not applicable.

Response body

Not applicable.

Status codes

Status code

Reason phrase

Description

204

No Content

Success.

400

Bad Request

Resources not to be deleted.

401

Unauthorized

No login privilege.

403

Forbidden

No delete privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
DELETE http://localhost:22015/Analytics/v1/objects/Collectors/0 HTTP/1.1
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 204 No Content
Date: Wed, 07 Dec 2016 10:27:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d5133e9e3ece3f258eda94ad4ed3fc2c8e7eda63_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

Related topics

1.3 Resource members

1.6 List of enumerators

2.6 List of API requests related to collection-interval settings

This section describes operations related to collection-interval settings in the configuration information.

2.6.1 Updating monitoring interval

This API updates the monitoring intervals.

Important note:

- If a short monitoring interval is set, it is more likely that the subsequent collection processing will begin during the preceding collection processing. In such a case, the preceding collection processing will continue and the subsequent collection processing will be skipped.

- In addition to this, in the case of "Configuration Monitoring (Hypervisor/VM)", the subsequent processing will be skipped if one minute has not passed after the preceding processing finished. The elapsed time can be changed in the system property file (Argus.properties). For details, see the section describing the system property file (Argus.properties), in the JP1/Operations Analytics Configuration and Administration Guide.

Execution permission

Admin

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/MonitoringIntervalSettings/1

Request body

The structure of the request body and the object attributes are as follows:

{
        "hypervisorVMEnabled":"...",
        "hypervisorVMInterval":"...",
        "hypervisorVMScheduleCycleType":"...",
        "hypervisorVMStartHour":"...",
        "hypervisorVMStartMinutes":"...",
        "stateOfHypervisorVMEnabled":"...",
        "stateOfHypervisorVMInterval":"..."
}

MonitoringInterval (Type: MonitoringInterval)

Attribute

Type

Description

hypervisorVMEnabled

boolean

Whether Configuration Monitoring (VM/Hypervisor) is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

hypervisorVMInterval

int

Interval between Configuration Monitoring periods (VM/Hypervisor) (minutes/hours/days)

The specifiable values range from 1 to 9999. The execution cycle type is specified by the value for "hypervisorVMScheduleCycleType". If this setting is omitted, the value already set for this item is not changed.

hypervisorVMScheduleCycleType

enum

Type of execution cycle for Configuration Monitoring (VM/Hypervisor)

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

The specifiable values are as follows:

Minutely

Hourly

Daily

hypervisorVMStartHour

int

Start time of Configuration Monitoring (VM/Hypervisor) (hour)

The specifiable values range from 0 to 23. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

hypervisorVMStartMinutes

int

Start time of Configuration Monitoring (VM/Hypervisor) (minute)

The specifiable values range from 0 to 59. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

stateOfHypervisorVMEnabled

boolean

Whether State Monitoring (VM/Hypervisor) is enabled

・ true: Monitoring is enabled.

・ false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

stateOfHypervisorVMInterval

int

Interval between State Monitoring periods (VM/Hypervisor) (minutes)

The specifiable values are 1 to 9999. If this setting is omitted, the value already set for this item is not changed.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "configurationEnabled":"...",
        "configurationLastDuration":"...",
        "configurationMaxDuration":"...",
        "configurationInterval":"...",
        "configurationStartHour":"...",
        "configurationStartMinutes":"...",
        "performanceEnabled":"...",
        "performanceLastDuration":"...",
        "performanceMaxDuration":"...",
        "performanceInterval":"...",
        "hypervisorVMEnabled":"...",
        "hypervisorVMLastDuration":"...",
        "hypervisorVMMaxDuration":"...",
        "hypervisorVMInterval":"...",
        "hypervisorVMScheduleCycleType":"...",
        "hypervisorVMStartHour":"...",
        "hypervisorVMStartMinutes":"...",
        "applicationEventEnabled":"...",
        "applicationEventLastDuration":"...",
        "applicationEventMaxDuration":"...",
        "applicationEventInterval":"...",
        "stateOfHypervisorVMEnabled":"...",
        "stateOfHypervisorVMLastDuration":"...",
        "stateOfHypervisorVMMaxDuration":"...",
        "stateOfHypervisorVMInterval":"..."
}

MonitoringInterval (Type: MonitoringInterval)

Attribute

Type

Description

instanceID

long

Instance ID

configurationEnabled

boolean

Whether Configuration Monitoring is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

configurationLastDuration

int

Length of the most recent Configuration Monitoring period (minutes)

If collection was never performed, -1 is returned.

configurationMaxDuration

int

Length of the longest Configuration Monitoring period (minutes)

If collection has never been done, -1 is returned.

configurationInterval

int

Interval between Configuration Monitoring periods (days)

configurationStartHour

int

Start time of Configuration Monitoring (hour)

configurationStartMinutes

int

Start time of Configuration Monitoring (minute)

performanceEnabled

boolean

Whether Performance Monitoring is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

performanceLastDuration

int

Length of the most recent Performance Monitoring period (minutes)

If collection has never been done, -1 is returned.

performanceMaxDuration

int

Length of the longest Performance Monitoring period (minutes)

If collection has never been done, -1 is returned.

performanceInterval

int

Interval between Performance Monitoring periods (minutes)

hypervisorVMEnabled

boolean

Whether Configuration Monitoring (VM/Hypervisor) is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

hypervisorVMLastDuration

int

Length of the most recent Configuration Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

hypervisorVMMaxDuration

int

Length of the longest Configuration Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

hypervisorVMInterval

int

Interval between Configuration Monitoring periods (VM/Hypervisor) (minutes/hours/days)

The specifiable values range from 1 to 9999. The execution cycle type is specified by the value for "hypervisorVMScheduleCycleType". If this setting is omitted, the value already set for this item is not changed.

hypervisorVMScheduleCycleType

enum

Type of execution cycle for Configuration Monitoring (VM/Hypervisor)

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

The specifiable values are as follows:

Minutely

Hourly

Daily

hypervisorVMStartHour

int

Start time of Configuration Monitoring (VM/Hypervisor) (hour)

The specifiable values range from 0 to 23. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

hypervisorVMStartMinutes

int

Start time of Configuration Monitoring (VM/Hypervisor) (minute)

The specifiable values range from 0 to 59. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

applicationEventEnabled

boolean

Whether Event Monitoring (Application) is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

applicationEventLastDuration

int

Length of the most recent Event Monitoring period (Application) (minutes)

If collection has never been done, -1 is returned.

applicationEventMaxDuration

int

Length of the longest Event Monitoring period (Application) (minutes)

If collection has never been done, -1 is returned.

applicationEventInterval

int

Interval between Event Monitoring periods (Application) (minutes)

stateOfHypervisorVMEnabled

boolean

Whether State Monitoring (VM/Hypervisor) is enabled

・ true: Monitoring is enabled.

・ false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

stateOfHypervisorVMLastDuration

int

Length of the most recent State Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

stateOfHypervisorVMMaxDuration

int

Length of the longest State Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

stateOfHypervisorVMInterval

int

Interval between State Monitoring periods (VM/Hypervisor) (minutes)

The specifiable values are 1 to 9999. If this setting is omitted, the value already set for this item is not changed.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

- A format of request body is invalid

- A request is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/MonitoringIntervalSettings/1 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 263

[Request Body]
{
"hypervisorVMEnabled": true,
"hypervisorVMInterval": 5,
"hypervisorVMScheduleCycleType": "Minutely",
"hypervisorVMStartHour": 0,
"hypervisorVMStartMinutes": 0,
"stateOfHypervisorVMEnabled": true,
"stateOfHypervisorVMInterval": 1
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4afe674fe8a4e569aa824d8786b0ac5b53e4a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"instanceID": 1,
"configurationEnabled": true,
"configurationLastDuration": -1,
"configurationMaxDuration": -1,
"configurationInterval": 1,
"configurationStartHour": 0,
"configurationStartMinutes": 45,
"performanceEnabled": true,
"performanceLastDuration": -1,
"performanceMaxDuration": -1,
"performanceInterval": 5,
"hypervisorVMEnabled": true,
"hypervisorVMLastDuration": -1,
"hypervisorVMMaxDuration": -1,
"hypervisorVMInterval": 5,
"hypervisorVMScheduleCycleType": "Minutely",
"hypervisorVMStartHour": 0,
"hypervisorVMStartMinutes": 0,
"applicationEventEnabled": true,
"applicationEventLastDuration": -1,
"applicationEventMaxDuration": -1,
"applicationEventInterval": 5,
"stateOfHypervisorVMEnabled": true,
"stateOfHypervisorVMLastDuration": -1,
"stateOfHypervisorVMMaxDuration": -1,
"stateOfHypervisorVMInterval": 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.6.2 Getting monitoring interval information

This API acquires the monitoring interval information.

Execution permission

Admin

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "configurationEnabled":"...",
            "configurationLastDuration":"...",
            "configurationMaxDuration":"...",
            "configurationInterval":"...",
            "configurationStartHour":"...",
            "configurationStartMinutes":"...",
            "performanceEnabled":"...",
            "performanceLastDuration":"...",
            "performanceMaxDuration":"...",
            "performanceInterval":"...",
            "hypervisorVMEnabled":"...",
            "hypervisorVMLastDuration":"...",
            "hypervisorVMMaxDuration":"...",
            "hypervisorVMInterval":"...",
            "hypervisorVMScheduleCycleType":"...",
            "hypervisorVMStartHour":"...",
            "hypervisorVMStartMinutes":"...",
            "applicationEventEnabled":"...",
            "applicationEventLastDuration":"...",
            "applicationEventMaxDuration":"...",
            "applicationEventInterval":"...",
            "stateOfHypervisorVMEnabled":"...",
            "stateOfHypervisorVMLastDuration":"...",
            "stateOfHypervisorVMMaxDuration":"...",
            "stateOfHypervisorVMInterval":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

MonitoringInterval[]

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

Attribute

Type

Description

instanceID

long

Instance ID

configurationEnabled

boolean

Whether Configuration Monitoring is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

configurationLastDuration

int

Length of the most recent Configuration Monitoring period (minutes)

If collection was never performed, -1 is returned.

configurationMaxDuration

int

Length of the longest Configuration Monitoring period (minutes)

If collection has never been done, -1 is returned.

configurationInterval

int

Interval between Configuration Monitoring periods (days)

configurationStartHour

int

Start time of Configuration Monitoring (hour)

configurationStartMinutes

int

Start time of Configuration Monitoring (minute)

performanceEnabled

boolean

Whether Performance Monitoring is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

performanceLastDuration

int

Length of the most recent Performance Monitoring period (minutes)

If collection has never been done, -1 is returned.

performanceMaxDuration

int

Length of the longest Performance Monitoring period (minutes)

If collection has never been done, -1 is returned.

performanceInterval

int

Interval between Performance Monitoring periods (minutes)

hypervisorVMEnabled

boolean

Whether Configuration Monitoring (VM/Hypervisor) is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

hypervisorVMLastDuration

int

Length of the most recent Configuration Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

hypervisorVMMaxDuration

int

Length of the longest Configuration Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

hypervisorVMInterval

int

Interval between Configuration Monitoring periods (VM/Hypervisor) (minutes/hours/days)

The specifiable values range from 1 to 9999. The execution cycle type is specified by the value for "hypervisorVMScheduleCycleType". If this setting is omitted, the value already set for this item is not changed.

hypervisorVMScheduleCycleType

enum

Type of execution cycle for Configuration Monitoring (VM/Hypervisor)

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

The specifiable values are as follows:

Minutely

Hourly

Daily

hypervisorVMStartHour

int

Start time of Configuration Monitoring (VM/Hypervisor) (hour)

The specifiable values range from 0 to 23. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

hypervisorVMStartMinutes

int

Start time of Configuration Monitoring (VM/Hypervisor) (minute)

The specifiable values range from 0 to 59. If this setting is omitted, the value already set for this item is not changed. This value can be specified only when the value of the "hypervisorVMScheduleCycleType" member is "Daily".

applicationEventEnabled

boolean

Whether Event Monitoring (Application) is enabled

・true: Monitoring is enabled.

・false: Monitoring is disabled.

applicationEventLastDuration

int

Length of the most recent Event Monitoring period (Application) (minutes)

If collection has never been done, -1 is returned.

applicationEventMaxDuration

int

Length of the longest Event Monitoring period (Application) (minutes)

If collection has never been done, -1 is returned.

applicationEventInterval

int

Interval between Event Monitoring periods (Application) (minutes)

stateOfHypervisorVMEnabled

boolean

Whether State Monitoring (VM/Hypervisor) is enabled

・ true: Monitoring is enabled.

・ false: Monitoring is disabled.

If this setting is omitted, the value already set for this item is not changed.

stateOfHypervisorVMLastDuration

int

Length of the most recent State Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

stateOfHypervisorVMMaxDuration

int

Length of the longest State Monitoring period (VM/Hypervisor) (minutes)

If collection has never been done, -1 is returned.

stateOfHypervisorVMInterval

int

Interval between State Monitoring periods (VM/Hypervisor) (minutes)

The specifiable values are 1 to 9999. If this setting is omitted, the value already set for this item is not changed.

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/MonitoringIntervalSettings 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 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO b9719717b548c1da1798ed5a2b2c22dbda7f40cd_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"data": [{
"instanceID": 1,
"configurationEnabled": true,
"configurationLastDuration": -1,
"configurationMaxDuration": -1,
"configurationInterval": 1,
"configurationStartHour": 0,
"configurationStartMinutes": 45,
"performanceEnabled": true,
"performanceLastDuration": 1,
"performanceMaxDuration": 1,
"performanceInterval": 5,
"hypervisorVMEnabled": true,
"hypervisorVMLastDuration": 1,
"hypervisorVMMaxDuration": 1,
"hypervisorVMInterval": 5,
"hypervisorVMScheduleCycleType": "Minutely",
"hypervisorVMStartHour": 0,
"hypervisorVMStartMinutes": 0,
"applicationEventEnabled": true,
"applicationEventLastDuration": -1,
"applicationEventMaxDuration": -1,
"applicationEventInterval": 5,
"stateOfHypervisorVMEnabled": true,
"stateOfHypervisorVMLastDuration": 1,
"stateOfHypervisorVMMaxDuration": 1,
"stateOfHypervisorVMInterval": 1
}],
"count": 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.7 List of API requests related to information about user settings

This section describes the operations that a user can perform on the settings information set by the user.

2.7.1 Acquiring a List of Custom Settings of a User

This REST API request acquires a list of custom settings specified by the user executing the request.

Execution permission

Admin, Modify, User Management

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "userName":"...",
            "guiDisplayParams":[{
                "screenKey":"...",
                "screenSettingValue":"..."
            },
            :
            ]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

UserCustomSetting[]

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

Attribute

Type

Description

instanceID

long

ID of User Custom Setting

userName

string

User name

guiDisplayParams

GuiDisplayParam[]

List of GUI display parameters set by the user

guiDisplayParams (Type: GuiDisplayParam)

Attribute

Type

Description

screenKey

string

screen key

screenSettingValue

string

setting value for the screen display

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.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/UserCustomSettings HTTP/1.1
Host: localhost:22015
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Firefox/52.0
Accept: */*
Accept-Language: null, ja,en-US
Accept-Encoding: gzip, deflate
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Type: application/json
Cookie: JSESSIONID=00ACFB0B9CF2A67FD2724B793D244887
Connection: keep-alive

[Response Header]
HTTP/1.1 200 OK
Date: Tue, 31 Jul 2018 01:11:10 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1ef367971b91c5a6d0af1c4ab214df556f56d8bb_Vlo8Y30Idg1+cQNsGHkUbQxzBA0=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 12904

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "userName" : "System",
    "guiDisplayParams" : [ {
      "screenKey" : "dashboard.settings.autoRefresh",
      "screenSettingValue" : "1"
    }, {
      "screenKey" : "dashboard.settings",
      "screenSettingValue" : "{\"defs\":[{\"id\":\"AllResourcesStatusApplication\",\"data\"...}"
    } ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.7.2 Specifying Settings for a User

This REST API request specifies or overwrites the custom settings for the user executing the API request. This REST API request cannot be used to specify settings for users other than the user executing the request.

Execution permission

Admin, Modify, User Management

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/UserCustomSettings

Request body

The structure of the request body and the object attributes are as follows:

{
        "guiDisplayParams":[{
            "screenKey":"...",
            "screenSettingValue":"..."
        },
        :
        ]
}

UserCustomSetting (Type: UserCustomSetting)

Attribute

Type

Description

guiDisplayParams

GuiDisplayParam[]

List of GUI display parameters set by the user

guiDisplayParams (Type: GuiDisplayParam)

Attribute

Type

Description

screenKey

string

screen key

screenSettingValue

string

setting value for the screen display

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "userName":"...",
        "guiDisplayParams":[{
            "screenKey":"...",
            "screenSettingValue":"..."
        },
        :
        ]
}

UserCustomSetting (Type: UserCustomSetting)

Attribute

Type

Description

instanceID

long

ID of User Custom Setting

userName

string

User name

guiDisplayParams

GuiDisplayParam[]

List of GUI display parameters set by the user

guiDisplayParams (Type: GuiDisplayParam)

Attribute

Type

Description

screenKey

string

screen key

screenSettingValue

string

setting value for the screen display

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST http://localhost:22015/Analytics/v1/objects/UserCustomSettings/ HTTP/1.1
Host: localhost:22015
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64; rv:52.0) Gecko/20100101 Firefox/52.0
Accept: application/json, text/javascript, */*; q=0.01
Accept-Language: ja,en-US;q=0.7,en;q=0.3
Accept-Encoding: gzip, deflate
Content-Type: application/json; charset=utf-8
Authorization: HSSO a8325764f8fbf4b384a997f811c9e40cc81f3b6_Vlo8Y30Idg1+cQNsGHkUbQxzBA0=_V0810
X-Requested-With: XMLHttpRequest
Referer: http://localhost:22015/Analytics/main.htm
Content-Length: 12697
Cookie: JSESSIONID=00ACFB0B9CF2A67FD2724B793D244887
Connection: keep-alive

[Request Body]
{
  "guiDisplayParams":[
    {
      "screenKey":"dashboard.settings",
      "screenSettingValue":"{\"defs\":[{\"id\":\"AllResourcesStatusApplication\",\"data\"..."
    },{
      "screenKey":"dashboard.settings.autoRefresh",
      "screenSettingValue":"2"
    }
  ]
}

[Response Header]
HTTP/1.1 201 Created
Date: Tue, 31 Jul 2018 00:58:51 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a8325764f8fbf4b384a997f811c9e40cc81f3b6_Vlo8Y30Idg1+cQNsGHkUbQxzBA0=_V0810
Location: http://localhost:22015/Analytics/v1/objects/UserCustomSettings//0
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=98
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 12847

[Response Body]
{
  "instanceID" : 0,
  "userName" : "System",
  "guiDisplayParams" : [ {
    "screenKey" : "dashboard.settings.autoRefresh",
    "screenSettingValue" : "2"
  }, {
    "screenKey" : "dashboard.settings",
    "screenSettingValue" : "{\"defs\":[{\"id\":\"AllResourcesStatusApplication\",\"data\"...}"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.7.3 Acquiring a List of Operations for the Custom Settings of a User

This API request acquires a list of operations that can be performed for the custom settings of a user.

Execution permission

User Management

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/UserCustomSettings/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/UserCustomSettings/actions HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:36:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 38b785fe1f2c64401d1f55c39985a241d4e6079_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "clearUserCustomSetting",
    "href" : "http://JP1OAServer:22015/Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.7.4 Collecting Information Necessary for Deleting the Custom Settings of a User

This API request collects information necessary to delete the custom settings of a user.

Execution permission

User Management

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/UserCustomSettings/actions/clearUserCustomSetting

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "userName":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

UserCustomSetting[]

A list of UserCustomSetting objects necessary to execute an operation. For details about UserCustomSetting, see the table below.

parameters (Type: UserCustomSetting)

Attribute

Type

Description

userName

string

User name

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/services/UserCustomSettings/actions/clearUserCustomSetting HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:37:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO e81125df712d954ea361376cc1bcbb72131e30_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "clearUserCustomSetting",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "userName" : "System"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.7.5 Deleting the Custom Settings of a User

This API request deletes the custom settings of the specified user.

Execution permission

User Management

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/UserCustomSettings/actions/clearUserCustomSetting/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "userName":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

UserCustomSetting[]

A list of UserCustomSetting objects necessary to execute an operation. For details about UserCustomSetting, see the table below.

parameters (Type: UserCustomSetting)

Attribute

Type

Description

userName

string

User name

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

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]
POST /Analytics/v1/services/UserCustomSettings/actions/clearUserCustomSetting/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja
Content-Length: 58

[Request Body]
{
  "parameters": [
    {
      "userName": "System"
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:37:11 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1cfc6a016c968938dfd84aebbf07a38b7a24639_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "e34ef37d-95f8-48ea-a7f1-7208971134bb",
  "created" : "2019-09-06T18:37:11.681+09:00",
  "updated" : "2019-09-06T18:37:11.745+09:00",
  "completed" : "2019-09-06T18:37:11.745+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8 List of API requests related to user profiles

This section describes the operations for user profiles used by JP1/OA for the monitoring of monitoring targets.

2.8.1 Obtaining User Profile List

This API acquires a list of user profiles.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "profileName":"...",
            "description":"...",
            "resourceType":"...",
            "profileType":"...",
            "thresholdValues":[{
                "instanceID":"...",
                "monitoring":"...",
                "metricType":"...",
                "pluginMetricType":"...",
                "displayName":"...",
                "unit":"...",
                "proportion":"...",
                "thresholdValueOfWarning":"...",
                "thresholdValueOfError":"...",
                "stepSize":"...",
                "max":"...",
                "min":"..."
            },
            :
            ],
            "numOfResources":"...",
            "autoAssignFilters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

UserThresholdProfile[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances.

profileName

string

User profile name. Use 128 or fewer characters.

description

string

Description of the user profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the user profile can be applied. The following value can be specified.

・VM: Virtual machine

・VOLUME: Volume

・WINDOWS: Windows

・LINUX_UNIX: Linux/UNIX

profileType

string

Change type of the user profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

UserThresholdValue[]

Details of the threshold set in the user profile.

numOfResources

int

Number of resources to which the user profile is assigned

autoAssignFilters

string[]

Name of the automatic assignment rule

thresholdValues (Type: UserThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold

unit

string

String indicating the unit of the threshold

proportion

boolean

Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for showing errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

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.

400

Bad Request

A query parameter is invalid.

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/UserThresholdProfiles 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 05:42:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ef807fefafe4f3d3f3058e252907ae61ed6a63a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 62,
  "profileName" : "Default Profile for Volume",
  "description" : "Default Profile for Volume",
  "resourceType" : "VOLUME",
  "profileType" : "User",
  "thresholdValues" : [ {
  "  instanceID" : 763,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_IO_RATE",
    "displayName" : "Volume IOPS ",
    "unit" : "transfers/sec",
    "proportion" : false,
    "thresholdValueOfWarning" : 0.0,
    "thresholdValueOfError" : 2222.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 761,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
    "displayName" : "Volume IO Rate",
    "unit" : "MBps",
    "proportion" : false,
    "thresholdValueOfWarning" : 421.0,
    "thresholdValueOfError" : 450.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 762,
    "monitoring" : true,
    "metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
    "displayName" : "Volume Response Time Per IO Request",
    "unit" : "msec/transfer",
    "proportion" : false,
    "thresholdValueOfWarning" : 499.9,
    "thresholdValueOfError" : 500.1,
    "stepSize" : 0.1,
    "max" : 3.4028235E38,
    "min" : 0.0
  } ],
  "numOfResources" : 0,
  "autoAssignFilters" : [ ],
  "originalThresholdProfileID" : 62
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.2 Obtaining User Profile Information

This API acquires information about the specified user profile.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

profileName

string

User profile name. Use 128 or fewer characters.

description

string

Description of the user profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the user profile can be applied. The following value can be specified.

・VM: Virtual machine

・VOLUME: Volume

・WINDOWS: Windows

・LINUX_UNIX: Linux/UNIX

profileType

string

Change type of the user profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

UserThresholdValue[]

Details of the threshold set in the user profile.

numOfResources

int

Number of resources to which the user profile is assigned

autoAssignFilters

string[]

Name of the automatic assignment rule

thresholdValues (Type: UserThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold

unit

string

String indicating the unit of the threshold

proportion

boolean

Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for showing errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles/62 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:19:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO fe84f16f0bb366a0b4d1226353e169d76c5ee_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 62,
  "profileName" : "XX System VM Threshold Profile",
  "description" : "performance threshold profile for XX system VM",
  "resourceType" : "VM",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 1026,
    "monitoring" : true,
    "metricType" : "ESX_VM_SIMPLE_CPU_LOAD",
    "displayName" : "Virtual Machine CPU Use",
    "unit" : "%",
    "proportion" : false,
    "thresholdValueOfWarning" : 75.0,
    "thresholdValueOfError" : 90.0,
    "stepSize" : 1.0,
    "max" : 100.0,
    "min" : 0.0
  }, {
    "instanceID" : 1040,
    "monitoring" : true,
    "metricType" : "ESX_VM_CPU_TOTAL_READY",
    "displayName" : "Virtual Machine CPU Ready",
    "unit" : "%",
    "proportion" : false,
    "thresholdValueOfWarning" : 4.0,
    "thresholdValueOfError" : 5.0,
    "stepSize" : 1.0,
    "max" : 100.0,
    "min" : 0.0
  }, {
    "instanceID" : 1023,
    "monitoring" : true,
    "metricType" : "ESX_VM_CPU_USAGEMHZ",
    "displayName" : "Virtual Machine CPU Use (MHz)",
    "unit" : "MHz",
    "proportion" : false,
    "thresholdValueOfWarning" : 3.5,
    "thresholdValueOfError" : 5.0,
    "stepSize" : 1.0,
    "max" : 9.99999999999998E13,
    "min" : 0.0
  },
    .......
  },
    .......
  } ],
  "numOfResources" : 3,
  "autoAssignFilters" : [ "XX System VM" ],
  "originalThresholdProfileID" : 62
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.3 Creating User Profile

This API creates a user profile.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/UserThresholdProfiles

Request body

The structure of the request body and the object attributes are as follows:

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

UserThresholdProfile (Type: UserThresholdProfile)

Attribute

Type

Description

profileName

string

User profile name. Use 128 or fewer characters.

description

string

Description of the user profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the user profile can be applied. The following value can be specified.

・VM: Virtual machine

・VOLUME: Volume

・WINDOWS: Windows

・LINUX_UNIX: Linux/UNIX

profileType

string

Change type of the user profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

UserThresholdValue[]

Details of the threshold set in the user profile.

thresholdValues (Type: UserThresholdValue)

Attribute

Type

Description

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold

unit

string

String indicating the unit of the threshold

proportion

boolean

Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for showing errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

profileName

string

User profile name. Use 128 or fewer characters.

description

string

Description of the user profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the user profile can be applied. The following value can be specified.

・VM: Virtual machine

・VOLUME: Volume

・WINDOWS: Windows

・LINUX_UNIX: Linux/UNIX

profileType

string

Change type of the user profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

UserThresholdValue[]

Details of the threshold set in the user profile.

numOfResources

int

Number of resources to which the user profile is assigned

autoAssignFilters

string[]

Name of the automatic assignment rule

thresholdValues (Type: UserThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold

unit

string

String indicating the unit of the threshold

proportion

boolean

Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for showing errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/UserThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 1330

[Request Body]
{
  "profileName": "Default Profile for Volume",
  "description": "Default Profile for Volume",
  "resourceType": "VOLUME",
  "profileType": "User",
  "thresholdValues": [
    {
      "instanceID": 763,
      "monitoring": false,
      "metricType": "STO_VOLUME_TOTAL_IO_RATE",
      "displayName": "Volume IOPS",
      "unit": "transfers/sec",
      "proportion": false,
      "thresholdValueOfWarning": 0,
      "thresholdValueOfError": 2222,
      "stepSize": 1,
      "max": 3.4028235e+38,
      "min": 0
    },
    {
      "instanceID": 761,
      "monitoring": false,
      "metricType": "STO_VOLUME_TOTAL_XFER_RATE",
      "displayName": "Volume IO Rate",
      "unit": "MBps",
      "proportion": false,
      "thresholdValueOfWarning": 421,
      "thresholdValueOfError": 450,
      "stepSize": 1,
      "max": 3.4028235e+38,
      "min": 0
    },
    {
      "instanceID": 762,
      "monitoring": true,
      "metricType": "STO_IO_RESPONSE_TIME_ON_CTRL0",
      "displayName": "Volume Response Time Per IO Request",
      "unit": "msec/transfer",
      "proportion": false,
      "thresholdValueOfWarning": 499.9,
      "thresholdValueOfError": 500.1,
      "stepSize": 0.1,
      "max": 3.4028235e+38,
      "min": 0
    }
  ],
  "originalThresholdProfileID" : 62
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 07:59:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 92912a219d69363f390aa8d6fa84157ab1e58d6_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/63
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID": 63,
  "profileName": "Default Profile for Volume",
  "description": "Default Profile for Volume",
  "resourceType": "VOLUME",
  "profileType": "User",
  "thresholdValues": [
    {
      "instanceID": 769,
      "monitoring": false,
      "metricType": "STO_VOLUME_TOTAL_IO_RATE",
      "displayName": "Volume IOPS",
      "unit": "transfers/sec",
      "proportion": false,
      "thresholdValueOfWarning": 0,
      "thresholdValueOfError": 2222,
      "stepSize": 1,
      "max": 3.4028235e+38,
      "min": 0
    },
    {
      "instanceID": 768,
      "monitoring": false,
      "metricType": "STO_VOLUME_TOTAL_XFER_RATE",
      "displayName": "Volume IO Rate",
      "unit": "MBps",
      "proportion": false,
      "thresholdValueOfWarning": 421,
      "thresholdValueOfError": 450,
      "stepSize": 1,
      "max": 3.4028235e+38,
      "min": 0
    },
    {
      "instanceID": 767,
      "monitoring": true,
      "metricType": "STO_IO_RESPONSE_TIME_ON_CTRL0",
      "displayName": "Volume Response Time Per IO Request",
      "unit": "msec/transfer",
      "proportion": false,
      "thresholdValueOfWarning": 499.9,
      "thresholdValueOfError": 500.1,
      "stepSize": 0.1,
      "max": 3.4028235e+38,
      "min": 0
    }
  ],
  "numOfResources": 0,
  "autoAssignFilters": [],
  "originalThresholdProfileID" : 62
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.4 Updating User Profile

This API updates the specified user profile.

Execution permission

Admin, Modify

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

Request body

The structure of the request body and the object attributes are as follows:

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

UserThresholdProfile (Type: UserThresholdProfile)

Attribute

Type

Description

profileName

string

User profile name. Use 128 or fewer characters.

description

string

Description of the user profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the user profile can be applied. The following value can be specified.

・VM: Virtual machine

・VOLUME: Volume

・WINDOWS: Windows

・LINUX_UNIX: Linux/UNIX

profileType

string

Change type of the user profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

UserThresholdValue[]

Details of the threshold set in the user profile.

thresholdValues (Type: UserThresholdValue)

Attribute

Type

Description

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold

unit

string

String indicating the unit of the threshold

proportion

boolean

Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for showing errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

Attribute

Type

Description

instanceID

long

ID for identifying instances.

profileName

string

User profile name. Use 128 or fewer characters.

description

string

Description of the user profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the user profile can be applied. The following value can be specified.

・VM: Virtual machine

・VOLUME: Volume

・WINDOWS: Windows

・LINUX_UNIX: Linux/UNIX

profileType

string

Change type of the user profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

UserThresholdValue[]

Details of the threshold set in the user profile.

numOfResources

int

Number of resources to which the user profile is assigned

autoAssignFilters

string[]

Name of the automatic assignment rule

thresholdValues (Type: UserThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold

unit

string

String indicating the unit of the threshold

proportion

boolean

Direction of the threshold.

true: When the measured value falls below the threshold, an error or warning occurs.

false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for showing errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/UserThresholdProfiles/63 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 1331

[Request Body]
{
  "instanceID" : 63,
  "profileName" : "Default Profile for Volume",
  "description" : "Default Profile for Volume",
  "resourceType" : "VOLUME",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 763,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_IO_RATE",
    "displayName" : "Volume IOPS",
    "unit" : "transfers/sec",
    "proportion" : false,
    "thresholdValueOfWarning" : 0.0,
    "thresholdValueOfError" : 2222.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 761,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
    "displayName" : "Volume IO Rate",
    "unit" : "MBps",
    "proportion" : false,
    "thresholdValueOfWarning" : 421.0,
    "thresholdValueOfError" : 450.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 762,
    "monitoring" : true,
    "metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
    "displayName" : "Volume Response Time Per IO Request",
    "unit" : "msec/transfer",
    "proportion" : false,
    "thresholdValueOfWarning" : 499.9,
    "thresholdValueOfError" : 500.1,
    "stepSize" : 0.1,
    "max" : 3.4028235E38,
    "min" : 0.0
  } ],
  "numOfResources" : 0,
  "autoAssignFilters" : [ ],
  "originalThresholdProfileID" : 62
}

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

[Response Body]
{
  "instanceID" : 63,
  "profileName" : "Default Profile for Volume",
  "description" : "Default Profile for Volume",
  "resourceType" : "VOLUME",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 769,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_IO_RATE",
    "displayName" : "Volume IOPS",
    "unit" : "transfers/sec",
    "proportion" : false,
    "thresholdValueOfWarning" : 0.0,
    "thresholdValueOfError" : 2222.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 768,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
    "displayName" : "Volume IO Rate",
    "unit" : "MBps",
    "proportion" : false,
    "thresholdValueOfWarning" : 421.0,
    "thresholdValueOfError" : 450.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 767,
    "monitoring" : true,
    "metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
    "displayName" : "Volume Response Time Per IO Request",
    "unit" : "msec/transfer",
    "proportion" : false,
    "thresholdValueOfWarning" : 499.9,
    "thresholdValueOfError" : 500.1,
    "stepSize" : 0.1,
    "max" : 3.4028235E38,
    "min" : 0.0
  } ],
  "numOfResources" : 0,
  "autoAssignFilters" : [ ],
  "originalThresholdProfileID" : 62
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.5 Delete User Profiles

This API deletes the specified user profile. The default user profile is reassigned to the monitored resource to which the deleted user profile is assigned.

Execution permission

Admin, Modify

API version

v1

Request format

DELETE http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

Request body

Not applicable.

Response body

Not applicable.

Status codes

Status code

Reason phrase

Description

204

No Content

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No delete privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
DELETE /Analytics/v1/objects/UserThresholdProfiles/63 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 204 No Content
Date: Fri, 27 Nov 2015 11:24:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ca54892ac23952deaf9c5aa71d7eb117d5f5e0c1_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.6 Obtaining User Profile Operation

This API acquires a list of executable operations for the specified user profile.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/UserThresholdProfiles/62/actions 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 08:52:29 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6e5ebd331dec95678b4ba4fa76694f61b8bb7_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "updateTargetResource",
    "href" : "http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.7 Obtaining User Profile Allocation Information

This API acquires information required for assigning the specified user profile to a monitored resource.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}/actions/updateTargetResource

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "instanceID":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

InstanceID[]

A list of InstanceID objects necessary to execute an operation. For details about InstanceID, see the table below.

parameters (Type: InstanceID)

Attribute

Type

Description

instanceID

long

InstanceID

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource 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 09:01:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5c177954bed8e8afe14a6e3b6c9e7607d453e1_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.8.8 Allocating User Profile

This API assigns the specified user profile to monitoring targets.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}/actions/updateTargetResource/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "instanceID":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

InstanceID[]

A list of InstanceID objects necessary to execute an operation. For details about InstanceID, see the table below.

parameters (Type: InstanceID)

Attribute

Type

Description

instanceID

long

InstanceID

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 251

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 540
  },{
    "instanceID" : 541
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:16:00 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 64b88abff57b911327c0d26c6394beea311ae7a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "7bdbb872-18a0-42dd-9481-51ca3f66758c",
  "created" : "2015-11-27T18:16:00.996+09:00",
  "updated" : "2015-11-27T18:16:01.372+09:00",
  "completed" : "2015-11-27T18:16:01.373+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9 List of API requests related to system profiles

This section describes the operations for system profiles used by JP1/OA for the monitoring of monitoring targets.

2.9.1 Obtaining System Profile List

This API acquires a list of system profiles.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "profileName":"...",
            "description":"...",
            "resourceType":"...",
            "profileType":"...",
            "thresholdValues":[{
                "instanceID":"...",
                "monitoring":"...",
                "metricType":"...",
                "pluginMetricType":"...",
                "displayName":"...",
                "unit":"...",
                "proportion":"...",
                "thresholdValueOfWarning":"...",
                "thresholdValueOfError":"...",
                "stepSize":"...",
                "max":"...",
                "min":"..."
            },
            :
            ],
            "numOfResources":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

SystemThresholdProfile[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances

profileName

string

System profile name. Use 128 or fewer characters.

description

string

Description of the system profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the system profile can be applied. The following value can be specified.

・ESX: ESX

・HYPERV: Hyper-V

・IPSWITCH: IP Switch

・FCSWITCH: FC Switch

・CLUSTER: Clutser

profileType

string

Change type of the system profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

SystemThresholdValue[]

Details of the threshold set in the system profile.

numOfResources

int

Number of resources to which the system profile is assigned

thresholdValues (Type: SystemThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold.

unit

string

String indicating the unit of the threshold.

proportion

boolean

Direction of the threshold.

・true: When the measured value falls below the threshold, an error or warning occurs.

・false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for displaying errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

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.

400

Bad Request

A query parameter is invalid.

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/SystemThresholdProfiles 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 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d4ca28827d6fe35b964eeece674e3fbda29b5a11_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 23,
    "profileName" : "Default Profile for Hyper-V",
    "description" : "Default Profile for Hyper-V",
    "resourceType" : "HYPERV",
    "profileType" : "Default",
    "thresholdValues" : [ {
      "instanceID" : 539,
      "monitoring" : true,
      "metricType" : "WIN_CPU_LOAD",
      "displayName" : "CPU Use",
      "unit" : "%",
      "proportion" : false,
      "thresholdValueOfWarning" : 80.0,
      "thresholdValueOfError" : 90.0,
      "stepSize" : 1.0,
      "max" : 100.0,
      "min" : 0.0
    }, {
      ..........
    },
    ..........
  ],
  "numOfResources" : 0,
  "originalThresholdProfileID" : 23
}
  "count" : 8
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.2 Obtaining System Profile Information

This API acquires information about the specified system profile.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

Attribute

Type

Description

instanceID

long

ID for identifying instances

profileName

string

System profile name. Use 128 or fewer characters.

description

string

Description of the system profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the system profile can be applied. The following value can be specified.

・ESX: ESX

・HYPERV: Hyper-V

・IPSWITCH: IP Switch

・FCSWITCH: FC Switch

・CLUSTER: Clutser

profileType

string

Change type of the system profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

SystemThresholdValue[]

Details of the threshold set in the system profile.

numOfResources

int

Number of resources to which the system profile is assigned

thresholdValues (Type: SystemThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold.

unit

string

String indicating the unit of the threshold.

proportion

boolean

Direction of the threshold.

・true: When the measured value falls below the threshold, an error or warning occurs.

・false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for displaying errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles/23 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:19:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 15b057d2c5566e657ce642a6811075512e0cb95_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID": 23,
  "profileName": "Default Profile for Hyper-V",
  "description": "Default Profile for Hyper-V",
  "resourceType": "HYPERV",
  "profileType": "Default",
  "thresholdValues": [
    {
      "instanceID": 539,
      "monitoring": true,
      "metricType": "WIN_CPU_LOAD",
      "displayName": "CPU Use",
      "unit": "%",
      "proportion": false,
      "thresholdValueOfWarning": 80,
      "thresholdValueOfError": 90,
      "stepSize": 1,
      "max": 100,
      "min": 0
    }, {
      .......
    },
    .......
  ],
  "numOfResources": 1,
  "originalThresholdProfileID" : 23
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.3 Creating System Profile

This API creates a system profile.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles

Request body

The structure of the request body and the object attributes are as follows:

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

SystemThresholdProfile (Type: SystemThresholdProfile)

Attribute

Type

Description

profileName

string

System profile name. Use 128 or fewer characters.

description

string

Description of the system profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the system profile can be applied. The following value can be specified.

・ESX: ESX

・HYPERV: Hyper-V

・IPSWITCH: IP Switch

・FCSWITCH: FC Switch

・CLUSTER: Clutser

profileType

string

Change type of the system profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

SystemThresholdValue[]

Details of the threshold set in the system profile.

thresholdValues (Type: SystemThresholdValue)

Attribute

Type

Description

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold.

unit

string

String indicating the unit of the threshold.

proportion

boolean

Direction of the threshold.

・true: When the measured value falls below the threshold, an error or warning occurs.

・false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for displaying errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

Attribute

Type

Description

instanceID

long

ID for identifying instances

profileName

string

System profile name. Use 128 or fewer characters.

description

string

Description of the system profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the system profile can be applied. The following value can be specified.

・ESX: ESX

・HYPERV: Hyper-V

・IPSWITCH: IP Switch

・FCSWITCH: FC Switch

・CLUSTER: Clutser

profileType

string

Change type of the system profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

SystemThresholdValue[]

Details of the threshold set in the system profile.

numOfResources

int

Number of resources to which the system profile is assigned

thresholdValues (Type: SystemThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold.

unit

string

String indicating the unit of the threshold.

proportion

boolean

Direction of the threshold.

・true: When the measured value falls below the threshold, an error or warning occurs.

・false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for displaying errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/SystemThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 6861
Expect: 100-continue

[Request Body]
{
  "profileName": "Default Profile for Hyper-V",
  "description": "Default Profile for Hyper-V",
  "resourceType": "HYPERV",
  "profileType": "User",
  "thresholdValues": [
    {
      "instanceID": 539,
      "monitoring": true,
      "metricType": "WIN_CPU_LOAD",
      "displayName": "CPU Use",
      "unit": "%",
      "proportion": false,
      "thresholdValueOfWarning": 80,
      "thresholdValueOfError": 90,
      "stepSize": 1,
      "max": 100,
      "min": 0
    }, {
    ......
    },
    ......
  ],
  "originalThresholdProfileID" : 23
}

[Response Header]
HTTP/1.1 100 Continue
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 07:59:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 2dfd66512c3fb3d859df167fc452989dd389797_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/64
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID": 64,
  "profileName": "Default Profile for Hyper-V",
  "description": "Default Profile for Hyper-V",
  "resourceType": "HYPERV",
  "profileType": "User",
  "thresholdValues": [
    {
      "instanceID": 807,
      "monitoring": true,
      "metricType": "WIN_CPU_LOAD",
      "displayName": "CPU Use",
      "unit": "%",
      "proportion": false,
      "thresholdValueOfWarning": 80,
      "thresholdValueOfError": 90,
      "stepSize": 1,
      "max": 100,
      "min": 0
    }, {
      ......
    },
    ......
  ],
  "numOfResources": 0,
  "originalThresholdProfileID" : 23
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.4 Updating System Profile

This API updates the specified user profile.

Execution permission

Admin, Modify

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}

Request body

The structure of the request body and the object attributes are as follows:

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

SystemThresholdProfile (Type: SystemThresholdProfile)

Attribute

Type

Description

profileName

string

System profile name. Use 128 or fewer characters.

description

string

Description of the system profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the system profile can be applied. The following value can be specified.

・ESX: ESX

・HYPERV: Hyper-V

・IPSWITCH: IP Switch

・FCSWITCH: FC Switch

・CLUSTER: Clutser

profileType

string

Change type of the system profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

SystemThresholdValue[]

Details of the threshold set in the system profile.

thresholdValues (Type: SystemThresholdValue)

Attribute

Type

Description

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold.

unit

string

String indicating the unit of the threshold.

proportion

boolean

Direction of the threshold.

・true: When the measured value falls below the threshold, an error or warning occurs.

・false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for displaying errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "pluginMetricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

Attribute

Type

Description

instanceID

long

ID for identifying instances

profileName

string

System profile name. Use 128 or fewer characters.

description

string

Description of the system profile. Use 256 or fewer characters.

resourceType

string

Resource type to which the system profile can be applied. The following value can be specified.

・ESX: ESX

・HYPERV: Hyper-V

・IPSWITCH: IP Switch

・FCSWITCH: FC Switch

・CLUSTER: Clutser

profileType

string

Change type of the system profile.

・User: Profile is created by a user

・Default: Profile is registered by default

・Preset: Profile for which the initial settings are set

thresholdValues

SystemThresholdValue[]

Details of the threshold set in the system profile.

numOfResources

int

Number of resources to which the system profile is assigned

thresholdValues (Type: SystemThresholdValue)

Attribute

Type

Description

instanceID

long

ID for identifying instances

monitoring

boolean

Whether the threshold is monitored.

・true: Threshold is monitored

・false: Threshold is not monitored

If this member is omitted, false is set.

metricType

string

Identifier of the threshold. This member is not supported.

pluginMetricType

string

Type of the metric set for a threshold (Plug-in)

displayName

string

Display name of the threshold.

unit

string

String indicating the unit of the threshold.

proportion

boolean

Direction of the threshold.

・true: When the measured value falls below the threshold, an error or warning occurs.

・false: When the measured value exceeds the threshold, an error or warning occurs.

thresholdValueOfWarning

float

Threshold for displaying warnings. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

thresholdValueOfError

float

Threshold for displaying errors. You need to specify this threshold according to the following conditions:

・Multiple of stepSize

・Less than or equal to max

・Greater than or equal to min

If the specified value is not allowed, the value is adjusted automatically.

stepSize

float

Increment for the threshold

max

double

Maximum value that can be specified for the threshold

min

double

Minimum value that can be specified for the threshold

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/SystemThresholdProfiles/64 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 6861

[Request Body]
{
  "instanceID" : 23,
  "profileName" : "Default Profile for Hyper-V",
  "description" : "Default Profile for Hyper-V",
  "resourceType" : "HYPERV",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 807,
    "monitoring" : true,
    "metricType" : "WIN_CPU_LOAD",
    "displayName" : "CPU Use",
    "unit" : "%",
    "proportion" : false,
    "thresholdValueOfWarning" : 80.0,
    "thresholdValueOfError" : 90.0,
    "stepSize" : 1.0,
    "max" : 100.0,
    "min" : 0.0
  }, {
    ......
  }, {
    ......
  } ],
  "numOfResources" : 0,
  "originalThresholdProfileID" : 23
}

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

[Response Body]
{
  "instanceID" : 23,
  "profileName" : "Default Profile for Hyper-V",
  "description" : "Default Profile for Hyper-V",
  "resourceType" : "HYPERV",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 807,
    "monitoring" : true,
    "metricType" : "WIN_CPU_LOAD",
    "displayName" : " CPU Use",
    "unit" : "%",
    "proportion" : false,
    "thresholdValueOfWarning" : 80.0,
    "thresholdValueOfError" : 90.0,
    "stepSize" : 1.0,
    "max" : 100.0,
    "min" : 0.0
  }, {
    ......
  }, {
  ......
  } ],
  "numOfResources" : 0,
  "originalThresholdProfileID" : 23
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.5 Delete System Profiles

This API deletes the specified user profile. The default user profile is reassigned to the monitored resource to which the deleted user profile is assigned.

Execution permission

Admin, Modify

API version

v1

Request format

DELETE http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}

Request body

Not applicable.

Response body

Not applicable.

Status codes

Status code

Reason phrase

Description

204

No Content

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No delete privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
DELETE /Analytics/v1/objects/SystemThresholdProfiles/64 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 204 No Content
Date: Fri, 27 Nov 2015 11:24:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO cb3bc1b920fd9b534c57538990506d5ab5258cc_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.6 Obtaining System Profile Operation List

This API acquires a list of executable operations for the specified system profile.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/SystemThresholdProfiles/23/actions 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 08:52:29 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4d3178ead3e093e934287dcb05187272788ae5c_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "updateTargetResource",
    "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.7 Obtaining System Profile Allocation Information

This API acquires information required for assigning the specified system profile to a monitored resource.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "instanceID":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

InstanceID[]

A list of InstanceID objects necessary to execute an operation. For details about InstanceID, see the table below.

parameters (Type: InstanceID)

Attribute

Type

Description

instanceID

long

InstanceID

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource 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 09:01:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO b996edeeab148c282cf3cbeb6cbec37584796239_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 4
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.9.8 Allocating System Profile

This API assigns the specified system profile to monitoring targets.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "instanceID":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

InstanceID[]

A list of InstanceID objects necessary to execute an operation. For details about InstanceID, see the table below.

parameters (Type: InstanceID)

Attribute

Type

Description

instanceID

long

InstanceID

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 251

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 4
  } ]
}

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

[Response Body]
{
  "instanceID" : "2d8efa39-3ce7-475e-a0a3-7e16504edb97",
  "created" : "2015-11-27T18:11:06.459+09:00",
  "updated" : "2015-11-27T18:11:06.525+09:00",
  "completed" : "2015-11-27T18:11:06.526+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10 List of API requests related to consumers

This section describes the operations for consumers, and the grades set for consumers.

2.10.1 Obtaining Consumer List

This API acquires a list of consumers.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "status":"...",
            "gradeKey":"...",
            "gradeName":"...",
            "gradeDisplayOrder":"...",
            "description":"...",
            "urls":["...", ...],
            "urlDisplayNames":["...", ...],
            "templateCreatorType":"...",
            "vmAutoAssignment":"...",
            "applicationAssignFollow":"...",
            "numOfVolumes":"...",
            "numOfVMs":"...",
            "numOfHosts":"...",
            "numOfHypervisors":"...",
            "numOfApplications":"...",
            "numOfPods":"...",
            "numOfInstances":"...",
            "vmAutoAssignFilters":["...", ...],
            "hostAutoAssignFilters":["...", ...],
            "podAutoAssignFilters":["...", ...],
            "instanceAutoAssignFilters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Group[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Consumer name. Use 128 or fewer characters.

status

enum

Status of the consumer.

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

The specifiable values are as follows:

Normal

Warning

Error

gradeKey

string

ID for identifying grades

gradeName

string

Grade name

gradeDisplayOrder

integer

Priority of the grade

description

string

Description of the consumer. Use 1000 or fewer characters.

urls

string[]

URL

urlDisplayNames

string[]

Character string displayed for the URL

templateCreatorType

enum

Change type of the consumer.

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

The specifiable values are as follows:

User

Default

vmAutoAssignment

boolean

Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically

applicationAssignFollow

boolean

Set true if you assign a application under the resource that belong to this Group automatically

numOfVolumes

integer

Number of volumes to which the consumer is assigned.

numOfVMs

integer

Number of virtual machines to which the consumer is assigned.

numOfHosts

integer

Number of hosts to which the consumer is assigned.

numOfHypervisors

integer

Number of hypervisors to which the consumer is assigned.

numOfApplications

integer

Number of applications to which the consumer is assigned.

numOfPods

integer

Number of pods to which the consumer is assigned.

numOfInstances

integer

Number of instances to which the consumer is assigned.

vmAutoAssignFilters

string[]

Name of the automatic assignment rule set for the virtual machines

hostAutoAssignFilters

string[]

Name of the automatic assignment rule set for the hosts

podAutoAssignFilters

string[]

Name of the automatic assignment rule set for the pods

instanceAutoAssignFilters

string[]

Name of the automatic assignment rule set for the instances

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.

400

Bad Request

A query parameter is invalid.

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/Groups HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:13 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 391057f139ab541fcdada36041750307958a6e_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "#Unassigned Resources",
    "description" : "Resources which have not been assigned to a consumer.",
    "urls" : [ ],
    "urlDisplayNames" : [ ],
    "templateCreatorType" : "Default",
    "vmAutoAssignment" : false,
    "applicationAssignFollow" : false,
    "numOfVolumes" : 784,
    "numOfVMs" : 162,
    "numOfHosts" : 9,
    "numOfHypervisors" : 13,
    "numOfApplications" : 55,
    "numOfPods" : 10,
    "numOfInstances" : 10,
    "volumeAutoAssignFilters" : [ ],
    "vmAutoAssignFilters" : [ ],
    "hostAutoAssignFilters" : [ ],
	"podAutoAssignFilters": [ ],
	"instanceAutoAssignFilters": [ ]
  }, {
    "instanceID" : 160,
    "name" : "Hitachi Cloud for JP1",
    "status" : "Normal",
    "gradeKey" : "0",
    "gradeName" : "Platinum",
    "gradeDisplayOrder" : 0,
    "description" : "Company: Hitachi\nSystem: Private Cloud for JP1 \nTel: xxx-xxx-xxx-xxx-xxx\nAddress:xxxx-xxx-xxx-xxx\nContact Person: jp1 support center\n",
    "urls" : [ "http://" ],
    "urlDisplayNames" : [ "support senter" ],
    "templateCreatorType" : "User",
    "vmAutoAssignment" : true,
    "applicationAssignFollow" : true,
    "numOfVolumes" : 8,
    "numOfVMs" : 273,
    "numOfHosts" : 0,
    "numOfHypervisors" : 1,
    "numOfApplications" : 2,
    "numOfPods" : 0,
    "numOfInstances" : 0,
    "volumeAutoAssignFilters" : [ ],
    "vmAutoAssignFilters" : [ ],
    "hostAutoAssignFilters" : [ ],
	"podAutoAssignFilters": [ ],
	"instanceAutoAssignFilters": [ ]
  }, {
    "instanceID" : 161,
    "name" : "XX Team",
    "status" : "Normal",
    "gradeKey" : "10",
    "gradeName" : "Gold",
    "gradeDisplayOrder" : 10,
    "description" : "Company: AAA , XX Team\nSystem: XX Team system\nTel: xxx-xxx-xxx-xxx-xxx\nAddress:xxx-xxx-xxx-xxx-xxx\nContact Person: hitachi support\n",
    "urls" : [ "https://hitachi-support-center-url" ],
    "urlDisplayNames" : [ "hitachi support" ],
    "templateCreatorType" : "User",
    "vmAutoAssignment" : false,
    "applicationAssignFollow" : true,
    "numOfVolumes" : 60,
    "numOfVMs" : 5,
    "numOfHosts" : 4,
    "numOfHypervisors" : 1,
    "numOfApplications" : 0,
    "numOfPods" : 0,
    "numOfInstances" : 0
    "volumeAutoAssignFilters" : [ ],
    "vmAutoAssignFilters" : [ "XX Team VM" ],
    "hostAutoAssignFilters" : [ "XX Team HostOS" ],
	"podAutoAssignFilters": [ ],
	"instanceAutoAssignFilters": [ ]
  } ],
  "count" : 3
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.2 Getting specific consumer information

This API acquires information about the specified consumer.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Groups/{id}

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "numOfPods":"...",
        "numOfInstances":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "podAutoAssignFilters":["...", ...],
        "instanceAutoAssignFilters":["...", ...]
}

Group (Type: Group)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Consumer name. Use 128 or fewer characters.

status

enum

Status of the consumer.

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

The specifiable values are as follows:

Normal

Warning

Error

gradeKey

string

ID for identifying grades

gradeName

string

Grade name

gradeDisplayOrder

integer

Priority of the grade

description

string

Description of the consumer. Use 1000 or fewer characters.

urls

string[]

URL

urlDisplayNames

string[]

Character string displayed for the URL

templateCreatorType

enum

Change type of the consumer.

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

The specifiable values are as follows:

User

Default

vmAutoAssignment

boolean

Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically

applicationAssignFollow

boolean

Set true if you assign a application under the resource that belong to this Group automatically

numOfVolumes

integer

Number of volumes to which the consumer is assigned.

numOfVMs

integer

Number of virtual machines to which the consumer is assigned.

numOfHosts

integer

Number of hosts to which the consumer is assigned.

numOfHypervisors

integer

Number of hypervisors to which the consumer is assigned.

numOfApplications

integer

Number of applications to which the consumer is assigned.

numOfPods

integer

Number of pods to which the consumer is assigned.

numOfInstances

integer

Number of instances to which the consumer is assigned.

vmAutoAssignFilters

string[]

Name of the automatic assignment rule set for the virtual machines

hostAutoAssignFilters

string[]

Name of the automatic assignment rule set for the hosts

podAutoAssignFilters

string[]

Name of the automatic assignment rule set for the pods

instanceAutoAssignFilters

string[]

Name of the automatic assignment rule set for the instances

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Groups/160 HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:19 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 55e8e56fd349d5f67752988c44efb61dd5684ca6_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 160,
  "name" : "Hitachi Cloud for JP1",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Company: Hitachi\nSystem: Private Cloud for JP1 \nTel: xxx-xxx-xxx-xxx-xxx\nAddress:xxxx-xxx-xxx-xxx\nContact Person: jp1 support center\n",
  "urls" : [ "http://test" ],
  "urlDisplayNames" : [ "support senter" ],
  "templateCreatorType" : "User",
  "vmAutoAssignment" : true,
  "applicationAssignFollow" : true,
  "numOfVolumes" : 8,
  "numOfVMs" : 273,
  "numOfHosts" : 0,
  "numOfHypervisors" : 1,
  "numOfApplications" : 2,
  "numOfPods" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ],
  "podAutoAssignFilters": [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.3 Obtaining Grade List

This API acquires a list of grades contained in a consumer.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "gradeKey":"...",
            "name":"...",
            "displayOrder":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Grade[]

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

Attribute

Type

Description

gradeKey

string

ID for identifying grades

name

string

Grade name

displayOrder

int

Priority of the grade

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.

400

Bad Request

A query parameter is invalid.

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/Grades 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 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 723cc9c7dbae3aa85bad85fc46d1bc9edb64d_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 410,
    "gradeKey" : "0",
    "name" : "Platinum",
    "displayOrder" : 0
  }, {
    "instanceID" : 413,
    "gradeKey" : "10",
    "name" : "Gold",
    "displayOrder" : 10
  }, {
    "instanceID" : 412,
    "gradeKey" : "20",
    "name" : "Silver",
    "displayOrder" : 20
  }, {
    "instanceID" : 411,
    "gradeKey" : "30",
    "name" : "Bronze",
    "displayOrder" : 30
  } ],
  "count" : 4
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.4 Creating consumer

This API creates a consumer.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/Groups

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "gradeKey":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"..."
}

Group (Type: Group)

Attribute

Type

Description

name

string

Consumer name. Use 128 or fewer characters.

gradeKey

string

ID for identifying grades

description

string

Description of the consumer. Use 1000 or fewer characters.

urls

string[]

URL

urlDisplayNames

string[]

Character string displayed for the URL

templateCreatorType

enum

Change type of the consumer.

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

The specifiable values are as follows:

User

Default

vmAutoAssignment

boolean

Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically

applicationAssignFollow

boolean

Set true if you assign a application under the resource that belong to this Group automatically

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "numOfPods":"...",
        "numOfInstances":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "podAutoAssignFilters":["...", ...],
        "instanceAutoAssignFilters":["...", ...]
}

Group (Type: Group)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Consumer name. Use 128 or fewer characters.

status

enum

Status of the consumer.

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

The specifiable values are as follows:

Normal

Warning

Error

gradeKey

string

ID for identifying grades

gradeName

string

Grade name

gradeDisplayOrder

integer

Priority of the grade

description

string

Description of the consumer. Use 1000 or fewer characters.

urls

string[]

URL

urlDisplayNames

string[]

Character string displayed for the URL

templateCreatorType

enum

Change type of the consumer.

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

The specifiable values are as follows:

User

Default

vmAutoAssignment

boolean

Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically

applicationAssignFollow

boolean

Set true if you assign a application under the resource that belong to this Group automatically

numOfVolumes

integer

Number of volumes to which the consumer is assigned.

numOfVMs

integer

Number of virtual machines to which the consumer is assigned.

numOfHosts

integer

Number of hosts to which the consumer is assigned.

numOfHypervisors

integer

Number of hypervisors to which the consumer is assigned.

numOfApplications

integer

Number of applications to which the consumer is assigned.

numOfPods

integer

Number of pods to which the consumer is assigned.

numOfInstances

integer

Number of instances to which the consumer is assigned.

vmAutoAssignFilters

string[]

Name of the automatic assignment rule set for the virtual machines

hostAutoAssignFilters

string[]

Name of the automatic assignment rule set for the hosts

podAutoAssignFilters

string[]

Name of the automatic assignment rule set for the pods

instanceAutoAssignFilters

string[]

Name of the automatic assignment rule set for the instances

Status codes

Status code

Reason phrase

Description

201

Created

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The grade is invalid.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/Groups HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 380

[Request Body]
{
  "name": "A Systems Monitoring Team",
  "gradeKey":"0",
  "description": "Company: A Systems , Monitoring Team\nSystem: monitoring system\nTel: xxx-xxx-xxx-xxx-xxx\nAddress:xxx-xxx-xxx-xxx-xxx\n",
  "urls": ["https://monitoring-system-url"],
  "urlDisplayNames": ["monitoring dashboard"],
  "templateCreatorType": "User",
  "vmAutoAssignment": true,
  "applicationAssignFollow": false
}

[Response Header]
HTTP/1.1 201 Created
Date: Mon, 09 Sep 2019 05:22:34 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO eab046278b6ebb7b2c1744afbb58e1984492939_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
Location: http://JP1OAServer:22015/Analytics/v1/objects/Groups/162
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 162,
  "name" : "A Systems Monitoring Team",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Company: A Systems , Monitoring Team\nSystem: monitoring system\nTel: xxx-xxx-xxx-xxx-xxx\nAddress:xxx-xxx-xxx-xxx-xxx\n",
  "urls" : [ "https://monitoring-system-url" ],
  "urlDisplayNames" : [ "monitoring dashboard" ],
  "templateCreatorType" : "User",
  "vmAutoAssignment" : true,
  "applicationAssignFollow" : false,
  "numOfVolumes" : 0,
  "numOfVMs" : 0,
  "numOfHosts" : 0,
  "numOfHypervisors" : 0,
  "numOfApplications" : 0,
  "numOfPods" : 0,
  "numOfInstances" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ],
  "podAutoAssignFilters": [ ],
  "instanceAutoAssignFilters": [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.5 Updating consumer

This API updates the specified consumer.

Execution permission

Admin, Modify

API version

v1

Request format

PUT http[s]://host:port/Analytics/version/objects/Groups/{id}

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "gradeKey":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"..."
}

Group (Type: Group)

Attribute

Type

Description

name

string

Consumer name. Use 128 or fewer characters.

gradeKey

string

ID for identifying grades

description

string

Description of the consumer. Use 1000 or fewer characters.

urls

string[]

URL

urlDisplayNames

string[]

Character string displayed for the URL

templateCreatorType

enum

Change type of the consumer.

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

The specifiable values are as follows:

User

Default

vmAutoAssignment

boolean

Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically

applicationAssignFollow

boolean

Set true if you assign a application under the resource that belong to this Group automatically

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "numOfPods":"...",
        "numOfInstances":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "podAutoAssignFilters":["...", ...],
        "instanceAutoAssignFilters":["...", ...]
}

Group (Type: Group)

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Consumer name. Use 128 or fewer characters.

status

enum

Status of the consumer.

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

The specifiable values are as follows:

Normal

Warning

Error

gradeKey

string

ID for identifying grades

gradeName

string

Grade name

gradeDisplayOrder

integer

Priority of the grade

description

string

Description of the consumer. Use 1000 or fewer characters.

urls

string[]

URL

urlDisplayNames

string[]

Character string displayed for the URL

templateCreatorType

enum

Change type of the consumer.

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

The specifiable values are as follows:

User

Default

vmAutoAssignment

boolean

Set true if you assign a virtual machine under the hypervisor that belong to this Group automatically

applicationAssignFollow

boolean

Set true if you assign a application under the resource that belong to this Group automatically

numOfVolumes

integer

Number of volumes to which the consumer is assigned.

numOfVMs

integer

Number of virtual machines to which the consumer is assigned.

numOfHosts

integer

Number of hosts to which the consumer is assigned.

numOfHypervisors

integer

Number of hypervisors to which the consumer is assigned.

numOfApplications

integer

Number of applications to which the consumer is assigned.

numOfPods

integer

Number of pods to which the consumer is assigned.

numOfInstances

integer

Number of instances to which the consumer is assigned.

vmAutoAssignFilters

string[]

Name of the automatic assignment rule set for the virtual machines

hostAutoAssignFilters

string[]

Name of the automatic assignment rule set for the hosts

podAutoAssignFilters

string[]

Name of the automatic assignment rule set for the pods

instanceAutoAssignFilters

string[]

Name of the automatic assignment rule set for the instances

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

409

Conflict

A resource with the same name exists.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
PUT /Analytics/v1/objects/Groups/162 HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 274

[Request Body]
{
  "name": "A Systems",
  "gradeKey":"0",
  "description": "Company: A Systems \nAddress:xxx-xxx-xxx-xxx-xxx\n",
  "urls": ["https://a-systems-top"],
  "urlDisplayNames": ["A Systems"],
  "templateCreatorType": "User",
  "vmAutoAssignment": true,
  "applicationAssignFollow": true
}

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 09 Sep 2019 05:51:30 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO c128f4e05c042d4a31da328bcfe7486f49b357_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 162,
  "name" : "A Systems",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Company: A Systems \nAddress:xxx-xxx-xxx-xxx-xxx\n",
  "urls" : [ "https://a-systems-top" ],
  "urlDisplayNames" : [ "A Systems" ],
  "templateCreatorType" : "User",
  "vmAutoAssignment" : true,
  "applicationAssignFollow" : true,
  "numOfVolumes" : 0,
  "numOfVMs" : 0,
  "numOfHosts" : 0,
  "numOfHypervisors" : 0,
  "numOfApplications" : 0,
  "numOfPods" : 0,
  "numOfInstances" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ],
  "podAutoAssignFilters": [ ],
  "instanceAutoAssignFilters": [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.6 Deleting specific consumer

This API deletes the specified consumer.

The resource assigned to the deleted consumer is set as an unassigned resource (#Unassigned Resources).

Execution permission

Admin, Modify

API version

v1

Request format

DELETE http[s]://host:port/Analytics/version/objects/Groups/{id}

Request body

Not applicable.

Response body

Not applicable.

Status codes

Status code

Reason phrase

Description

204

No Content

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No delete privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
DELETE /Analytics/v1/objects/Groups/10 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 204 No Content
Date: Fri, 27 Nov 2015 11:24:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO f1f0fb1a6ac21a0695f6536ba8950b641c263a4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.7 Obtaining Consumer Operation List

This API acquires a list of executable operations for the specified consumer.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/Groups/160/actions HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:24 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ba18117aa53bceb8b4bf5f89f43dba94f1cf938e_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "updateTargetResource",
    "href" : "http://JP1OAServer:22015/Analytics/v1/objects/Groups/160/actions/updateTargetResource/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  }, {
    "name" : "updateTargetResourceWithAssignmentType",
    "href" : "http://JP1OAServer:22015/Analytics/v1/objects/Groups/160/actions/updateTargetResourceWithAssignmentType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.8 Obtaining Consumer Allocation Information

This API acquires information required for assigning the specified consumer to a monitored resource.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "volumeIDs":["...", ...],
            "vmIDs":["...", ...],
            "resourceIDs":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

UpdateTargetResourceParam[]

A list of UpdateTargetResourceParam objects necessary to execute an operation. For details about UpdateTargetResourceParam, see the table below.

parameters (Type: UpdateTargetResourceParam)

Attribute

Type

Description

volumeIDs

long[]

Specify IDs for identifying volumes to which the consumer is to be assigned. To assign the consumer to multiple volumes, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set.

"volumeIDs" : [ 81, 87 ]

To release the assignment of all the volumes, set the member value to a blank.

"volumeIDs" : [ ]

vmIDs

long[]

Specify IDs for identifying virtual machines to which the consumer is to be assigned. To assign the consumer to multiple virtual machines, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set.

" vmIDs " : [ 81, 87 ]

To release the assignment of all the virtual machines, set the member value to a blank.

" vmIDs " : [ ]

resourceIDs

long[]

Specify IDs for identifying hosts to which the consumer is to be assigned. To assign the consumer to multiple hosts, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set.

" resourceIDs " : [ 81, 87 ]

To release the assignment of all the hosts, set the member value to a blank.

" resourceIDs " : [ ]

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Groups/160/actions/updateTargetResource HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:30 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 45d6d29dcde4fdf4ae1d16d8e5587d146bd9aa7f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://JP1OAServer:22015/Analytics/v1/objects/Groups/160/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumeIDs" : [ 13642, 13671, 13905, 14001, 14064, 14085, 14093, 14116 ],
    "vmIDs" : [ 16177, 14381, 15941, 15942, 15943, 15946, 15947, 15951, 15960, ... , 16997 ],
    "resourceIDs" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.9 Allocating Consumer

This API assigns the specified consumer to monitoring targets.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "volumeIDs":["...", ...],
            "vmIDs":["...", ...],
            "resourceIDs":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

UpdateTargetResourceParam[]

A list of UpdateTargetResourceParam objects necessary to execute an operation. For details about UpdateTargetResourceParam, see the table below.

parameters (Type: UpdateTargetResourceParam)

Attribute

Type

Description

volumeIDs

long[]

Specify IDs for identifying volumes to which the consumer is to be assigned. To assign the consumer to multiple volumes, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set.

"volumeIDs" : [ 81, 87 ]

To release the assignment of all the volumes, set the member value to a blank.

"volumeIDs" : [ ]

vmIDs

long[]

Specify IDs for identifying virtual machines to which the consumer is to be assigned. To assign the consumer to multiple virtual machines, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set.

" vmIDs " : [ 81, 87 ]

To release the assignment of all the virtual machines, set the member value to a blank.

" vmIDs " : [ ]

resourceIDs

long[]

Specify IDs for identifying hosts to which the consumer is to be assigned. To assign the consumer to multiple hosts, specify the IDs concurrently. The IDs of monitoring targets to which the consumer has already been assigned also need to be set.

" resourceIDs " : [ 81, 87 ]

To release the assignment of all the hosts, set the member value to a blank.

" resourceIDs " : [ ]

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumeIDs" : [ 534 ],
    "vmIDs" : [ 97, 31 ],
    "resourceIDs" : [ ]
  } ]
}

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

[Response Body]
{
  "instanceID" : "e89f633c-700d-4e75-9f81-d2d59c95a7bf",
  "created" : "2015-11-27T18:11:06.679+09:00",
  "updated" : "2015-11-27T18:11:07.023+09:00",
  "completed" : "2015-11-27T18:11:07.023+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.10 Obtaining Consumer Allocation Information with a Specified Resource Allocation Category

This API acquires information required for allocating the specified consumer to monitoring targets based on the specified allocation category.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "volumes":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "vms":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "resources":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "hypervisors":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "applications":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "pods":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "instances":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

UpdateTargetResourceWithAssignmentType[]

A list of UpdateTargetResourceWithAssignmentType objects necessary to execute an operation. For details about UpdateTargetResourceWithAssignmentType, see the table below.

parameters (Type: UpdateTargetResourceWithAssignmentType)

Attribute

Type

Description

volumes

TargetResource[]

List of volumes to be allocated

vms

TargetResource[]

List of virtual machines to be allocated

resources

TargetResource[]

List of hosts to be allocated

hypervisors

TargetResource[]

List of hypervisors to be allocated

applications

TargetResource[]

List of applications to be allocated

pods

TargetResource[]

List of pods to be allocated

instances

TargetResource[]

List of instances to be allocated

volumes (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

vms (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

resources (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

hypervisors (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

applications (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

pods (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

instances (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/Groups/160/actions/updateTargetResourceWithAssignmentType HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:40 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8f3ef6f6876454e97ada389e335bf56513efd6a_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResourceWithAssignmentType",
  "href" : "http://JP1OAServer:22015/Analytics/v1/objects/Groups/160/actions/updateTargetResourceWithAssignmentType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumes" : [ {
      "id" : 13642,
      "assignmentType" : "NoChange"
    }, {
      "id" : 13671,
      "assignmentType" : "NoChange"
    }, {

      ........

    }, {
      "id" : 16997,
      "assignmentType" : "NoChange"
    } ],
    "resources" : [ ],
    "hypervisors" : [ {
      "id" : 255,
      "assignmentType" : "NoChange"
    } ],
    "applications" : [ {
      "id" : 202,
      "assignmentType" : "NoChange"
    }, {
      "id" : 205,
      "assignmentType" : "NoChange"
    } ],
    "pods" : [ {
      "id" : 3001,
      "assignmentType" : "NoChange"
    } ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.10.11 Allocating Consumers that Have a Resource Allocation Category Specified

This API allocates the specified consumer to monitoring targets based on the specified allocation category.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "volumes":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "vms":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "resources":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "hypervisors":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "applications":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "pods":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ],
            "instances":[{
                "id":"...",
                "assignmentType":"..."
            },
            :
            ]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

UpdateTargetResourceWithAssignmentType[]

A list of UpdateTargetResourceWithAssignmentType objects necessary to execute an operation. For details about UpdateTargetResourceWithAssignmentType, see the table below.

parameters (Type: UpdateTargetResourceWithAssignmentType)

Attribute

Type

Description

volumes

TargetResource[]

List of volumes to be allocated

vms

TargetResource[]

List of virtual machines to be allocated

resources

TargetResource[]

List of hosts to be allocated

hypervisors

TargetResource[]

List of hypervisors to be allocated

applications

TargetResource[]

List of applications to be allocated

pods

TargetResource[]

List of pods to be allocated

instances

TargetResource[]

List of instances to be allocated

volumes (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

vms (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

resources (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

hypervisors (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

applications (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

pods (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

instances (Type: TargetResource)

Attribute

Type

Description

id

long

ID of the resource

assignmentType

enum

Resource owned division

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

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288

[Request Body]
"{
  ""name"": ""updateTargetResourceWithAssignmentType"",
  ""href"": ""http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType/invoke"",
  ""method"": ""POST"",
  ""type"": ""application/json"",
  ""parameters"": [
    {
      ""volumes"": [],
      ""vms"": [
        {
          ""id"": 14381,
          ""assignmentType"": ""Share""
        }
      ],
      ""resources"": [],
      ""hypervisors"": [
        {
          ""id"": 255,
          ""assignmentType"": ""NoChange""
        }
      ],
      ""applications"": [
        {
          ""id"": 205,
          ""assignmentType"": ""Occupy""
        }
      ],
      ""pods"": [
        {
          ""id"": 3001,
          ""assignmentType"": ""Occupy""
        }
      ]
    }
  ]
}"

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

[Response Body]
{
  "instanceID" : "092d8a40-9bb3-4067-9d39-404c5c646101",
  "created" : "2016-11-22T11:30:45.805+09:00",
  "updated" : "2016-11-22T11:30:47.122+09:00",
  "completed" : "2016-11-22T11:30:47.122+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.11 List of API requests related to application

This section describes the operations for application.

2.11.1 Obtaining Application List

The API acquires a list of applications.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "applicationType":"...",
            "applicationDetailType":"...",
            "ipAddress":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"...",
            "applicationHosts":[{
                "resourceID":"...",
                "resourceType":"..."
            },
            :
            ],
            "applicationContainers":[{
                "resourceID":"...",
                "resourceType":"..."
            },
            :
            ],
            "autoCollectionType":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "usedCredentialID":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Application[]

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

Attribute

Type

Description

instanceID

long

Instance ID

name

string

Name of the detected application

applicationType

enum

Application type

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

The specifiable values are as follows:

AJS_MANAGER

AJS_AGENT

PFM_SERVICERESPONSE

PFM_AJS3

PFM_DOMINO

PFM_EXCHANGE

PFM_SAPSYSTEM

PFM_IBMWEBSPHEREMQ

PFM_OPENTP1

PFM_COSMINEXUS

PFM_IIS

PFM_WEBLOGICSERVER

PFM_WEBSPHEREAPPLICATIONSERVER

PFM_DB2

PFM_HIRDB

PFM_SQL

PFM_RMSQLSERVER

PFM_ORACLE

PFM_RMORACLE

PFM_RMPLATFORM

PFM_UNIX

PFM_WINDOWS

IM_OS

PFM_RMVIRTUALMACHINE

PFM_VIRTUALMACHINE

CUSTOM

applicationDetailType

string

Type of the custom application

ipAddress

string

IP address of the application

description

string

Detailed information about the application

collectorID

long

ID identifying the collector used for detection

collectorName

string

Name of the collector used for detection

applicationHosts

ApplicationHost[]

Resources to which the application belongs

applicationContainers

ApplicationContainer[]

Containers to which the application belongs

autoCollectionType

enum

Settings for periodic execution of the collector

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

groupIDs

long[]

ID identifying the consumer to which the application is allocated

groupNames

string[]

Name of the consumer to which the application is allocated

gradeNames

string[]

Grade of the consumer to which the application is allocated

gradeOrders

integer[]

Priority of the grade of the consumer to which the application is allocated

usedCredentialID

long

ID identifying the authentication information used at detection

accessPointType

enum

Type of collector used at detection

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

accessPointIpAddress

string

IP address or host name of the authentication information

accessPointUser

string

User ID used to connect to monitoring targets or management software

applicationHosts (Type: ApplicationHost)

Attribute

Type

Description

resourceID

long

ID of the resource to which the application belongs

resourceType

enum

Type of the resource to which the application belongs

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

The specifiable values are as follows:

VirtualMachine

Host

ServiceInstance

applicationContainers (Type: ApplicationContainer)

Attribute

Type

Description

resourceID

long

ID of the resource to which the application belongs

resourceType

enum

Type of the resource to which the application belongs

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

The specifiable values are as follows:

Pod

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/Applications HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:38:56 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO adc7673b35acc7ad6d344d54cb169e2ca2a13_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 220,
    "name" : "HiRDBInstance1",
    "applicationType" : "PFM_HIRDB",
    "ipAddress" : "DBHost-2",
    "description" : "DBHost-2",
    "collectorID" : 150,
    "collectorName" : "PFM_Manager",
    "applicationHosts" : [{
      "resourceID" : 150,
      "resourceType" : "ServiceInstance"
    }],
    "applicationContainers" : [ ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 200,
    "accessPointType" : "PFM",
    "accessPointIpAddress" : "10.197.64.118",
    "accessPointUser" : "root"
  }, {
    "instanceID" : 53,
    "name" : "Zabbix server",
    "applicationType" : "CUSTOM",
    "applicationDetailType" : "Template App Zabbix Server",
    "ipAddress" : "zabbix",
    "description" : "zabbix",
    "collectorID" : 6,
    "collectorName" : "zabbix",
    "applicationHosts" : [ ],
    "applicationContainers" : [ ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 18,
    "accessPointType" : "CUSTOM"
  }, {
    "instanceID" : 237,
    "name" : "AJSM-HOST",
    "applicationType" : "AJS_MANAGER",
    "ipAddress" : "AJSM-HOST",
    "description" : "AJSM-HOST : @SYSTEM",
    "collectorID" : 151,
    "collectorName" : "AJS",
    "applicationHosts" : [ {
      "resourceID" : 20,
      "resourceType" : "Host"
    }, {
      "resourceID" : 14261,
      "resourceType" : "VirtualMachine"
    } ],
    "applicationContainers" : [ ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 201,
    "accessPointType" : "AJS",
    "accessPointIpAddress" : "JP1ALL",
    "accessPointUser" : "administrator"
  }, {
    "instanceID" : 162,
    "name" : "IMM-HOST",
    "applicationType" : "IM_OS",
    "ipAddress" : "IMM-HOST",
    "description" : "IMM-HOST",
    "collectorID" : 101,
    "collectorName" : "IM_Collector",
    "applicationHosts" : [ {
      "resourceID" : 20,
      "resourceType" : "Host"
    }, {
      "resourceID" : 14261,
      "resourceType" : "VirtualMachine"
    } ],
    "applicationContainers" : [ {
      "resourceID" : 3001,
      "resourceType" : "Pod"
    } ],
    "autoCollectionType" : "AutoConnect",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 151,
    "accessPointType" : "IM",
    "accessPointIpAddress" : "10.197.64.116",
    "accessPointUser" : "administrator"
  } ],
  "count" : 4
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.12 List of API requests related to container clusters

This section describes operations related to container clusters.

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
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.13 List of API requests related to container nodes

This section describes the operations for container nodes.

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
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.13.2 Obtaining Container Node Operation List

This API acquires a list of executable operations for container nodes.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/ContainerNodes/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/ContainerNodes/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.13.3 Obtaining Container Node Monitoring Status Change Information

This API acquires information required for changing the monitoring status of container nodes.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/ContainerNodes/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

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/services/ContainerNodes/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/ContainerNodes/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.13.4 Changing Container Node Monitoring Status

This API changes the monitoring status of container nodes.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/ContainerNodes/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/ContainerNodes/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 287

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/ContainerNodes/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.14 List of API requests related to pods

This section describes the operations for pods.

2.14.1 Obtaining Pod List

The API acquires a list of pods.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "status":"...",
            "monitorStatus":"...",
            "nodeID":"...",
            "nodeName":"...",
            "nodeMonitorStatus":"...",
            "clusterName":"...",
            "namespace":"...",
            "ownerReferences":"...",
            "labels":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "pluginId":"...",
            "pluginName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Pod[]

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

Attribute

Type

Description

name

string

Name of the pod

status

enum

Status of the pod

(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 pod

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

The specifiable values are as follows:

InUse

NotMonitored

nodeID

long

ID of the container node that the pod belongs to

nodeName

string

Name of the container node that the pod belongs to

nodeMonitorStatus

enum

Monitor status of the container node that the pod belongs to

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

The specifiable values are as follows:

New

Manage

ignore

MonitorOff

clusterName

string

Name of the cluster that the pod belongs to

namespace

string

Namespace of the container pod

ownerReferences

string

Control source of the container pod

labels

string

Labels of the container pod

groupIDs

long[]

ID of the consumer assigned to the pod

groupNames

string[]

Name of the consumer assigned to the pod

gradeNames

string[]

Name of the grade of the consumer assigned to the pod

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the pod

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 of authentication information used for detection

usedCredentials

string

Name for 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 pod.

pluginName

string

Name for the plug-in applied to the pod.

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/Pods 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" : 16,
    "name" : "api-6f6f887c55-cqwdv",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "nodeID" : 50,
    "nodeName" : "k8s-master.local",
    "nodeMonitorStatus" : "Manage",
    "clusterName" : "zzops",
    "namespace" : "ml-smore",
    "ownerReferences" : "ReplicaSet/api-6f6f887c55",
    "labels" : "api,2929443711",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "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"
  }, {
    "instanceID" : 15,
    "name" : "api-9b96d4c5d-crpzj",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "nodeID" : 50,
    "nodeName" : "k8s-master.local",
    "nodeMonitorStatus" : "Manage",
    "clusterName" : "zzops",
    "namespace" : "ml-aem",
    "ownerReferences" : "ReplicaSet/api-9b96d4c5d",
    "labels" : "api,565280718",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "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" : 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.14.2 Obtaining Pod Operation List

This API acquires a list of executable operations for pod.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Pods/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/Pods/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/Pods/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.14.3 Obtaining Pod Monitoring Status Change Information

This API acquires information required for changing the monitoring status of pod.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Pods/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForPod[]

A list of ChangeManagedTypeParamForPod objects necessary to execute an operation. For details about ChangeManagedTypeParamForPod, see the table below.

parameters (Type: ChangeManagedTypeParamForPod)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

ids

long[]

Specify the ID for identifying the pod. To specify multiple virtual machines, specify the IDs concurrently.

To set pods whose instanceID is 50 and 51, specify the settings as follows:

ids : [ 50, 51 ]

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/services/Pods/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Pods/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.14.4 Changing Pod Monitoring Status

This API changes the monitoring status of pod.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Pods/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForPod[]

A list of ChangeManagedTypeParamForPod objects necessary to execute an operation. For details about ChangeManagedTypeParamForPod, see the table below.

parameters (Type: ChangeManagedTypeParamForPod)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

ids

long[]

Specify the ID for identifying the pod. To specify multiple virtual machines, specify the IDs concurrently.

To set pods whose instanceID is 50 and 51, specify the settings as follows:

ids : [ 50, 51 ]

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/Pods/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Pods/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Ignore",
    "ids" : [ 31, 80 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.15 List of API requests related to clusters

This section describes operations related to clusters.

2.15.1 Obtaining Cluster List

The API acquires a list of clusters.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "status":"...",
            "componentType":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "pluginId":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Cluster[]

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

Attribute

Type

Description

name

string

Name of the cluater

status

enum

Status of 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

componentType

enum

Type of the cluster

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

The specifiable values are as follows:

HYPERVISOR_CLUSTER

GENERIC_HYPERVISOR_CLUSTER

thresholdProfileID

long

ID of the threshold profile assigned to the cluster

thresholdProfileName

string

Name of the threshold profile assigned to the cluster

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the cluster

pluginId

string

ID for the plug-in applied to the 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

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/Clusters/ 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" : "nutanix_cluster",
    "status" : "Normal",
    "componentType" : "GENERIC_HYPERVISOR_CLUSTER",
    "thresholdProfileID" : 27,
    "thresholdProfileName" : "Default Profile for Nutanix Cluster",
    "originalThresholdProfileID" : "26",
    "pluginId" : "com.hitachi.software.ias.NutanixPlugin"
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.16 List of API requests related to hypervisors

This section describes the operations for hypervisors.

2.16.1 Obtaining Hypervisor List

The API acquires a list of hypervisors.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "clusterName":"...",
            "clusterStatus":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "hypervisorType":"...",
            "hypervisorDetailType":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "pluginId":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Hypervisor[]

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

Attribute

Type

Description

instanceID

long

ID of the hypervisor

name

string

Name of the hypervisor

ipAddress

string

IP address of the hypervisor

status

enum

Status of the hypervisor

(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

Monitoring status of the hypervisor.

(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 hypervisor

collectorID

long

ID for identifying a collector used for detection

collectorName

string

Name of a collector used for detection

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

clusterName

string

Name of the cluster where the hypervisor is registered

clusterStatus

enum

Status of the cluster where the hypervisor is registered

(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

usedCredentialID

long

ID for identifying authentication information used for detection

usedCredentials

string

Name of authentication information used for detection

hypervisorType

string

Type of the hypervisor. The following the value can be specified.

・SERVER_ESX: ESX server

・SERVER_HYPERV: Hyper-V server

・GENERIC_HYPERVISOR: Hypervisor defined by plug-in

hypervisorDetailType

string

Type of the hypervisor that is defined by using the plug-in.

thresholdProfileID

long

ID of the threshold profile assigned to the hypervisor

thresholdProfileName

string

Name of the threshold profile assigned to the hypervisor

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the hypervisor

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:

WMI

SNMP

VCENTER

accessPointSnmpVersion

enum

SNMP version of credential

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

The specifiable values are as follows:

V1_V2C

V3

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

groupIDs

long[]

ID of the consumer assigned to the hypervisor

groupNames

string[]

Name of the consumer assigned to the hypervisor

gradeNames

string[]

Name of the grade of the consumer assigned to the hypervisor

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the hypervisor

pluginId

string

ID for the plug-in applied to the hypervisor.

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/Hypervisors HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:40:40 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6c538e8b65357bcc1674eef4d6cf6785014fca2_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 453,
    "name" : "10.197.64.51",
    "ipAddress" : "10.197.64.51",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "HITACHI BladeSymphony F51 ffff-1c6f653231d4",
    "collectorID" : 452,
    "collectorName" : "vCenterServer",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "SERVER_ESX",
    "thresholdProfileID" : 6,
    "thresholdProfileName" : "Default Profile for ESX",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "10.197.64.50",
    "accessPointUser" : "admin",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 46,
    "name" : "10.197.64.62",
    "ipAddress" : "10.197.64.62",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "HITACHI HA8000/RS220 VMware ESXi ffffffff-ffff-ffff-ffff-1c6f65313f4e",
    "collectorID" : 452,
    "collectorName" : "vCenterServer",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "SERVER_ESX",
    "thresholdProfileID" : 6,
    "thresholdProfileName" : "Default Profile for ESX",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "10.197.64.50",
    "accessPointUser" : "admin",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 450,
    "name" : "hyper-v",
    "ipAddress" : "10.197.64.136, 10.197.64.167",
    "status" : "NotMonitored",
    "monitorStatus" : "MonitorOff",
    "description" : "Hyper-V  48930542-9AA8-220C-5B04-4136724A2D79",
    "usedCredentialID" : 450,
    "usedCredentials" : "hyper-v-auth",
    "hypervisorType" : "SERVER_HYPERV",
    "thresholdProfileID" : 23,
    "thresholdProfileName" : "Default Profile for Hyper-V",
    "accessPointType" : "WMI",
    "accessPointIpAddress" : "10.197.64.131",
    "accessPointUser" : "administrator",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 255,
    "name" : "esx2",
    "status" : "NotMonitored",
    "monitorStatus" : "MonitorOff",
    "description" : "Nutanix-1672e6be4fdfb05189fe6adf43858971a17d1b3d",
    "clusterName" : "HITACHI-NX",
    "usedCredentialID" : 300,
    "usedCredentials" : "hitachi nutanix",
    "hypervisorType" : "GENERIC_HYPERVISOR",
    "hypervisorDetailType" : "AHV",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V3",
    "accessPointIpAddress" : "10.197.64.111",
    "accessPointUser" : "admin",
    "groupIDs" : [ 160 ],
    "groupNames" : [ "Hitachi Cloud for JP1" ],
    "gradeNames" : [ "Platinum" ],
    "gradeOrders" : [ 0 ],
    "pluginId" : "com.hitachi.software.ias.NutanixPlugin"
  } ],
  "count" : 4
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.16.2 Obtaining Hypervisor Operation List

This API acquires a list of executable operations for the specified hypervisor.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Hypervisors/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/Hypervisors/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.16.3 Obtaining Hypervisor Monitoring Status Change Information

This API acquires information required for changing the monitoring status of hypervisors.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Hypervisors/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

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/services/Hypervisors/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.16.4 Changing Hypervisor Monitoring Status

This API changes the monitoring status of hypervisors.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Hypervisors/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 287

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.17 List of API requests related to virtual machines

This section describes the operations for virtual machines.

2.17.1 Obtaining Virtual Machine List

This API acquires a list of virtual machines.

This API request can also be used as follows to get information on demand.

1. Overview

Instead of getting virtual machine information that is collected during regular collection cycles, use this API request to get information that is up-to-date as of the time the request is executed.

2. Limitations

(a) Information can only be acquired on demand from virtual machines in a vCenter. In addition, only the following information, which is in the VirtualMachines table that follows, can be acquired:

- instanceID

- name

- ipAddress

- description

- clusterName

- hypervisorName

- hostName

(b) Query parameters cannot be specified.

3. Setting Method

See the section describing the system property file (Argus.properties), in the JP1/Operations Analytics Configuration and Administration Guide.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "componentType":"...",
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "clusterName":"...",
            "hypervisorType":"...",
            "hypervisorDetailType":"...",
            "hypervisorID":"...",
            "hypervisorName":"...",
            "hypervisorMonitorStatus":"...",
            "hostName":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "pluginId":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"...",
        "errorInfo":[{
            "nodeName":"...",
            "message":"...",
            "messageID":"..."
        },
        :
        ]
}

Collections (Type: Collections)

Attribute

Type

Description

data

VirtualMachine[]

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

errorInfo

FailedNodes[]

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

data (Type: VirtualMachine)

Attribute

Type

Description

instanceID

long

ID of the virtual machine

name

string

Name of the virtual machine

ipAddress

string

IP Address set for the virtual machine

status

enum

Status of the virtual machine

(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

Monitoring status of the virtual machine

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

The specifiable values are as follows:

InUse

NotMonitored

description

string

Detailed information about the virtual machine

componentType

enum

Type of the virtual machine.

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

The specifiable values are as follows:

VIRTUAL_MACHINE

GENERIC_VIRTUALMACHINE

collectorID

long

ID for identifying a collector used for detection

collectorName

string

Name of a collector used for detection

autoCollectionType

enum

Settings for periodic executions of the collector.

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

The specifiable values are as follows:

AutoConnect

NotAutoConnect

clusterName

string

Name of the Cluster that the virtual machine belongs to

hypervisorType

enum

Type of hypervisor that the virtual machine belongs to

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

The specifiable values are as follows:

SERVER_ESX

SERVER_HYPERV

GENERIC_HYPERVISOR

hypervisorDetailType

string

Detail type of the hypervisor that the virtual machine belongs to

hypervisorID

long

ID of the hypervisor that the virtual machine belongs to

hypervisorName

string

Name of the hypervisor that the virtual machine belongs to

hypervisorMonitorStatus

enum

Monitoring status of the hypervisor that the virtual machine belongs to

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

The specifiable values are as follows:

New

Manage

ignore

MonitorOff

hostName

string

The name of host which is installed on virtual machine

thresholdProfileID

long

ID of the threshold profile assigned to the virtual machine

thresholdProfileName

string

Name of the threshold profile assigned to the virtual machine

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the virtual machine

groupIDs

long[]

ID of the consumer assigned to the virtual machine

groupNames

string[]

Name of the consumer assigned to the virtual machine

gradeNames

string[]

Name of the grade of the consumer assigned to the virtual machine

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the virtual machine

usedCredentialID

long

ID for identifying 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:

WMI

SNMP

VCENTER

accessPointSnmpVersion

enum

SNMP version of credential

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

The specifiable values are as follows:

V1_V2C

V3

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 hypervisor that the virtual machine belongs to.

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

errorInfo (Type: FailedNodes)

Attribute

Type

Description

nodeName

string

Name of the node

message

string

Message

messageID

string

ID of the message

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

403

Forbidden

No reference privilege.

408

Request Timeout

The processing on the server timed out.

412

Precondition Failed

- The server is not available.

(The following only occur during on-demand acquisition of information.)

- There is a problem in the connection with the vCenter server.

- The vCenter server is not working properly.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/objects/VirtualMachines HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Content-Type: application/json
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 06 Sep 2019 09:39:34 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO dac7fb616da3768ba63e98b322264fa36e708f_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 17319,
    "name" : "centOS",
    "ipAddress" : "",
    "status" : "NotMonitored",
    "monitorStatus" : "NotMonitored",
    "description" : "centOS : 90ED2A51-DFA0-4506-AB4F-CB3A4DC8C3D5",
    "componentType" : "VIRTUAL_MACHINE",
    "hypervisorType" : "SERVER_HYPERV",
    "hypervisorID" : 450,
    "hypervisorName" : "hyper-v",
    "hypervisorMonitorStatus" : "MonitorOff",
    "thresholdProfileID" : 19,
    "thresholdProfileName" : "Default Profile for VM",
    "originalThresholdProfileID": 19,
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 450,
    "usedCredentials" : "hyper-v-auth",
    "accessPointType" : "WMI",
    "accessPointIpAddress" : "10.197.64.10",
    "accessPointUser" : "administrator"
  }
    "instanceID" : 17218,
    "name" : "winsrv2012r2",
    "ipAddress" : "10.197.64.166",
    "status" : "Error",
    "monitorStatus" : "InUse",
    "description" : "winsrv2012r2 : 16A16D27-D419-45BC-AB42-B27CD28A0A20",
    "componentType" : "VIRTUAL_MACHINE",
    "hypervisorType" : "SERVER_HYPERV",
    "hypervisorID" : 450,
    "hypervisorName" : "hyper-v",
    "hypervisorMonitorStatus" : "MonitorOff",
    "hostName" : "WIN-KVR6P62HC7V",
    "thresholdProfileID" : 19,
    "thresholdProfileName" : "Default Profile for VM",
    "originalThresholdProfileID": 19,
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 450,
    "usedCredentials" : "hyper-v-auth",
    "accessPointType" : "WMI",
    "accessPointIpAddress" : "10.197.64.10",
    "accessPointUser" : "administrator"
  }, {
    "instanceID" : 17021,
    "name" : "dns-server",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "componentType" : "GENERIC_VIRTUALMACHINE",
    "clusterName" : "AHV-Cluster",
    "hypervisorType" : "GENERIC_HYPERVISOR",
    "hypervisorDetailType" : "AHV",
    "hypervisorID" : 251,
    "hypervisorName" : "NTNX-SGH823XYVL-A",
    "hypervisorMonitorStatus" : "MonitorOff",
    "hostName" : "49b57856-061a-4bd0-8d1e-08be03981299",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "usedCredentialID" : 300,
    "usedCredentials" : "nutanix-credential",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V3",
    "accessPointIpAddress" : "10.197.64.111",
    "accessPointUser" : "admin",
    "pluginId" : "com.hitachi.software.ias.NutanixPlugin"
  }, {
    "instanceID" : 14541,
    "name" : "MONISRV",
    "ipAddress" : "",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "description" : "MONISRV : 4215f071-e007-48eb-0b25-2c1f7ea1f999",
    "componentType" : "VIRTUAL_MACHINE",
    "collectorID" : 452,
    "collectorName" : "vCenter_JP1OA",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "SERVER_ESX",
    "hypervisorID" : 43,
    "hypervisorName" : "10.197.64.31",
    "hypervisorMonitorStatus" : "Manage",
    "hostName" : "MONISRV",
    "thresholdProfileID" : 19,
    "thresholdProfileName" : "Default Profile for VM",
    "originalThresholdProfileID": 19,
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "10.197.64.10",
    "accessPointUser" : "admin"
  } ],
  "count" : 4
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.17.2 Obtaining Virtual Machine Operation List

This API acquires a list of executable operations for virtual machines.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/VirtualMachines/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/VirtualMachines/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.17.3 Obtaining Virtual Machine Monitoring Status Change Information

This API acquires information required for changing the monitoring status of virtual machines.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/VirtualMachines/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "virtualMachineIds":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForVM[]

A list of ChangeManagedTypeParamForVM objects necessary to execute an operation. For details about ChangeManagedTypeParamForVM, see the table below.

parameters (Type: ChangeManagedTypeParamForVM)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

virtualMachineIds

long[]

Specify the ID for identifying the virtual machine. To specify multiple virtual machines, specify the IDs concurrently.

To set virtual machines whose instanceID is 50 and 51, specify the settings as follows:

virtualMachineIds : [ 50, 51 ]

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/services/VirtualMachines/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "virtualMachineIds" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.17.4 Changing Virtual Machine Monitoring Status

This API changes the monitoring status of virtual machines.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/VirtualMachines/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "virtualMachineIds":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForVM[]

A list of ChangeManagedTypeParamForVM objects necessary to execute an operation. For details about ChangeManagedTypeParamForVM, see the table below.

parameters (Type: ChangeManagedTypeParamForVM)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

virtualMachineIds

long[]

Specify the ID for identifying the virtual machine. To specify multiple virtual machines, specify the IDs concurrently.

To set virtual machines whose instanceID is 50 and 51, specify the settings as follows:

virtualMachineIds : [ 50, 51 ]

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Ignore",
    "virtualMachineIds" : [ 31, 80 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.18 List of API requests related to hosts

This section describes the operations for hosts.

2.18.1 Obtaining Host List

The API acquires a list of hosts.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "osType":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "vmName":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "deviceClassificationLabel":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "pluginId":"...",
            "creatorType":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Host[]

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

Attribute

Type

Description

instanceID

long

ID for identifying instances

name

string

Name of the host

ipAddress

string

IP address of the host

osType

string

OS type of the host. The following the value can be specified.

・SERVER_WINDOWS: The OS is Windows.

・SERVER_LINUX: The OS is Linux.

・SERVER_SOLARIS: The OS is Solaris.

・SERVER_HPUX: The OS is HP-UX.

・SERVER_AIX: The OS is AIX.

・GENERIC_COMPUTER: This is a host for which information is collected by a plug-in.

・UNKNOWN: A host about which information is collected as an alive-monitoring target, or a host that is an SNMP trap-notification source registered as a management target.

status

enum

Status of the host

(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

Monitoring status of the host.

(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 host

vmName

string

Name of the virtual machine if the host is running on a virtual machine

usedCredentialID

long

ID for identifying authentication information used for detection

usedCredentials

string

Name of authentication information used for detection

thresholdProfileID

long

ID of the threshold profile assigned to the host

thresholdProfileName

string

Name of the threshold profile assigned to the host

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the host

groupIDs

long[]

ID of the consumer assigned to the host

groupNames

string[]

Name of the consumer assigned to the host

gradeNames

string[]

Name of the grade of the consumer assigned to the host

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the host

deviceClassificationLabel

string

Name of the classification label assigned to the host

accessPointType

enum

Type of 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:

WMI

SSH

SNMP

accessPointSnmpVersion

enum

SNMP version of credential

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

The specifiable values are as follows:

V1_V2C

V3

accessPointIpAddress

string

IP address used for connections to monitoring targets

accessPointUser

string

User ID used for connections to monitoring targets

pluginId

string

ID for the plug-in applied to the host.

creatorType

enum

The type of creator that added the host as a monitoring target. This member is enabled only if osType is UNKNOWN.

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

The specifiable values are as follows:

Discovery

Trap

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/Hosts 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" : 8,
    "name" : "fuji",
    "ipAddress" : "10.197.87.43",
    "osType" : "SERVER_LINUX",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "XXXX YYYY/ZZ Linux Server",
    "usedCredentialID" : 17,
    "usedCredentials" : "10.197.87.43",
    "thresholdProfileID" : 4,
    "thresholdProfileName" : "Default Profile for Linux/UNIX",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "deviceClassificationLabel":"Linux Development Env",
    "accessPointType" : "SSH",
    "accessPointIpAddress" : "10.197.87.43",
    "accessPointUser" : "root"
  }, {
    "instanceID" : 1,
    "name" : "10.197.199.44",
    "ipAddress" : "10.197.199.44",
    "osType" : "UNKNOWN",
    "status" : "NotMonitored",
    "monitorStatus" : "MonitorOff",
    "description" : "",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "deviceClassificationLabel" : "RPA system",
    "accessPointIpAddress" : "10.197.199.44",
    "creatorType" : "Discovery"
  } ],
  "count" : 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.18.2 Obtaining Host Operation List

This API acquires a list of executable operations for the specified host.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Hosts/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/Hosts/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/Hosts/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.18.3 Obtaining Host Monitoring Status Change Information

This API acquires information required for changing the monitoring status of hosts.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Hosts/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

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/services/Hosts/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hosts/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.18.4 Changing Host Monitoring Status

This API changes the monitoring status of hosts.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Hosts/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/Hosts/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 279

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hosts/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.19 List of API requests related to datastores

This section describes the operations for datastores.

2.19.1 Obtaining Datastore List

The API acquires a list of datastores.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "datastoreUrl":"...",
            "identificationNumber":"...",
            "clusterName":"...",
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Datastore[]

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

Attribute

Type

Description

name

string

Name of the datastore

status

enum

Status of the datastore

(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

Monitoring status of the datastore

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

The specifiable values are as follows:

InUse

NotMonitored

description

string

Description of the datastore

datastoreUrl

string

URL of the datastore defined in monitoring targets or management software

identificationNumber

string

Identification Number of the datastore defined in monitoring targets or management software

clusterName

string

Name of the cluster that the datastore belongs to

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

Name of authentication information used for detection

usedCredentials

string

Name for 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:

WMI

SNMP

VCENTER

accessPointSnmpVersion

enum

SNMP version of credential

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

The specifiable values are as follows:

V1_V2C

V3

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

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/DatastoresHTTP/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:53: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" : 1667,
    "name" : "SelfServiceContainer",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "identificationNumber" : "3cbe1312-ea74-4c94-8963-547fbe412946",
    "clusterName" : "nutanix_cluster",
    "usedCredentialID" : 5,
    "usedCredentials" : "Nutanix",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V3",
    "accessPointIpAddress" : "10.197.101.182",
    "accessPointUser" : "admin"
  },{
    "instanceID" : 300,
    "name" : "datastore39",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "description" : "",
    "datastoreUrl" : "ds:///vmfs/volumes/58bf7061-e63b5c93-c2a2-1c6f65310ce4/",
    "collectorID" : 0,
    "collectorName" : "vCenter",
    "autoCollectionType" : "AutoConnect",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "10.197.64.164",
    "accessPointUser" : "administrator@vsphere.local"
  }],
"count": 2
}

2.19.2 Obtaining Datastore Operation List

This API acquires a list of executable operations for datastores.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Datastores/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/Datastores/actions HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:37:35 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://10.210.177.133:22015/Analytics/v1/services/Datastores/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

2.19.3 Obtaining Datastore Monitoring Status Change Information

This API acquires information required for changing the monitoring status of datastores.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Datastores/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForComp[]

A list of ChangeManagedTypeParamForComp objects necessary to execute an operation. For details about ChangeManagedTypeParamForComp, see the table below.

parameters (Type: ChangeManagedTypeParamForComp)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

ids

long[]

Specify the ID for identifying the component. To specify multiple virtual machines, specify the IDs concurrently.

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/services/Datastores/actions/changeManagedType HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:35:33 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=99
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://10.210.177.133:22015/Analytics/v1/services/Datastores/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "ids" : [ ]
  } ]
}

2.19.4 Changing Datastore Monitoring Status

This API changes the monitoring status of datastores.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Datastores/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForComp[]

A list of ChangeManagedTypeParamForComp objects necessary to execute an operation. For details about ChangeManagedTypeParamForComp, see the table below.

parameters (Type: ChangeManagedTypeParamForComp)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

ids

long[]

Specify the ID for identifying the component. To specify multiple virtual machines, specify the IDs concurrently.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/Datastores/actions/changeManagedType/invoke HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Request Body]
{
  "name": "changeManagedType",
  "href": "http://10.210.177.133:22015/Analytics/v1/services/Datastores/actions/changeManagedType/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters": [
    {
      "newMonitoringOperationType": "Monitor",
      "ids": [
        1000001
      ]
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:35:33 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=97
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "58d4757a-2e9e-44cd-9aaf-2cbc54a5de9c",
  "created" : "2020-10-21T09:35:33.956+09:00",
  "updated" : "2020-10-21T09:35:34.128+09:00",
  "completed" : "2020-10-21T09:35:34.128+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

2.20 List of API requests related to IP switches

This section describes the operations for IP switches.

2.20.1 Obtaining IP Switch List

The API acquires a list of IP switches.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

IPSwitch[]

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

Attribute

Type

Description

instanceID

long

ID of the IP switch

name

string

Name of the IP switch

ipAddress

string

IP address of the IP switch

status

enum

Status of the IP switch

(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

Monitoring status of the IP switch.

(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 IP Switch

usedCredentialID

long

ID for identifying authentication information used for detection

usedCredentials

string

Name of authentication information used for detection

thresholdProfileID

long

ID of the threshold profile assigned to the IP switch

thresholdProfileName

string

Name of the threshold profile assigned to the IP switch

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the IP switch

accessPointType

enum

Type of 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:

SNMP

accessPointSnmpVersion

enum

Version of SNMP used for detection

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

The specifiable values are as follows:

V1_V2C

V3

accessPointIpAddress

string

IP address used for connections to monitoring targets

accessPointUser

string

User ID used for connections to monitoring targets

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/IPSwitches 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 21:15: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" : 3,
    "name" : "dell2",
    "ipAddress" : "10.197.87.242",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "YYYY Ethernet Switch",
    "usedCredentialID" : 7,
    "usedCredentials" : "10.197.87.242",
    "thresholdProfileID" : 10,
    "thresholdProfileName" : "Default Profile for IP Switch",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V1_V2C",
    "accessPointIpAddress" : "10.197.87.242",
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.20.2 Obtaining IP Switch Operation List

This API acquires a list of executable operations for the specified IP switch.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/IPSwitches/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/IPSwitches/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.20.3 Obtaining IP Switch Monitoring Status Change Information

This API acquires information required for changing the monitoring status of IP switches.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/IPSwitches/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

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/services/IPSwitches/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.20.4 Changing IP Switch Monitoring Status

This API changes the monitoring status of IP switches.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/IPSwitches/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 284

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.21 List of API requests related to FC switches

This section describes the operations for FC switches.

2.21.1 Obtaining FC Switch List

The API acquires a list of FC switches.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "wwn":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

FCSwitch[]

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

Attribute

Type

Description

instanceID

long

ID of the FC switch

name

string

Name of the FC switch

ipAddress

string

IP address of the FC switch

status

enum

Status of the FC switch

(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

Monitoring status of the FC switch.

(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 FC Switch

usedCredentialID

long

ID for identifying authentication information used for detection

usedCredentials

string

Name of authentication information used for detection

wwn

string

WWN of the FC switch

thresholdProfileID

long

ID of the threshold profile assigned to the FC switch

thresholdProfileName

string

Name of the threshold profile assigned to the FC switch

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the FC switch

accessPointType

enum

Type of 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:

WBEM

SNMP

accessPointIpAddress

string

IP address used for connections to monitoring targets

accessPointUser

string

User ID used for connections to monitoring targets

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/FCSwitches 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" : 5,
    "name" : "SANbox",
    "ipAddress" : "10.197.87.222",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "FC Switch",
    "usedCredentialID" : 6,
    "usedCredentials" : "10.197.87.222",
    "wwn" : "10:00:00:C0:DD:0D:62:E4",
    "thresholdProfileID" : 8,
    "thresholdProfileName" : "Default Profile for FC Switch",
    "accessPointType" : "WBEM",
    "accessPointIpAddress" : "10.197.87.222",
    "accessPointUser" : "admin"
  }, {
    "instanceID" : 19,
    "name" : "SW4016",
    "ipAddress" : "10.197.64.97, 127.0.0.1",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "FC Switch",
    "usedCredentialID" : 9,
    "usedCredentials" : "FCSwitchSNMP",
    "wwn" : "10:00:00:05:33:16:84:CB",
    "thresholdProfileID" : 8,
    "thresholdProfileName" : "Default Profile for FC Switch",
    "accessPointType" : "SNMP",
    "accessPointIpAddress" : "10.197.64.97",
    "accessPointUser" : ""
  } ],
  "count" : 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.21.2 Obtaining FC Switch Operation List

This API acquires a list of executable operations for the specified FC switch.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/FCSwitches/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/FCSwitches/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.21.3 Obtaining FC Switch Monitoring Status Change Information

This API acquires information required for changing the monitoring status of FC switches.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/FCSwitches/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/FCSwitches/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.21.4 Changing FC Switch Monitoring Status

This API changes the monitoring status of FC switches.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/FCSwitches/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 284

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.22 List of API requests related to storage systems

This section describes the operations for storage systems.

2.22.1 Obtaining Storage System List

The API acquires a list of storage systems.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "name":"...",
            "ipAddress":"...",
            "status":"...",
            "monitorStatus":"...",
            "description":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "accessPointType":"...",
            "accessPointSnmpVersion":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "pluginId":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

StorageSystem[]

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

Attribute

Type

Description

instanceID

long

ID of the storage system

name

string

Name of the storage system

ipAddress

string

IP address of the storage system

status

enum

Status of the storage system

(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

Monitoring status of the storage system.

(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 storage system

usedCredentialID

long

Name of authentication information used for detection

usedCredentials

string

ID for authentication information used for detection

thresholdProfileID

long

ID of the threshold profile assigned to the storage system

thresholdProfileName

string

Name of the threshold profile assigned to the storage system

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the storage system

accessPointType

enum

Type of 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:

WBEM

SNMP

accessPointSnmpVersion

enum

SNMP version of credential

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

The specifiable values are as follows:

V1_V2C

V3

accessPointIpAddress

string

IP address used for connections to monitoring targets

accessPointUser

string

User ID used for connections to monitoring targets

pluginId

string

ID for the plug-in applied to the storage system.

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/StorageSystems 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" : 6,
    "name" : "storage",
    "ipAddress" : "10.197.87.17, 192.168.20.54",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "Storage Systems",
    "usedCredentialID" : 10,
    "usedCredentials" : "172.17.3.107",
    "thresholdProfileID" : 14,
    "thresholdProfileName" : "Default Profile for Storage (SMI-S WBEM)",
    "accessPointType" : "WBEM",
    "accessPointIpAddress" : "172.17.3.107",
    "accessPointUser" : "Administrator"
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.22.2 Obtaining Storage System Operation List

This API acquires a list of executable operations for the specified storage system.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/StorageSystems/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/StorageSystems/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.22.3 Obtaining Storage System Monitoring Status Change Information

This API acquires information necessary for changing the monitoring status of the storage system.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/StorageSystems/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

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/services/StorageSystems/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.22.4 Changing Storage System Monitoring Status

This API changes the monitoring status of the storage system.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/StorageSystems/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.23 List of API requests related to Volumes

This section describes the operations for volumes.

2.23.1 Obtaining Volume List

The API acquires a list of volumes.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "instanceID":"...",
            "status":"...",
            "ldev":"...",
            "storageSubsystemID":"...",
            "storageSubsystem":"...",
            "storageSubsystemMonitorStatus":"...",
            "thresholdProfileID":"...",
            "thresholdProfileName":"...",
            "originalThresholdProfileID":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "pluginId":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Volume[]

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

Attribute

Type

Description

instanceID

long

ID of the volume

status

enum

Status of the volume

(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

ldev

string

Name of the LDEV

storageSubsystemID

long

ID of the storage system that the volume belongs to

storageSubsystem

string

Name of the storage system that the volume belongs to

storageSubsystemMonitorStatus

enum

Monitoring status of the storage system that the volume belongs to

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

The specifiable values are as follows:

New

Manage

ignore

MonitorOff

thresholdProfileID

long

ID of the threshold profile assigned to the volume

thresholdProfileName

string

Name of the threshold profile assigned to the volume

originalThresholdProfileID

string

Original threshold profile ID of the threshold profile assigned to the volume

groupIDs

long[]

ID of the consumer assigned to the volume

groupNames

string[]

Name of the consumer assigned to the volume

gradeNames

string[]

Name of the grade of the consumer assigned to the volume

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the volume

pluginId

string

ID of the plug-in applied to the volume.

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/Volumes 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 df3a7ac35f3b99a9b2afafd22d433167067da9_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 540,
    "status" : "Unknown",
    "ldev" : "vol0 (LU NUM=699d3b60-18f9-11de-a169-00a09810f3f4)",
    "storageSubsystemID" : 6,
    "storageSubsystem" : "FAS2050A-2",
    "storageSubsystemMonitorStatus" : "Manage",
    "thresholdProfileID" : 21,
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 534,
    "status" : "Unknown",
    "ldev" : "vol1 (LU NUM=7cb5b900-1c0e-11de-9f89-00a09810f3f4)",
    "storageSubsystemID" : 6,
    "storageSubsystem" : "FAS2050A-2",
    "storageSubsystemMonitorStatus" : "Manage",
    "thresholdProfileID" : 21,
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  } ],
  "count" : 2
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.24 List of API requests related to service resources

This section describes operations related to service resources.

2.24.1 Obtaining Service Resource List

The API acquires a list of service resources.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "status":"...",
            "monitorStatus":"...",
            "serviceType":"...",
            "region":"...",
            "zone":"...",
            "serviceDetailType":"...",
            "description":"...",
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "accessTargetIdentification":"...",
            "pluginId":"...",
            "pluginName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

ServiceResource[]

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

Attribute

Type

Description

name

string

Name of the service resource

status

enum

Status of the service resource

(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

Monitoring status of the service resource

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

The specifiable values are as follows:

New

Manage

ignore

MonitorOff

serviceType

enum

Type of the service resource

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

The specifiable values are as follows:

computing

networking

storage

region

string

Region of the service resource

zone

string

Zone of the service resource

serviceDetailType

string

Detailed type of the service resource

description

string

Description of the service resource

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

Name of authentication information used for detection

usedCredentials

string

ID for 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

accessTargetIdentification

string

Access-target identification key used for connections to monitoring targets or management software

pluginId

string

ID for the plug-in applied to the service resource

pluginName

string

Name for the plug-in applied to the service resource

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/ServiceResources/ 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" : "EC Service",
    "status" : "Warning",
    "monitorStatus" : "Manage",
    "serviceType" : "computing",
    "region" : "Tokyo",
    "zone" : "1a",
    "description" : "",
    "collectorID" : 2,
    "collectorName" : "AWS Collector",
    "autoCollectionType" : "AutoConnect",
    "accessPointType" : "HTTP",
    "accessPointIpAddress" : "",
    "accessPointUser" : "system",
    "accessTargetIdentification" : "accessId",
    "pluginId" : "com.hitachi.software.ias.awsPlugin",
    "pluginName" : "AWS Plugin"
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.24.2 Obtaining Service Resource Operation List

This API acquires a list of executable operations for service resources.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/ServiceResources/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/ServiceResources/actions 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 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/ServiceResources/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.24.3 Obtaining Service Resource Monitoring Status Change Information

This API acquires information required for changing the monitoring status of service resources.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/ServiceResources/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

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/services/ServiceResources/actions/changeManagedType 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 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/ServiceResources/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.24.4 Changing Service Resource Monitoring Status

This API changes the monitoring status of service resources.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/ServiceResources/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitorStatus":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForRes[]

A list of ChangeManagedTypeParamForRes objects necessary to execute an operation. For details about ChangeManagedTypeParamForRes, see the table below.

parameters (Type: ChangeManagedTypeParamForRes)

Attribute

Type

Description

newMonitorStatus

enum

Monitor status of 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

ids

long[]

List of IDs about Resource

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/ServiceResources/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 287

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/ServiceResources/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.25 List of API requests related to service instances

This section describes operations related to service instances.

2.25.1 Obtaining Service Instance List

The API acquires a list of service instances.

Execution permission

Admin, Modify

API version

v1

Request format

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

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "status":"...",
            "monitorStatus":"...",
            "serviceType":"...",
            "region":"...",
            "zone":"...",
            "serviceID":"...",
            "serviceName":"...",
            "serviceMonitorStatus":"...",
            "serviceDetailType":"...",
            "tag":"...",
            "description":"...",
            "instanceIdentifier":"...",
            "groupIDs":["...", ...],
            "groupNames":["...", ...],
            "gradeNames":["...", ...],
            "gradeOrders":["...", ...],
            "collectorID":"...",
            "collectorName":"...",
            "autoCollectionType":"...",
            "usedCredentialID":"...",
            "usedCredentials":"...",
            "accessPointType":"...",
            "accessPointIpAddress":"...",
            "accessPointUser":"...",
            "accessTargetIdentification":"...",
            "pluginId":"...",
            "pluginName":"..."
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

ServiceInstance[]

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

Attribute

Type

Description

name

string

name of the service instance

status

enum

Status of the service instance

(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

Monitoring status of the service instance

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

The specifiable values are as follows:

InUse

NotMonitored

serviceType

enum

Type of the service resource that the service instance belongs to

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

The specifiable values are as follows:

computing

networking

storage

region

string

Region of the service resource that the service instance belongs to

zone

string

Zone of the service resource that the service instance belongs to

serviceID

long

ID of the service resource that the service instance belongs to

serviceName

string

Name of the service resource

serviceMonitorStatus

enum

Monitor status of the service resource that the service instance belongs to

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

The specifiable values are as follows:

New

Manage

ignore

MonitorOff

serviceDetailType

string

Detailed type of the service instance

tag

string

Tag of the service instance

description

string

Description of the service instance

instanceIdentifier

string

Identifier of the service instance defined in monitoring targets or management software

groupIDs

long[]

ID of the consumer assigned to the service instance

groupNames

string[]

Name of the consumer assigned to the service instance

gradeNames

string[]

Name of the grade of the consumer assigned to the service instance

gradeOrders

integer[]

Priority of the grade of the consumer assigned to the service instance

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

Name of authentication information used for detection

usedCredentials

string

ID for 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

accessTargetIdentification

string

Access-target identification key used for connections to monitoring targets or management software

pluginId

string

ID for the plug-in applied to the service instance

pluginName

string

Name for the plug-in applied to the service instance

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/ServiceInstancesHTTP/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:53: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" : "EC2-Instance-A",
    "status" : "Normal",
    "monitorStatus" : "NotMonitored",
    "serviceType" : "computing",
    "region" : "Tokyo",
    "zone" : "1a",
    "serviceID" : 50,
    "serviceName" : "EC Service1",
    "serviceMonitorStatus" : "Manage",
    "serviceDetailType" : "EC2 Instance",
    "tag" : "{\"tag\": \"relationA\"}",
    "description" : "",
    "instanceIdentifier" : "arn:aws",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "collectorID" : 20,
    "collectorName" : "AWS Collector",
    "autoCollectionType" : "AutoConnect",
    "accessPointType" : "HTTP",
    "accessPointIpAddress" : "",
    "accessPointUser" : "system",
    "accessTargetIdentification" : "accessId",
    "pluginId" : "com.hitachi.software.ias.awsPlugin",
    "pluginName" : "AWS Plugin"
  }],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.25.2 Obtaining Service Instance Operation List

This API acquires a list of executable operations for service instances.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/ServiceInstances/actions

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "data":[{
            "name":"...",
            "href":"...",
            "method":"...",
            "type":"...",
            "parameters":["...", ...]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute

Type

Description

data

Action[]

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

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

anyType[]

A list of objects. No value is set.

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/services/ServiceInstances/actions HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:37:35 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://10.210.177.133:22015/Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.25.3 Obtaining Service Instance Monitoring Status Change Information

This API acquires information required for changing the monitoring status of service instances.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/ServiceInstances/actions/changeManagedType

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForComp[]

A list of ChangeManagedTypeParamForComp objects necessary to execute an operation. For details about ChangeManagedTypeParamForComp, see the table below.

parameters (Type: ChangeManagedTypeParamForComp)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

ids

long[]

Specify the ID for identifying the component. To specify multiple virtual machines, specify the IDs concurrently.

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/services/ServiceInstances/actions/changeManagedType HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:35:33 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=99
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://10.210.177.133:22015/Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "ids" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.25.4 Changing Service Instance Monitoring Status

This API changes the monitoring status of service instances.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/ServiceInstances/actions/changeManagedType/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "newMonitoringOperationType":"...",
            "ids":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ChangeManagedTypeParamForComp[]

A list of ChangeManagedTypeParamForComp objects necessary to execute an operation. For details about ChangeManagedTypeParamForComp, see the table below.

parameters (Type: ChangeManagedTypeParamForComp)

Attribute

Type

Description

newMonitoringOperationType

enum

Specify the monitoring status to be changed to.

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

The specifiable values are as follows:

Monitor

Ignore

ids

long[]

Specify the ID for identifying the component. To specify multiple virtual machines, specify the IDs concurrently.

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

anyType[]

A list of objects. No value is set.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No update privilege.

404

Not Found

The resource was not found.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke HTTP/1.1
Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36
Host: localhost:8080
Accept: application/json
Accept-Language: ja

[Request Body]
{
  "name": "changeManagedType",
  "href": "http://10.210.177.133:22015/Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters": [
    {
      "newMonitoringOperationType": "Monitor",
      "ids": [
        1000001
      ]
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 21 Oct 2020 00:35:33 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language
Cache-Control: no-cache
Access-Control-Allow-Origin: http://localhost:8080
WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=97
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "58d4757a-2e9e-44cd-9aaf-2cbc54a5de9c",
  "created" : "2020-10-21T09:35:33.956+09:00",
  "updated" : "2020-10-21T09:35:34.128+09:00",
  "completed" : "2020-10-21T09:35:34.128+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.26 List of API requests related to the event information

This section explains how to obtain event information.

2.26.1 Collecting the information required to collect, into a CSV file, a list of events

This request collects the information required to collect, into a CSV file, a list of events.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "hqlFilter":"...",
            "hqlSort":"...",
            "page":"...",
            "pageSize":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ListGetParam[]

A list of ListGetParam objects necessary to execute an operation. For details about ListGetParam, see the table below.

parameters (Type: ListGetParam)

Attribute

Type

Description

hqlFilter

string

filter

hqlSort

string

Sort information

page

integer

page number

pageSize

integer

Size of The page

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/Events/actions/getEventDataCSV HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:10:39 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO a28b1e307e4652f1330af49f93fdced13792_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "getEventDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "hqlFilter" : "",
    "hqlSort" : "",
    "page" : 1,
    "pageSize" : 0
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.26.2 Collecting, into a CSV file, a list of events

This request collects, into a CSV file, a list of events.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "hqlFilter":"...",
            "hqlSort":"...",
            "page":"...",
            "pageSize":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

ListGetParam[]

A list of ListGetParam objects necessary to execute an operation. For details about ListGetParam, see the table below.

parameters (Type: ListGetParam)

Attribute

Type

Description

hqlFilter

string

filter

hqlSort

string

Sort information

page

integer

page number

pageSize

integer

Size of The page

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":[{
            "data":"..."
        },
        :
        ]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

CsvData[]

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

result (Type: CsvData)

Attribute

Type

Description

data

string

The CSV data is stored.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No execute privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/Events/actions/getEventDataCSV/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 292

[Request Body]
{
  "name" : "getEventDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "hqlFilter" : "",
    "hqlSort" : "dateTime DESC",
    "page" : 1,
    "pageSize" : 100
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 04:40:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 352df2998a8291f9ee75bb5f4c4ecd6a03581_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "83458bae-a082-4333-8628-73f2efd35436",
  "created" : "2019-09-12T13:40:05.248+09:00",
  "updated" : "2019-09-12T13:40:09.585+09:00",
  "completed" : "2019-09-12T13:40:09.585+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : "#JP1/Operations Analytics,115000,UTF-8 (BOM)\n#Event Information\n#2019-09-12T13:40:09.585+0900\n#Event ID,.........."
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.27 List of API requests related to the [E2E View] window

This section explains how to obtain information about specified resources or a list of resources that are related.

2.27.1 Collecting the information required to collect, into a CSV file, information about specified resources or a list of related resources

This request collects the information required to collect, into a CSV file, information about specified resources or a list of related resources.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "basePointNodes":[{
                "nodeID":"...",
                "nodeType":"..."
            },
            :
            ],
            "getType":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetNodesDataCSVParam[]

A list of GetNodesDataCSVParam objects necessary to execute an operation. For details about GetNodesDataCSVParam, see the table below.

parameters (Type: GetNodesDataCSVParam)

Attribute

Type

Description

basePointNodes

E2ENodeKey[]

List of nodes to be collected, specified as a base point

getType

enum

Type of information to be collected

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

basePointNodes (Type: E2ENodeKey)

Attribute

Type

Description

nodeID

long

ID for identifying node

nodeType

enum

Type of the node

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/E2EView/actions/getNodesDataCSV HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:10:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 7aa7a8d2531cf8d09fda40938996444363164b_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "getNodesDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "basePointNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "selectedNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "getType" : "AllInformation"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.27.2 Collecting, into a CSV file, information about specified resources or a list of related resources

This request collects, into a CSV file, information about specified resources or a list of related resources.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "basePointNodes":[{
                "nodeID":"...",
                "nodeType":"..."
            },
            :
            ],
            "getType":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetNodesDataCSVParam[]

A list of GetNodesDataCSVParam objects necessary to execute an operation. For details about GetNodesDataCSVParam, see the table below.

parameters (Type: GetNodesDataCSVParam)

Attribute

Type

Description

basePointNodes

E2ENodeKey[]

List of nodes to be collected, specified as a base point

getType

enum

Type of information to be collected

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

basePointNodes (Type: E2ENodeKey)

Attribute

Type

Description

nodeID

long

ID for identifying node

nodeType

enum

Type of the node

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

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":[{
            "data":"..."
        },
        :
        ]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

CsvData[]

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

result (Type: CsvData)

Attribute

Type

Description

data

string

The CSV data is stored.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

412

Precondition Failed

- The server is not available.

- The threshold of a query parameter was exceeded.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 330

[Request Body]
{
  "name" : "getNodesDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "basePointNodes" : [ {
      "nodeID" : 17512,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "getType" : "AllInformation"
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 04:27:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4b39fb71c2514aca46ab8275c84e8dbd27788d_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "b201975c-23b5-4d74-b807-09dcb59e11e6",
  "created" : "2019-09-12T13:27:21.864+09:00",
  "updated" : "2019-09-12T13:27:23.330+09:00",
  "completed" : "2019-09-12T13:27:23.330+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : "#JP1/Operations Analytics,121000,UTF-8 (BOM)\n#Resource Information\n#2019-09-12T13:27:22.389+0900\n............"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.28 List of API requests related to performance information

This section explains how to obtain performance information.

2.28.1 Collecting the information required to collect, into a CSV file, the performance values in a time series of specified performance information

This request collects the information required to collect, into a CSV file, the performance values in a time series of specified performance information.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "perfComponentIDs":["...", ...],
            "baseTime":"...",
            "pointTimeRange":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetGraphDataCSVParam[]

A list of GetGraphDataCSVParam objects necessary to execute an operation. For details about GetGraphDataCSVParam, see the table below.

parameters (Type: GetGraphDataCSVParam)

Attribute

Type

Description

perfComponentIDs

long[]

ID of perfComponents

baseTime

dateTime

Start time for obtaining performance information. The performance information for a certain period before the specified start time is obtained. The period is specified by pointTimeRange. If this item is omitted, the time that the API was executed is used as the start time.

pointTimeRange

long

Period during which performance information is obtained (ms.)

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/PerfComponents/actions/getGraphDataCSV HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:10:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 60749ea2f05a1ff3a3db16f9af8ac3d45958a1_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "getGraphDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "perfComponentIDs" : [ ],
    "baseTime" : "2019-09-12T12:10:45.435+09:00",
    "pointTimeRange" : 3600000
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.28.2 Collecting, into a CSV file, the performance values in a time series of specified performance information

This request collects, into a CSV file, the performance values in a time series of specified performance information.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "perfComponentIDs":["...", ...],
            "baseTime":"...",
            "pointTimeRange":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetGraphDataCSVParam[]

A list of GetGraphDataCSVParam objects necessary to execute an operation. For details about GetGraphDataCSVParam, see the table below.

parameters (Type: GetGraphDataCSVParam)

Attribute

Type

Description

perfComponentIDs

long[]

ID of perfComponents

baseTime

dateTime

Start time for obtaining performance information. The performance information for a certain period before the specified start time is obtained. The period is specified by pointTimeRange. If this item is omitted, the time that the API was executed is used as the start time.

pointTimeRange

long

Period during which performance information is obtained (ms.)

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":[{
            "data":"..."
        },
        :
        ]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

CsvData[]

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

result (Type: CsvData)

Attribute

Type

Description

data

string

The CSV data is stored.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No execute privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 325

[Request Body]
{
  "name" : "getGraphDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "perfComponentIDs" : [15,16,17],
    "baseTime" : "2019-09-12T12:10:45.435+09:00",
    "pointTimeRange" : 36000
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 04:59:06 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO e3a9c17a51e3395f81fc1c431d87e295d3cf0f3_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "0af73a36-cb9b-4f07-b2c7-4899c9c0be6f",
  "created" : "2019-09-12T13:59:06.990+09:00",
  "updated" : "2019-09-12T13:59:07.253+09:00",
  "completed" : "2019-09-12T13:59:07.253+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : "#JP1/Operations Analytics,111000,UTF-8 (BOM)\n#Time Series Performance Information\n#2019-09-12T13:59:07.252+0900\n#R.............."
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.28.3 Collecting the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds

This request collects the information required to collect, into a CSV file, the latest value in the performance information that a specified resource holds.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "basePointNodes":[{
                "nodeID":"...",
                "nodeType":"..."
            },
            :
            ],
            "baseTime":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetNodesGraphDataCSVParam[]

A list of GetNodesGraphDataCSVParam objects necessary to execute an operation. For details about GetNodesGraphDataCSVParam, see the table below.

parameters (Type: GetNodesGraphDataCSVParam)

Attribute

Type

Description

basePointNodes

E2ENodeKey[]

List of nodes to be collected, specified as a base point

baseTime

dateTime

Time of the base point when the performance information is collected. If omitted, the time when the API was executed is used as the base point.

basePointNodes (Type: E2ENodeKey)

Attribute

Type

Description

nodeID

long

ID for identifying node

nodeType

enum

Type of the node

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

Status codes

Status code

Reason phrase

Description

200

OK

Success.

401

Unauthorized

No login privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:10:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6949777afd26a03da4e0c5e0e02bdb294239992e_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "getNodesGraphDataCSV",
  "href" : "http://JP1OAServer:22015/Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "basePointNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "selectedNodes" : [ {
      "nodeID" : 1,
      "nodeType" : "VIRTUAL_MACHINE"
    } ],
    "baseTime" : "2019-09-12T12:10:47.078+09:00"
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.28.4 Collecting, into a CSV file, the latest value in the performance information that a specified resource holds

This request collects, into a CSV file, the latest value in the performance information that a specified resource holds.

Execution permission

Admin, Modify

API version

v1

Request format

POST http[s]://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

Request body

The structure of the request body and the object attributes are as follows:

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "basePointNodes":[{
                "nodeID":"...",
                "nodeType":"..."
            },
            :
            ],
            "baseTime":"..."
        },
        :
        ]
}

Action (Type: Action)

Attribute

Type

Description

name

string

Name of the execute an operation.

href

string

URL of the execute an operation.

method

string

Name of the method.

type

string

Data format of the object.

parameters

GetNodesGraphDataCSVParam[]

A list of GetNodesGraphDataCSVParam objects necessary to execute an operation. For details about GetNodesGraphDataCSVParam, see the table below.

parameters (Type: GetNodesGraphDataCSVParam)

Attribute

Type

Description

basePointNodes

E2ENodeKey[]

List of nodes to be collected, specified as a base point

baseTime

dateTime

Time of the base point when the performance information is collected. If omitted, the time when the API was executed is used as the base point.

basePointNodes (Type: E2ENodeKey)

Attribute

Type

Description

nodeID

long

ID for identifying node

nodeType

enum

Type of the node

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

Response body

The structure of the response body and the object attributes are as follows:

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":[{
            "data":"..."
        },
        :
        ]
}

Job (Type: Job)

Attribute

Type

Description

instanceID

string

Indicates the ID of the Instance.

created

string

Indicates the date the object is generated in ISO 8601 format.

updated

string

Indicates the time the object is updated in ISO 8601 format. The same value as for "created" is set.

completed

string

Indicates the time the processing completed in ISO 8601 format. The same value as for "created" is set.

state

string

One of the following values is set:

"failed": The operation did not terminate normally.

"success": The operation terminated normally.

affectedResource

string[]

Indicates the URL of the API resource created or updated as a result of the operation. If no resources exist, this parameter is empty.

result

CsvData[]

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

result (Type: CsvData)

Attribute

Type

Description

data

string

The CSV data is stored.

Status codes

Status code

Reason phrase

Description

200

OK

Success.

400

Bad Request

A format of request body is invalid.

401

Unauthorized

No login privilege.

403

Forbidden

No execute privilege.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
POST /Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 206

[Request Body]
{
  "name": "getNodesGraphDataCSV",
  "parameters": [
    {
      "basePointNodes": [
        {
          "nodeID": 17512,
          "nodeType": "VIRTUAL_MACHINE"
        }
      ],
      "selectedNodes": []
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 04:54:44 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 176f3f06e4e6a7d762157ad76f5f3150bebc17_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "94d3dd62-a74d-4d9e-967e-dcc0dedf2350",
  "created" : "2019-09-12T13:54:45.198+09:00",
  "updated" : "2019-09-12T13:54:45.396+09:00",
  "completed" : "2019-09-12T13:54:45.396+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data" : "#JP1/Operations Analytics,111000,UTF-8 (BOM)\n#Latest Performance Information\n#2019-09-12T13:54:45.227+0900\n..................",
    "notManagedNodes" : [ ]
  } ]
}

Related topics

1.3 Resource members

1.6 List of enumerators

2.29 List of API requests related to information management

This section explains how to obtain the version information of JP1/OA and of API functions.

2.29.1 Obtaining Version Information

The API acquires the JP1/OA and API version.

Execution permission

Admin, Modify

API version

v1

Request format

GET http[s]://host:port/Analytics/version/configuration/version

Request body

Not applicable.

Response body

The structure of the response body and the object attributes are as follows:

{
        "productName":"...",
        "productVersion":"...",
        "apiVersion":"..."
}

Version (Type: Version)

Attribute

Type

Description

productName

string

product name

productVersion

string

product version

apiVersion

string

api version

Status codes

Status code

Reason phrase

Description

200

OK

Success.

412

Precondition Failed

The server is not available.

500

Internal Server Error

Server processing error.

Example code

[Request Header]
GET /Analytics/v1/configuration/version HTTP/1.1
Host: JP1OAServer:22015
User-Agent: curl/7.63.0
Accept: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Thu, 12 Sep 2019 03:03:48 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5c4f9254ae8572356ac219323091aae3b6b6be2a_ZAlDSFUHGHp9UB8WcRQLdA==_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "productName" : "JP1/Operations Analytics",
  "productVersion" : "12.10.00",
  "apiVersion" : "01.00.00"
}

Related topics

1.3 Resource members

1.6 List of enumerators

Appendix

A. Version Changes

A.1 Changes in version 12-60

Descriptions of the collectorType of collectors (Collectors resource) were changed.

The following members were added to the authentication information used by collectors (CollectorCredential resource):

useProxy

proxyHostAddr

proxyPort

proxyUser

updateProxyPassword

proxyPassword

In accordance with this addition, API requests related to the collector were changed.

Descriptions of the following members of the authentication information used by collectors (CollectorCredential resource) were changed.

optionalInformation1

optionalInformation2

optionalInformation3

Descriptions of the following members of the user profile threshold (UserThresholdValue resource) and system profile threshold (SystemThresholdValue resource) were changed.

thresholdValueOfWarning

thresholdValueOfError

Datastore resource was added. In accordance with this addition, the following API requests were added.

Obtaining Datastore List

Obtaining Datastore Operation List

Obtaining Datastore Monitoring Status Change Information

Changing Datastore Monitoring Status

A.2 Changes in version 12-50

The member isCollector and status were added to the Members of a plug-in (Plugins resource). In accordance with this addition, API requests related to the plugin and search range were changed.

DiscoveryLogResource resource, DiscoveryLog resource and DiscoveryLogTargetIPRange resource were added. In accordance with this addition, the following API requests were added.

Obtaining Information about Discovered Resources

Obtaining Discovery History

Also, enumerators that can be specified for the APIs were added.

The members numOfContainers, numOfResources and plugin were added to the Members of collectors (Collectors resource). In accordance with this addition, API requests related to the collectors were changed.

The following items were added to the members of authentication information used by collectors (CollectorCredential resource):

requireHostAddress

accessTargetIdentification

optionalInformation1

updateOptionalInformation1

optionalInformation2

updateOptionalInformation2

optionalInformation3

updateOptionalInformation3

In accordance with this addition, API requests related to the collector were changed.

The member originalThresholdProfileID and appliedPlugins were added to the Members of a user profile (UserThresholdProfiles resource). In accordance with this addition, API requests related to the user profile were changed.

The member originalThresholdProfileID and appliedPlugins were added to the Members of a system profile (SystemThresholdProfiles resource). In accordance with this addition, API requests related to the system profile were changed.

The following items were added to the members of a consumer (Groups resource).

numOfpods

podAutoAssignFilters

numOfInstances

instanceAutoAssignFilters

In accordance with this addition, API requests related to the consumer were changed.

The member applicationContainers was added to the Members of an application (Applications resource). In accordance with this addition, API requests related to the application were changed. Also, the ApplicationContainer resource was added.

ContainerCluster resource was added. In accordance with this addition, the following API requests were added.

Obtaining Container Cluster List

Also, enumerators that can be specified for the APIs were added.

ContainerNodes resource was added. In accordance with this addition, the following API request was added.

Obtaining Container Node List

Obtaining Container Node Operation List

Obtaining Container Node Monitoring Status Change Information

Changing Container Node Monitoring Status

Also, enumerators that can be specified for the APIs were added.

Pods resource was added. In accordance with this addition, the following API requests were added.

Obtaining Pod List

Obtaining Pod Operation List

Obtaining Pod Monitoring Status Change Information

Changing Pod Monitoring Status

Also, enumerators that can be specified for the APIs were added.

Cluster resource was added. In accordance with this addition, the following API requests were added.

Obtaining Cluster List

Also, enumerators that can be specified for the APIs were added.

The member clusterStatus and originalThresholdProfileID were added to the Members of a hypervisor (Hypervisor resource). In accordance with this addition, API requests related to the hypervisor were changed.

The member originalThresholdProfileID was added to the Members of a virtual machine (VirtualMachines resource). In accordance with this addition, API requests related to the virtual machine were changed.

The member originalThresholdProfileID was added to the Members of a host (Hosts resource). In accordance with this addition, API requests related to the host were changed.

The member originalThresholdProfileID was added to the Members of an IP Switch (IPSwitches resource). In accordance with this addition, API requests related to the IP Switch were changed.

The member originalThresholdProfileID was added to the Members of an FC Switch (FCSwitches resource). In accordance with this addition, API requests related to the FC Switch were changed.

The member originalThresholdProfileID was added to the Members of a volume (Volumes resource). In accordance with this addition, API requests related to the volume were changed.

ServiceResource resource was added. In accordance with this addition, the following API requests were added.

Obtaining Service Resource List

Obtaining Service Resource Operation List

Obtaining Service Resource Monitoring Status Change Information

Changing Service Resource Monitoring Status

Also, enumerators that can be specified for the APIs were added.

ServiceInstance resource was added. In accordance with this addition, the following API requests were added.

Obtaining Service Instance List

Obtaining Service Instance Operation List

Obtaining Service Instance Monitoring Status Change Information

Changing Service Instance Monitoring Status

Also, enumerators that can be specified for the APIs were added.

The following API requests were added.

Obtaining Discovery Operation List

Obtaining the Information Necessary To Run a Discovery

Running a Discovery

Obtaining the Information Necessary To Stop a Discovery

Stopping a Discovery

The object pods (Type: TargetResource) was added to the following API requests, and the description of the attribute assignmentType was changed.

Obtaining Consumer Allocation Information with a Specified Resource Allocation Category

Allocating Consumers that Have a Resource Allocation Category Specified

A.3 Changes in version 12-10

Windows Server 2019 is now supported.

The member aliveMonitoring was added to the members of the search range (IpAddrRanges resource). The description of usePing was also changed. In accordance with this addition, the following API requests were changed.

Obtaining Retrieval Ranges

Obtaining Retrieval Range Information

Creating Retrieval Ranges

Updating Retrieval Ranges

The member creatorType was added to the members of the hosts (Hosts resources). The description of osType was also changed. In accordance with this addition, the following API request was changed.

Obtaining Host List

A.4 Changes in version 12-00

The members useAllPlugin and selectedPlugins were added to the members of the search range (IpAddrRanges resource). In accordance with this addition, the following API requests were changed.

Obtaining Retrieval Ranges

Obtaining Retrieval Range Information

Creating Retrieval Ranges

Updating Retrieval Ranges

Plugins resource was added. In accordance with this addition, the following additions were made:

Members of Plugins resources were added.

PluginType was added to the enumerators.

The following API requests were added.

Obtaining Plug-in Information List

Obtaining Plug-in Information

The member refreshDateForState was added to the members of collectors (Collectors resource). In accordance with this addition, the following API requests were changed.

Obtaining Collector List

Obtaining Collector Information

Creating Collector

Updating Collector

MonitoringIntervalSettings resource was added. In accordance with this addition, the following additions were made:

Members of MonitoringIntervalSettings resources were added.

ScheduleCycleType was added to the enumerators.

The following API requests were added.

Updating monitoring interval

Getting monitoring interval information

UserCustomSettings resource was added. In accordance with this addition, the following additions were made:

Members of UserCustomSettings resources were added.

The following API requests were added.

Acquiring a List of Custom Settings of a User

Specifying Settings for a User

Acquiring a List of Operations for the Custom Settings of a User

Collecting Information Necessary for Deleting the Custom Settings of a User

Deleting the Custom Settings of a User

The members accessPointSnmpVersion, componentType and pluginId were added to the members of virtual machine (VirtualMachines resource). The description of accessPointType and hypervisorType were also changed. In accordance with this addition, the following API request was changed.

Obtaining Virtual Machine List

The members accessPointSnmpVersion, pluginHypervisorType and pluginId were added to the members of hypervisor (Hypervisors resource). The description of accessPointType and hypervisorType were also changed. In accordance with this addition, the following API request was changed.

Obtaining Hypervisor List

The members accessPointSnmpVersion and pluginId were added to the members of hosts (Hosts resource). The description of accessPointType and osType were also changed. In accordance with this addition, the following API request was changed.

Obtaining Host List

The members accessPointSnmpVersion and pluginId were added to the members of storage system (StorageSystems resource). The description of accessPointType was also changed. In accordance with this addition, the following API request was changed.

Obtaining Storage System List

The following additions and changes were made to the description of the API request for obtaining a list of virtual machines:

An explanation of obtaining information on demand was added.

The attribute errorInfo was added to the Collections (Type: Collections) object. In accordance with this addition, the FailedNodes (Type: FailedNodes) object was added.

A description of status code 408 was added.

A description of status code 412 was changed.

The attribute notManagedNodes was added to the CsvData (Type: CsvData) object. In accordance with this addition, the notManagedNodes (Type: E2ENodeKey) object was added.

Collecting, into a CSV file, the latest value in the performance information that a specified resource holds

A.5 Changes in version 11-50

The member deviceClassificationLabel was added to the members of the search range (IpAddrRanges resource).

The members productName, providerName, and refreshDateForApp were added to the members of collectors (Collectors resource).

The member deviceClassificationLabel was added to the members of hosts (Hosts resource).

The following members were added to or deleted from the members of applications (Applications resource).

The members applicationDetailType and applicationHosts were added.

The members resourceID and resourceType were deleted.

Descriptions were added about the members of application resource information (the ApplicationHost resource).

CUSTOM and APPLICATION_CUSTOM were added to the enumerators.

The attribute deviceClassificationLabel was added to the IPAddrRange (Type: IPAddrRange) object.

Obtaining Retrieval Ranges

Obtaining Retrieval Range Information

Creating Retrieval Ranges

Updating Retrieval Ranges

The description of status code 400 was changed.

Creating Collector

Updating Collector

A description of status code 400 was added.

Deleting Collector

The attribute applicationDetailType was added to the Application (Type: Application) object.

Obtaining Application List

The attribute deviceClassificationLabel was added to the Host (Type: Host) object.

Obtaining Host List

Index

A

API architecture[1]

API description format[1]

C

Common specifications of the API functions[1]

L

List of API requests related to application[1]

List of API requests related to authentication information[1]

List of API requests related to clusters[1]

List of API requests related to collection-interval settings[1]

List of API requests related to collectors[1]

List of API requests related to consumers[1]

List of API requests related to container clusters[1]

List of API requests related to container nodes[1]

List of API requests related to datastores[1]

List of API requests related to discovery[1]

List of API requests related to FC switches[1]

List of API requests related to hosts[1]

List of API requests related to hypervisors[1]

List of API requests related to information about user settings[1]

List of API requests related to information management[1]

List of API requests related to IP switches[1]

List of API requests related to performance information[1]

List of API requests related to plug-ins[1]

List of API requests related to pods[1]

List of API requests related to retrieval ranges (IP address ranges)[1]

List of API requests related to service instances[1]

List of API requests related to service resources[1]

List of API requests related to storage systems[1]

List of API requests related to system profiles[1]

List of API requests related to the [E2E View] window[1]

List of API requests related to the event information[1]

List of API requests related to user profiles[1]

List of API requests related to virtual machines[1]

List of API requests related to Volumes[1]

O

Operating JP1/OA by using the API functions[1]

R

Resource members[1]

Publisher

Hitachi, Ltd.

6-6, Marunouchi 1-chome, Chiyoda-ku, Tokyo, 100-8280 Japan