You can obtain the metadata for JSON objects that are used by data-acquisition API resources (for example, the API resource for obtaining a list of RAID Agent instances) other than the resource for obtaining performance data. The representation of metadata follows the JSON Schema. Note that the metadata for resources that obtain performance data is always provided together with CSV headers. You cannot obtain only metadata.
HTTP request syntax (URI)
GET <scheme>://<host>:<port>/<application>/<version>/domain-types/<object-type>
- Values that can be specified for <object-type>
- Specify one of the following values for <object-type> below the domain-types domain:
-
Metadata to be obtained Value to be specified for <object-type> Metadata of the Collection object Collection Metadata of the Error object Error Metadata of the Version object Version Metadata of the Action object Action Metadata of the Job object Job Metadata of the Agents object Agents Metadata of the AgentForRAID object AgentForRAID
Request structure
Not applicable.
Response structure
The schema follows the JSON Schema for the individual object.
The following shows the configuration of the response body received when metadata on the AgentForRAID object is obtained.
{ "title" : "AgentForRAID", "type" : "object", "properties" :
{
"instanceName" : { "type" : "string" },
"hostName" : { "type" : "string" },
"ipAddr" : { "type" : "string" },
"dataModelVersion" : { "type" : "decimal"},
"lastUpdateTime" : { "type" : "string" },
"storageVendor" : { "type" : "string" },
"storageModel" : { "type" : "string" },
"storageSerialNumber" : { "type" : "string" }
},
"required" : [ "instanceName", "hostName" ]}
Example (obtaining metadata for an AgentForRAID object)
Request message by using the curl command
curl -v -u system:manager -X GET https://server_1:22016/Analytics/RAIDAgent/v1/domain-types/AgentForRAID
Execution result for the request:
Request header
GET /Analytics/RAIDAgent/v1/domain-types/AgentForRAID HTTP/1.1 Authorization: Basic c3lzdGVtOm1hbmFnZXI= User-Agent: curl/7.19.7 (i386-redhat-linux-gnu) libcurl/7.19.7 NSS/ 3.12.9.0 zlib/1.2.3 libidn/1.18 libssh2/1.2.2 Host: server_1:22016 Accept: */*
Response header
HTTP/1.1 200 OK Date: Fri, 20 Jun 2014 12:37:25 GMT Server: Cosminexus HTTP Server Last-Modified: Thu, 29 May 2014 16:22:18 GMT Cache-Control: private, max-age=86400 Transfer-Encoding: chunked Content-Type: application/schema+json;charset=utf-8
Response body
{ "title" : "AgentForRAID", "type" : "object", "properties" :
{
"instanceName" : { "type" : "string" },
"hostName" : { "type" : "string" },
"ipAddr" : { "type" : "string" },
"dataModelVersion" : { "type" : "decimal"},
"lastUpdateTime" : { "type" : "string" },
"storageVendor" : { "type" : "string" },
"storageModel" : { "type" : "string" },
"storageSerialNumber" : { "type" : "string" }
},
"required" : [ "instanceName", "hostName" ]}