×
![]()
Status - BSM - Service
List Copied
REST API: /status/bsmservice
Used for BSM Summary and Detail view.
Input parameters:
bsid=X— Select based on bsid. If not specified, return all BSMs.cid=X— Select business services by component id.bs_status=X— Filters BSMs by this status. Valid values are: “OPERATIONAL”, “OFFLINE”, “DOWNTIME”. Case insensitive. Can be repeated for multiple status as an OR condition. The IMPACTED should be filtered with the impacted flag.impacted=X— If set to 1, will filters by impacted state. Defaults to no filter.component_detail=TRUE— Default FALSE. If true, will returned the components attribute with detailed component information.host_detail— passed to Component.List.ht_detail— passed to Component.List.
Example output Copied
{ list: [{
id: 1, // BSM id
name: 'Google Analytics',
availability: 70.34, // Amount of time that this business service not been FAILED. Do not return when filtered by cid
status: "OPERATIONAL", // Or "OFFLINE" or "DOWNTIME"
acknowledged: true, // Or false. If all components are acknowledged
impacted: true, // If the business service has any impacted components, then the business service is impacted
components_total: 6,
components_failed: 4,
components_acknowledged: 0,
components_impacted: 2,
components_downtime: 2,
components: {
summary: { // Same as from component list({ bs: 1 } )
...
},
list: [{
id: 73, // component id
name: "MySQL Cluster 3",
availability: 93.56,
htname: 'Database - MySQL Server',
htid: 56, // host template id
hosts:{ // This list is the same as StatusBsmHost.list()
},
},{
...
}],
},
},{
...
}],
summary: {
success: true,
total: 3
}
}
["Opsview On-premises"]
["API", "Technical Reference"]