Unsupported content This version of the product has reached end of support. The documentation is available for your convenience. However, you must be logged in to access it. You will not be able to leave comments.

ServiceOfferingInstance evaluateSensors request


Description

This operation refreshes all sensors in the Service Offering Instance.
 It retrieves SOI CloudObjects. Retrieves Sensor and SensorAttribute instances from CloudObjects for only those SensorAttributes that have SensorAttributeThresholds defined on them.
 Forms Sensor trees.
 Invokes Sensor#refreshSensors, passing in the Sensor tree roots to retrieve the Sensor data.
 Then, SensorAttributeThresholds are evaluated.
 Then, Policies are evaluated.

API stability classification

Unstable

API overview

HTTP
method

URI

Return
type

Return type
multiplicity

POST

csm/ServiceOfferingInstance/guid/evaluateSensors

void

Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name

Type

Multi-
plicity

Description

callbackURL
String

0..1

URL to call when the operation finishes

postCallout
String

0..1

Identifier of a callout to run after the operation executes

preCallout
String

0..1

Identifier of a callout to run before the operation executes

timeout
Integer

0..1

Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values:

  • 0: Immediate timeout
  • -1: Uses the system default timeout value
  • 1..*: Times out in the specified number of seconds

HTTP response message

Response message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Response message body

The response message body contains a Task object.
Unknown macro: bmc-safe-include. Click on this message for details.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*