--- title: モニターグループ検索 description: モニターグループの詳細を検索およびフィルタリングします。 breadcrumbs: ドキュメント > API > モニターグループ検索 --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/llms.txt). # モニターグループ検索 ## v1 (latest) | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v1/monitor/groups/search | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v1/monitor/groups/search | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v1/monitor/groups/search | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v1/monitor/groups/search | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v1/monitor/groups/search | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v1/monitor/groups/search | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v1/monitor/groups/search | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v1/monitor/groups/search | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v1/monitor/groups/search | ### Overview モニターグループの詳細を検索およびフィルタリングします。 This endpoint requires the `monitors_read` permission. OAuth apps require the `monitors_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/ja/api/latest/scopes.md#monitors) to access this endpoint. ### Arguments #### Query Strings | Field | Type | Description | | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | query | string | After entering a search query on the [Triggered Monitors page](https://app.datadoghq.com/monitors/triggered), 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](https://dnd37xeb23o8n.cloudfront.net/monitors/manage.md#triggered-monitors). The query can contain any number of space-separated monitor attributes, for instance: `query="type:metric group_status:alert"`. | | page | integer | Page to start paginating from. Default: `0`. | | per_page | integer | Number of monitors to return per page. Default: `30`. | | sort | string | 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: * `name` * `status` * `tags` | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} The response of a monitor group search. | Parent field | Field | Type | Description | | ------------ | ----------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | | counts | object | The counts of monitor groups per different criteria. Read-only. | | counts | status | [object] | Search facets. | | status | count | int64 | The number of found monitors with the listed value. Read-only. | | status | name | any | The facet value. Read-only. | | counts | type | [object] | Search facets. | | type | count | int64 | The number of found monitors with the listed value. Read-only. | | type | name | any | The facet value. Read-only. | | | groups | [object] | The list of found monitor groups. Read-only. | | groups | group | string | The name of the group. Read-only. | | groups | group_tags | [string] | The list of tags of the monitor group. Read-only. | | groups | last_nodata_ts | int64 | Latest timestamp the monitor group was in NO_DATA state. Read-only. | | groups | last_triggered_ts | int64 | Latest timestamp the monitor group triggered. Read-only. | | groups | monitor_id | int64 | The ID of the monitor. Read-only. | | groups | monitor_name | string | The name of the monitor. Read-only. | | groups | status | enum | The different states your monitor can be in. Read-only. Allowed enum values: `Alert`, `Ignored`, `No Data`, `OK`, `Skipped`, `Unknown`, `Warn`. | | | metadata | object | Metadata about the response. | | metadata | page | int64 | The page to start paginating from. Read-only. | | metadata | page_count | int64 | The number of pages. Read-only. | | metadata | per_page | int64 | The number of monitors to return per page. Read-only. | | metadata | total_count | int64 | The total number of monitors. Read-only. | {% /tab %} {% tab label="Example" %} ```json { "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 } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} Error response object. | Field | Type | Description | | ------------------- | -------- | ------------------------------------ | | errors [*required*] | [string] | Array of errors returned by the API. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v1/monitor/groups/search" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // 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()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // 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(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Monitors group search returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v1.api.monitors_api import MonitorsApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Monitors group search returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V1::MonitorsAPI.new p api_instance.search_monitor_groups() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Monitors group search returns "OK" response */ import { client, v1 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% tab label="Python [legacy]" %} ```python from datadog import initialize, api options = { 'api_key': '', 'app_key': '' } initialize(**options) # Search monitor groups api.Monitor.search_groups() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python-legacy) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" python "example.py" ``` {% /tab %} {% tab label="Ruby [legacy]" %} ```ruby require 'dogapi' api_key = '' app_key = '' dog = Dogapi::Client.new(api_key, app_key) # Search monitor groups dog.search_monitor_groups ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby-legacy) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ``` {% /tab %} {% /tabs %}