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
API overview
HTTP |
URI |
Return |
Return type |
---|---|---|---|
|
|
|
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- |
Description |
---|---|---|---|
|
|
0..1 |
URL to call when the operation finishes |
|
|
0..1 |
Identifier of a callout to run after the operation executes |
|
|
0..1 |
Identifier of a callout to run before the operation executes |
|
|
0..1 |
Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:
|
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.
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
API overview
HTTP |
URI |
Return |
Return type |
---|---|---|---|
|
|
|
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- |
Description |
---|---|---|---|
|
|
0..1 |
URL to call when the operation finishes |
|
|
0..1 |
Identifier of a callout to run after the operation executes |
|
|
0..1 |
Identifier of a callout to run before the operation executes |
|
|
0..1 |
Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values:
|
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.
Comments
Log in or register to comment.