2.25.1　サービスインスタンスの一覧の取得

サービスインスタンスの一覧を取得します。

権限

Admin, Modify

APIのバージョン

リクエスト形式

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

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

{
        "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)

属性	データ型	説明
data	ServiceInstance[]	ServiceInstanceのコレクション。ServiceInstanceの詳細は以下の表を参照ください。
pagination	Pagination	ページ情報。リソースが存在しない場合、このパラメータは表示されません。
count	int	条件に合致したデータの個数

data (Type: ServiceInstance)

属性	データ型	説明
name	string	サービスインスタンスの名称
status	enum	サービスインスタンスの状態 (指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。) 以下に示す値のみ指定可能です。 Normal Warning Error Unreachable Unknown NotMonitored
monitorStatus	enum	サービスインスタンスの監視状態。 (指定可能な値は「列挙型一覧」のComponentMonitorTypeの表を参照してください。) 以下に示す値のみ指定可能です。 InUse NotMonitored
serviceType	enum	サービスインスタンスが属するサービスリソースの種別 (指定可能な値は「列挙型一覧」のPluginServiceTypeの表を参照してください。) 以下に示す値のみ指定可能です。 computing networking storage
region	string	サービスインスタンスが属するサービスリソースのリージョン
zone	string	サービスインスタンスが属するサービスリソースのゾーン
serviceID	long	サービスインスタンスが属するサービスリソースのID
serviceName	string	サービスリソースの名称
serviceMonitorStatus	enum	サービスインスタンスが属するサービスリソースの監視状態 (指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。) 以下に示す値のみ指定可能です。 New Manage ignore MonitorOff
serviceDetailType	string	サービスインスタンスの詳細種別
tag	string	サービスインスタンスのタグ
description	string	サービスインスタンスの説明
instanceIdentifier	string	監視対象または管理ソフトウェアにて定義されているサービスインスタンスの識別子
groupIDs	long[]	サービスインスタンスが割り当たっているコンシューマーを特定するID
groupNames	string[]	サービスインスタンスが割り当たっているコンシューマーの名称
gradeNames	string[]	サービスインスタンスが割り当たっているコンシューマーのグレード
gradeOrders	integer[]	サービスインスタンスが割り当たっているコンシューマーのグレードの優先度
collectorID	long	発見に使用されたコレクターを特定するID
collectorName	string	発見に使用されたコレクターの名称
autoCollectionType	enum	発見に使用されたコレクターの種別 (指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。) 以下に示す値のみ指定可能です。 AutoConnect NotAutoConnect
usedCredentialID	long	発見時に使用された認証情報の名称
usedCredentials	string	発見時に使用された認証情報を特定するID
accessPointType	enum	発見時に使用された認証情報のプロトコルまたはコレクターの種別 (指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。) 以下に示す値のみ指定可能です。 HTTP
accessPointIpAddress	string	監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名
accessPointUser	string	監視対象または管理ソフトウェアへの接続に使用したユーザーID
accessTargetIdentification	string	監視対象または管理ソフトウェアへの接続に使用した接続識別キー
pluginId	string	サービスインスタンスに適用されているプラグインのID
pluginName	string	サービスインスタンスに適用されているプラグインの名称

pagination (Type: Pagination)

属性	データ型	説明
page	integer	ページ
pageSize	integer	ページサイズ
numPages	integer	ページの数
totalCount	integer	オブジェクトの数

ステータスコード

HTTPステータスコード	Reason phrase	説明
200	OK	正常終了
401	Unauthorized	ログイン権限がない
403	Forbidden	参照権限がない
412	Precondition Failed	サーバーが起動していない
500	Internal Server Error	サーバーサイドエラー

使用例

[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
}

2.25.1 サービスインスタンスの一覧の取得

2.25.1　サービスインスタンスの一覧の取得