GET https://api.ap1.datadoghq.com/api/v1/monitor/groups/search https://api.ap2.datadoghq.com/api/v1/monitor/groups/search https://api.datadoghq.eu/api/v1/monitor/groups/search https://api.ddog-gov.com/api/v1/monitor/groups/search https://api.us2.ddog-gov.com/api/v1/monitor/groups/search https://api.uk1.datadoghq.com/api/v1/monitor/groups/search https://api.datadoghq.com/api/v1/monitor/groups/search https://api.us3.datadoghq.com/api/v1/monitor/groups/search https://api.us5.datadoghq.com/api/v1/monitor/groups/search
Présentation Recherchez et filtrez vos groupes de monitors.
This endpoint requires the monitors_read permission.
OAuth apps require the monitors_read authorization scope to access this endpoint.
Arguments Chaînes de requête
After entering a search query on the Triggered Monitors page , use the query parameter value in the
URL of the page as a value for this parameter. For more information, see the Manage Monitors documentation .
The query can contain any number of space-separated monitor attributes, for instance: query="type:metric group_status:alert".
Page to start paginating from.
Number of monitors to return per page.
String for sort order, composed of field and sort order separate by a comma, for example name,asc. Supported sort directions: asc, desc. Supported fields:
Réponse OK
The response of a monitor group search.
Expand All
The counts of monitor groups per different criteria.
The number of found monitors with the listed value.
The number of found monitors with the listed value.
The list of found monitor groups.
The list of tags of the monitor group.
Latest timestamp the monitor group was in NO_DATA state.
Latest timestamp the monitor group triggered.
The different states your monitor can be in.
Allowed enum values: Alert,Ignored,No Data,OK,Skipped,Unknown,Warn
Metadata about the response.
The page to start paginating from.
The number of monitors to return per page.
The total number of monitors.
{
"counts" : {
"status" : [
{
"count" : 2 ,
"name" : "OK"
}
],
"type" : [
{
"count" : 2 ,
"name" : "metric"
}
]
},
"groups" : [
{
"group" : "*" ,
"group_tags" : [
"*"
],
"last_nodata_ts" : 0 ,
"last_triggered_ts" : 1525702966 ,
"monitor_id" : 2738266 ,
"monitor_name" : "[demo] Cassandra disk usage is high on {{host.name}}" ,
"status" : "OK"
},
{
"group" : "*" ,
"group_tags" : [
"*"
],
"last_nodata_ts" : 0 ,
"last_triggered_ts" : 1525703008 ,
"monitor_id" : 1576648 ,
"monitor_name" : "[demo] Disk usage is high on {{host.name}}" ,
"status" : "OK"
}
],
"metadata" : {
"page" : 0 ,
"page_count" : 2 ,
"per_page" : 30 ,
"total_count" : 2
}
} Bad Request
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Forbidden
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Too many requests
Error response object.
Expand All
Array of errors returned by the API.
{
"errors" : [
"Bad Request"
]
} Exemple de code Copier
# Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v1/monitor/groups/search " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Monitors group search returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v1.api.monitors_api import MonitorsApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = MonitorsApi ( api_client )
response = api_instance . search_monitor_groups ()
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Monitors group search returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V1 :: MonitorsAPI . new
p api_instance . search_monitor_groups ()
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi :: Client . new ( api_key , app_key )
# Search monitor groups
dog . search_monitor_groups
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Monitors group search returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV1"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV1 . NewMonitorsApi ( apiClient )
resp , r , err := api . SearchMonitorGroups ( ctx , * datadogV1 . NewSearchMonitorGroupsOptionalParameters ())
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `MonitorsApi.SearchMonitorGroups`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `MonitorsApi.SearchMonitorGroups`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Monitors group search returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v1.api.MonitorsApi ;
import com.datadog.api.client.v1.model.MonitorGroupSearchResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
MonitorsApi apiInstance = new MonitorsApi ( defaultClient );
try {
MonitorGroupSearchResponse result = apiInstance . searchMonitorGroups ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling MonitorsApi#searchMonitorGroups" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
from datadog import initialize , api
options = {
'api_key' : '<DATADOG_API_KEY>' ,
'app_key' : '<DATADOG_APPLICATION_KEY>'
}
initialize ( ** options )
# Search monitor groups
api . Monitor . search_groups ()
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python "example.py"
// Monitors group search returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV1 ::api_monitors ::MonitorsAPI ;
use datadog_api_client ::datadogV1 ::api_monitors ::SearchMonitorGroupsOptionalParams ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = MonitorsAPI ::with_config ( configuration );
let resp = api
. search_monitor_groups ( SearchMonitorGroupsOptionalParams ::default ())
. await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Monitors group search returns "OK" response
*/
import { client , v1 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v1 . MonitorsApi ( configuration );
apiInstance
. searchMonitorGroups ()
. then (( data : v1.MonitorGroupSearchResponse ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"