Use URIs to specify resources for API functions. A URI contains a basic URI (from <schema> to <version>) and a relative URI (<domain> and followings). Resources are identified with the relative URI (starting from <domain>).
See the following example format and URI components list:
- Format of a URI:
-
<scheme>//<host>:<port>/<application>/<version>/<domain>/<object-type>[?<query-string>]
or
<scheme>//<host>:<port>/<application>/<version>/<domain>/<object-type>/actions/[<action-identifier>[/invoke]]
In this manual, "<scheme>//<host>:<port>/<application>" may transcribe it into "baseURL".
The following list describes the URI components.
|
Item |
Description |
|---|---|
|
<scheme> |
Protocol. Specify "HTTP" or "HTTPS". |
|
<host> |
Host name or IP address of the Ops Center Analyzer host accessed from an API client. |
|
<port> |
Port number of the Ops Center Analyzer host accessed from an API client. The default port number is 22015 for HTTP, and 22016 for HTTPS. |
|
<application> |
Name of the application that provides the API functions. Specify either "Analytics" or "Analytics/RAIDAgent", depending on the API function you are using. |
|
<version> |
Your version of the API functions. Specify "v1". |
|
<domain> |
Category of the resource specified for the API function. |
|
<object-type> |
Indicates the resource or service. |
|
<query-string> |
Query parameter that specifies a query parameter. This specifies a condition for reducing or sorting <object-type>. The available query parameters depend on resources. The query parameters can be in any order. For details, see HQL syntax relationships and operators. |
|
<action-identifier> |
This indicates the action for the resource. |
The components and other details of URIs vary for each API function. For more information, see the descriptions of the applicable API function.
You can execute the REST API functions of Analyzer detail view via Ops Center Analyzer. The table below shows the URLs corresponding to the REST API functions of Analyzer detail view that can be executed via Ops Center Analyzer. For details, including the parameters to be specified for the REST API functions, see the Hitachi Ops Center Analyzer Detail View REST API Reference Guide.
|
URLs for REST API functions in Ops Center Analyzer |
URLs for the corresponding REST API functions in Analyzer detail view |
|---|---|
|
https://<host>:<port>/Analytics/v1/DbQuery/actions/dbapi?<query-string> |
https://<IP-address-of-Analyzer-detail-view>:<port-number-of-Analyzer-detail-view>/dbapi.do?<query-string> |
|
https://<host>:<port>/Analytics/v1/DbQuery/actions/alertapi?<query-string> |
https://<IP-address-of-Analyzer-detail-view>:<port-number-of-Analyzer-detail-view>/alertapi.do?<query-string> |
To execute a REST API function of Analyzer detail view via Ops Center Analyzer, specify Ops Center Analyzer authentication information in the request header.
When executing a REST API function of Analyzer detail view, use the user shown in the following table according to the permissions set for the Ops Center Analyzer authentication information specified in the request header:
|
Ops Center Analyzer permission set for the Ops Center Analyzer authentication information |
Analyzer detail view user used when the REST API function of Analyzer detail view is executed |
|---|---|
|
Admin, Modify |
HIAA_REST_Admin |
|
Admin |
HIAA_REST_Admin |
|
Modify |
HIAA_REST_Normal |