Hitachi

JP1 Version 12 JP1/Operations Analytics REST API Reference Guide


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