2.25.1 Obtaining Service Instance List

The API acquires a list of service instances.

Execution permission

Admin, Modify

API version

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
}