2.2.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

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:

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

Attribute	Type	Description
data	anyType[]	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.

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

IPAddrRange

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

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.
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
deviceClassificationLabel	string	Name of the classification label assigned to the device

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 needed ・false: A password is not 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.
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/ 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: Wed, 07 Dec 2016 09:58:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 2d4c182d7464f34a4e9bc256db5f543f66efac9e_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 242

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "IP Range-0",
    "ipAddrRange" : [ "255.255.255.0", "255.255.255.0" ],
    "usePing" : true,
    "useAllCredential" : false,
    "selectedCredentials" : [ ]
  } ,
  {
    "instanceID" : 1,
    "name" : "IP Range-1",
    "ipAddrRange" : [ "192.168.1.0", "192.168.1.254" ],
    "usePing" : true,
    "useAllCredential" : false,
    "selectedCredentials" : [
        {
            "instanceID": 3,
            "name": "WMI2_Cloud",
            "credentialType": "WMI",
            "userId": "Administrator",
            "passwordNotRequired": false,
            "domainname": "",
            "numOfRelatedResources": 3
        }
    ],
    "deviceClassificationLabel": "Cloud Env"
  }],
  "count" : 2
}