MasterScope SystemManager G WebAPI Reference - ??MasterScope SystemManager G WebAPI Reference. Disclaimer The copyrighted information noted in this document shall belong to

  • View
    223

  • Download
    3

Embed Size (px)

Text of MasterScope SystemManager G WebAPI Reference - ??MasterScope SystemManager G WebAPI Reference....

  • MasterScope SystemManager GWebAPI Reference

  • DisclaimerThe copyrighted information noted in this document shall belong to NEC Corporation.

    Copying or revising this document, in whole or in part, is strictly prohibited without thepermission of NEC Corporation.

    This document may be changed without prior notice.

    NEC Corporation shall not be liable for any technical or editing errors or omissions in thisdocument.

    NEC Corporation shall not be liable for the accuracy, usability, or certainty of information notedin this document.

    Trademarks Adobe, the Adobe logo, and Acrobat are trademarks or registered trademarks of Adobe Systems

    Incorporated in the United States of America and other countries.

    Microsoft and Windows are registered trademarks of Microsoft Corporation in the United Statesof America and other countries.

    Other Microsoft products mentioned in this guide are also registered trademarks of MicrosoftCorporation in the United States of America and other countries.

    Intel and Itanium are trademarks or registered trademarks of Intel Corporation in the UnitedStates of America and other countries.

    Introscope is a registered trademark of CA Technologies.

    UNIX is a registered trademark of the Open Group in the United States of America and othercountries.

    HP-UX and PA-RISC are registered trademarks of Hewlett-Packard Company in the UnitedStates of America and other countries.

    Other Hewlett-Packard Company products mentioned in this guide are registered trademarks ofHewlett-Packard Company in the United States of America and other countries.

    Oracle, Exadata, and Solaris are registered trademarks of Oracle Corporation and its subsidiariesand affiliates in the United States of America and other countries.

    Linux is a trademark or registered trademark of Linus Torvalds in the United States of Americaand other countries.

    Red Hat is a trademark or registered trademark of Red Hat, Inc. in the United States and othercountries.

    SUSE is a registered trademark of Novell, Inc. in Japan.

    AIX is a registered trademark of the International Business Machines Corp. in the United Statesof America.

    PATLITE are registered trademarks of PATLITE Corporation.

    All the other system names, company names, and product names in this document are trademarks orregistered trademarks of their respective companies.

    Note that the or mark are not indicated in this document.

    i

  • Notes on exporting this productThis product (including software) may be applicable to the controlled cargo (or services) regulated bythe Foreign Exchange and Foreign Trade Law. To export the product to outside of Japan, an exportpermit from the Japanese government is required. When information materials, etc. are required forthe export permit application process, contact your distributor or the nearest sales office.

    ii

  • PrefaceNotation Rules of This Document

    This document describes the precautions and related information as follows:

    NoteA functional, operational, or configurational notice, warning, or complement is described.

    TipIndicates the location of additional information or reference destination information

    Notation listThe following notation rules are applied in this document.

    Notation How to use Example

    [ ] squarebrackets

    Placed before and after anitem (such as a text box, checkbox, or tab) on the screen

    Enter the machine name in the [Machine Name] text box.The [All] check box

    doublequotes

    Placed before and after ascreen name (such as a dialogbox window), or the name of amanual other than this one.

    Setting windowInstallation Guide

    [ ] squarebrackets in thecommand line

    Indicates that the specificationof the value in [ ] can beomitted.

    add [/a] Gr1

    Monospacefont

    Output from the command-line system (such as a messageprompt)

    Execute the following command:replace Gr1

    Italicizedmonospacefont

    An item that should bereplaced by users with a validvalueIf the value contains a space,surround it with " " (doublequotes).

    add GroupNameInstallPath= Install Path

    Json example Json examples are shown withbreaks and indents added inorder to improve thereadability.

    { "ID": [ "45ed3512" ], "Manager": { "ErrorMessage": "", "Name": "localhost", "Status": 200, "StatusCode": 200 }}

    iii

  • ContentsChapter 1. Functional outline ..................................................................................................... 1

    1.1 WebAPI function outline.......................................................................................................2

    1.2 System configuration to use WebAPI ....................................................................................3

    1.3 Preparation for Using Web API.............................................................................................5

    Chapter 2. Prerequisites .............................................................................................................. 6

    Chapter 3. Common Specifications of API................................................................................ 73.1 HTTP method .......................................................................................................................8

    3.2 JSON ....................................................................................................................................83.2.1 JSON specifications ....................................................................................................83.2.2 Character encoding......................................................................................................8

    3.3 Request format ......................................................................................................................83.3.1 HTTP header...............................................................................................................83.3.2 URL ............................................................................................................................93.3.3 HTTP message body ...................................................................................................9

    3.4 API Authentication Key ........................................................................................................9

    3.5 Response format..................................................................................................................113.5.1 Common HTTP status code.......................................................................................113.5.2 Error format ..............................................................................................................12

    3.6 End point.............................................................................................................................12

    3.7 Parameter description..........................................................................................................133.7.1 How to View Parameters using methods other than API............................................13

    Chapter 4. External interface (common) ................................................................................. 144.1 Business ..............................................................................................................................15

    4.1.1 Getting the business tree configuration......................................................................154.1.2 Getting business node information ............................................................................204.1.3 Adding a category group ...........................................................................................244.1.4 Updating a category group ........................................................................................274.1.5 Deleting the category group ......................................................................................304.1.6 Adding a category .....................................................................................................314.1.7 Updating the category ...............................................................................................344.1.8 Deleting the category ................................................................................................374.1.9 Getting a filter list .....................................................................................................384.1.10 Getting filter details.................................................................................................474.1.11 Editing the filter definition of a category .................................................................534.1.12 Starting and stopping monitoring (with categories specified) ..................................70

    4.2 Topology.............................................................................................................................734.2.1 Getting the topology tree configuration .....................................................................734.2.2 Getting topology node information............................................................................784.2.3 Starting/Stopping monitoring (Specifying the agents) ...............................................82

    iv

  • 4.2.4 Adding a host group ..................................................................................................854.2.5 Deleting the host group .............................................................................................874.2.6 Updating the host group .