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>).
Format of the URI:
<scheme>//<host>:<port>/<object-type>[?<query-string>]Or
<scheme>//<host>:<port>/<object-type>/actions/[<action-identifier>[/invoke]]
In this manual, "<scheme>//<host>:<port>/" is transcribe into baseURL.
The following table describes the URI components.
Item | Description |
---|---|
<scheme> | Protocol. Specify HTTP or HTTPS. |
<host> | Host name or IP address of the Analyzer detail view host that is accessible from an API server. |
<port> | Port number of the Analyzer detail view host that is accessible from an API server. The default port number is 8443 for HTTPS. |
<object-type> | Indicates the resource or service. |
<query-string> |
Query string that specifies a query parameter. This specifies a condition for reducing or sorting <object-type>. The available query parameters depend on resources and can be in any order. |
<action-identifier> | Indicates the action for the resource. |
Note: The components and other details of URIs vary for each API function. For more information, see the descriptions of the applicable API function.