List Capabilities

Overview

  • Lists information for API and storage capabilities of the SDPF Monitoring service.
  • This API returns returns a flattened dictionary of capability properties, each with an associated boolean value. A value of "true" indicates that the corresponding capability is available in the SDPF Monitoring service.
  • This API performs the same function as "OpenStack Telemetry API: GET /v2/capabilities".

Classification

  • List

API Operation Object

  • capability

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v2/capabilities

HTTP Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: <token_id>

HTTP Request Body

  • none

Request Parameter

Input Parameters
name style format description required/optional default value action for invalid parameter response code for invalid parameter
token_id Header authentication token string authentication token required - Terminate 401

Response

Response Header

Format

HTTP/1.1 <response_code> <status>       (ex. 200 OK)
Content-Type: application/json; charset=utf-8
  • <response_code>: see "Response Code" section
  • <status>: message based on the response code

注釈

Not including auto-insert fields such as "Transfer-Encoding", "Date" and others.

Response Code

Response Codes
response code status condition message
200 ok normal end  
401 unauthorized authentication failure The request you have made requires authentication.
500 internal server error internal server error The request processing has failed due to some unknown error, exception or failure

Response Body

Format

{
    "alarm_storage": {
    "storage:production_ready": true
    },
    "api": {
    "alarms:history:query:complex": false,
    "alarms:history:query:simple": true,
    "alarms:query:complex": false,
    "alarms:query:simple": true,
    "events:query:simple": false,
    "meters:query:complex": false,
    "meters:query:metadata": false,
    "meters:query:simple": true,
    "resources:query:complex": false,
    "resources:query:metadata": false,
    "resources:query:simple": true,
    "samples:query:complex": false,
    "samples:query:metadata": false,
    "samples:query:simple": true,
    "statistics:aggregation:selectable:avg": false,
    "statistics:aggregation:selectable:cardinality": false,
    "statistics:aggregation:selectable:count": false,
    "statistics:aggregation:selectable:max": false,
    "statistics:aggregation:selectable:min": false,
    "statistics:aggregation:selectable:quartile": false,
    "statistics:aggregation:selectable:stddev": false,
    "statistics:aggregation:selectable:sum": false,
    "statistics:aggregation:standard": false,
    "statistics:groupby": false,
    "statistics:query:complex": false,
    "statistics:query:metadata": false,
    "statistics:query:simple": true
    },
    "event_storage": {
        "storage:production_ready": false
    },
    "storage": {
        "storage:production_ready": true
    }
}

Response Parameter

Response Parameters
item format   description
api list   the list of APIs supported by SDPF Monitoring
alarms:history:query:complex Boolean   false ... SDPF Monitoring doesn't support complex queries
alarms:history:query:simple Boolean   true ... SDPF Monitoring supports the alarm history APIs with simple queries
alarms:query:complex Boolean   false ... SDPF Monitoring doesn't support complex queries
alarms:query:simple Boolean   true ... SDPF Monitoring supports the alarm APIs with simple queries
events:query:simple Boolean   false ... SDPF Monitoring doesn't support the event APIs
meters:query:complex Boolean   false ... SDPF Monitoring doesn't support complex queries
meters:query:metadata Boolean   false ... SDPF Monitoring doesn't support metadata
meters:query:simple Boolean   true ... SDPF Monitoring supports the meter APIs with simple queries
resources:query:complex Boolean   false ... SDPF Monitoring doesn't support complex queries
resources:query:metadata Boolean   false ... SDPF Monitoring doesn't support metadata
resources:query:simple Boolean   true ... SDPF Monitoring supports the resource APIs with simple queries
samples:query:complex Boolean   false ... SDPF Monitoring doesn't support complex queries
samples:query:metadata Boolean   false ... SDPF Monitoring doesn't support metadata
samples:query:simple Boolean   true ... SDPF Monitoring supports the sample APIs with simple queries
statistics:aggregation:selectable:avg Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:cardinality Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:count Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:max Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:min Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:quartile Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:stddev Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:selectable:sum Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:aggregation:standard Boolean   false ... SDPF Monitoring doesn't support aggregation
statistics:groupby Boolean   false ... SDPF Monitoring doesn't support groupby
statistics:query:complex Boolean   false ... SDPF Monitoring doesn't support complex queries
statistics:query:metadata Boolean   false ... SDPF Monitoring doesn't support metadata
statistics:query:simple Boolean   true ... SDPF Monitoring supports the meter statistics API with simple queries
alarm_storage list   the capability to store alarms and histories
event_storage list   the capability to store events
storage list   the capability to store samples
storage:production_ready Boolean   indicates whether the corresponding storage is available or not

Sample Request and Response

Sample API Request

Request URL

GET /v2/capabilities

Request Header

Content-Type: application/json
Accept: application/json
X-Auth-Token: 61389973e52b49c394ba3b89179b290b

Request Body

  • none

Sample API Response

Response Header

HTTP/1.1 200 OK

Response Body

{
    "alarm_storage": {
    "storage:production_ready": true
    },
    "api": {
    "alarms:history:query:complex": false,
    "alarms:history:query:simple": true,
    "alarms:query:complex": false,
    "alarms:query:simple": true,
    "events:query:simple": false,
    "meters:query:complex": false,
    "meters:query:metadata": false,
    "meters:query:simple": true,
    "resources:query:complex": false,
    "resources:query:metadata": false,
    "resources:query:simple": true,
    "samples:query:complex": false,
    "samples:query:metadata": false,
    "samples:query:simple": true,
    "statistics:aggregation:selectable:avg": false,
    "statistics:aggregation:selectable:cardinality": false,
    "statistics:aggregation:selectable:count": false,
    "statistics:aggregation:selectable:max": false,
    "statistics:aggregation:selectable:min": false,
    "statistics:aggregation:selectable:quartile": false,
    "statistics:aggregation:selectable:stddev": false,
    "statistics:aggregation:selectable:sum": false,
    "statistics:aggregation:standard": false,
    "statistics:groupby": false,
    "statistics:query:complex": false,
    "statistics:query:metadata": false,
    "statistics:query:simple": true
    },
    "event_storage": {
        "storage:production_ready": false
    },
    "storage": {
        "storage:production_ready": true
    }
}

Sample Error Response

HTTP Request

GET /v2/capabilities
User-Agent: curl/7.19.7
Content-Type: application/json
Accept: application/json
X-Auth-Token: INVALID_TOKEN

HTTP Response

HTTP/1.1 401 Unauthorized
Date: Wed, 20 Jul 2016 02:12:09 GMT
Server: Apache
Cache-Control: no-cache
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Status: 401 Unauthorized
Connection: close
Transfer-Encoding: chunked
Content-Type: application/json; charset=utf-8

{"error":{"code":401,"message":"The authentication had failed.","title":"Unauthorized"}}
2.5. Check Capability
3. Smart Data Platform Monitoring API DataType List