--- title: メトリクス名で個別のメトリクスボリュームを一覧表示する description: 指定されたメトリクス名に対する個別のメトリクスボリュームを表示します。 他の製品からアプリ内で生成されたカスタムメトリクスは、取り込まれたボリュームに対して null を返します。 breadcrumbs: ドキュメント > API > メトリクス名で個別のメトリクスボリュームを一覧表示する --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # メトリクス名で個別のメトリクスボリュームを一覧表示する ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/metrics/{metric_name}/volumes | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/metrics/{metric_name}/volumes | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/metrics/{metric_name}/volumes | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/metrics/{metric_name}/volumes | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/metrics/{metric_name}/volumes | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/metrics/{metric_name}/volumes | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/metrics/{metric_name}/volumes | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/metrics/{metric_name}/volumes | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/metrics/{metric_name}/volumes | ### Overview 指定されたメトリクス名に対する個別のメトリクスボリュームを表示します。 他の製品からアプリ内で生成されたカスタムメトリクスは、取り込まれたボリュームに対して `null` を返します。 ### Arguments #### Path Parameters | Field | Type | Description | | ------------------------ | ------ | ----------------------- | | metric_name [*required*] | string | The name of the metric. | #### Query Strings | Field | Type | Description | | --------------- | ------- | --------------------------------------------------------------------------------------------------------------------- | | window[seconds] | integer | The number of seconds of look back (from now). Default value is 3,600 (1 hour), maximum value is 2,592,000 (1 month). | ### Response {% tabs %} {% tab label="200" %} Success {% tabs %} {% tab label="Model" %} Response object which includes a single metric's volume. | Parent field | Field | Type | Description | | ------------------------------ | ------------------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | | Possible response objects for a metric's volume. | | data | | object | Object for a single metric's distinct volume. | | | attributes | object | Object containing the definition of a metric's distinct volume. | | attributes | distinct_volume | int64 | Distinct volume for the given metric. | | | id | string | The metric name for this resource. | | | type | enum | The metric distinct volume type. Allowed enum values: `distinct_metric_volumes`. Default: `distinct_metric_volumes`. | | data | | object | Object for a single metric's ingested and indexed volume. | | | attributes | object | Object containing the definition of a metric's ingested and indexed volume. | | attributes | indexed_volume | int64 | Estimated average hourly number of indexed time series for the given metric over the last hour. For organizations on Metric Name Pricing, this represents the estimated sum of indexed data points over the last hour. | | attributes | ingested_volume | int64 | Estimated average hourly number of ingested time series for the given metric over the last hour. This value is `0` for metrics not configured with Metrics Without Limits. For organizations on Metric Name Pricing, this represents the estimated sum of ingested data points over the last hour. | | | id | string | The metric name for this resource. | | | type | enum | The metric ingested and indexed volume type. Allowed enum values: `metric_volumes`. Default: `metric_volumes`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "distinct_volume": 10 }, "id": "test.metric.latency", "type": "distinct_metric_volumes" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Forbidden {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="404" %} Not Found {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too Many Requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export metric_name="dist.http.endpoint.request" # 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/v2/metrics/${metric_name}/volumes" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // List distinct metric volumes by metric name returns "Success" 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/datadogV2" ) 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 := datadogV2.NewMetricsApi(apiClient) resp, r, err := api.ListVolumesByMetricName(ctx, "static_test_metric_donotdelete", *datadogV2.NewListVolumesByMetricNameOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `MetricsApi.ListVolumesByMetricName`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `MetricsApi.ListVolumesByMetricName`:\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 // List distinct metric volumes by metric name returns "Success" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.MetricsApi; import com.datadog.api.client.v2.model.MetricVolumesResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); MetricsApi apiInstance = new MetricsApi(defaultClient); try { MetricVolumesResponse result = apiInstance.listVolumesByMetricName("static_test_metric_donotdelete"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling MetricsApi#listVolumesByMetricName"); 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 """ List distinct metric volumes by metric name returns "Success" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.metrics_api import MetricsApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = MetricsApi(api_client) response = api_instance.list_volumes_by_metric_name( metric_name="static_test_metric_donotdelete", ) 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 # List distinct metric volumes by metric name returns "Success" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::MetricsAPI.new p api_instance.list_volumes_by_metric_name("static_test_metric_donotdelete") ``` #### 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 // List distinct metric volumes by metric name returns "Success" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_metrics::ListVolumesByMetricNameOptionalParams; use datadog_api_client::datadogV2::api_metrics::MetricsAPI; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = MetricsAPI::with_config(configuration); let resp = api .list_volumes_by_metric_name( "static_test_metric_donotdelete".to_string(), ListVolumesByMetricNameOptionalParams::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 /** * List distinct metric volumes by metric name returns "Success" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.MetricsApi(configuration); const params: v2.MetricsApiListVolumesByMetricNameRequest = { metricName: "static_test_metric_donotdelete", }; apiInstance .listVolumesByMetricName(params) .then((data: v2.MetricVolumesResponse) => { 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 %} {% /tabs %}