GET https://api.ap1.datadoghq.com/api/v1/dashboard/lists/manual https://api.ap2.datadoghq.com/api/v1/dashboard/lists/manual https://api.datadoghq.eu/api/v1/dashboard/lists/manual https://api.ddog-gov.com/api/v1/dashboard/lists/manual https://api.us2.ddog-gov.com/api/v1/dashboard/lists/manual https://api.uk1.datadoghq.com/api/v1/dashboard/lists/manual https://api.datadoghq.com/api/v1/dashboard/lists/manual https://api.us3.datadoghq.com/api/v1/dashboard/lists/manual https://api.us5.datadoghq.com/api/v1/dashboard/lists/manual
概要 既存のダッシュボードリストの定義をすべて取得します。
This endpoint requires the dashboards_read permission.
OAuth apps require the dashboards_read authorization scope to access this endpoint.
応答 OK
Information on your dashboard lists.
Expand All
List of all your dashboard lists.
Object describing the creator of the shared element.
Date of creation of the dashboard list.
The number of dashboards in the list.
The ID of the dashboard list.
Whether or not the list is in the favorites.
Date of last edition of the dashboard list.
The name of the dashboard list.
The type of dashboard list.
{
"dashboard_lists" : [
{
"author" : {
"email" : "string" ,
"handle" : "string" ,
"name" : "string"
},
"created" : "2019-09-19T10:00:00.000Z" ,
"dashboard_count" : "integer" ,
"id" : "integer" ,
"is_favorite" : false ,
"modified" : "2019-09-19T10:00:00.000Z" ,
"name" : "My Dashboard" ,
"type" : "manual_dashboard_list"
}
]
} 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"
]
} コード例 コピー
# 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/dashboard/lists/manual " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Get all dashboard lists returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v1.api.dashboard_lists_api import DashboardListsApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = DashboardListsApi ( api_client )
response = api_instance . list_dashboard_lists ()
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"
# Get all dashboard lists returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V1 :: DashboardListsAPI . new
p api_instance . list_dashboard_lists ()
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 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi :: Client . new ( api_key , app_key )
result = dog . get_all_dashboard_lists () 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"
// Get all dashboard lists 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 . NewDashboardListsApi ( apiClient )
resp , r , err := api . ListDashboardLists ( ctx )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `DashboardListsApi.ListDashboardLists`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `DashboardListsApi.ListDashboardLists`:\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"
// Get all dashboard lists returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v1.api.DashboardListsApi ;
import com.datadog.api.client.v1.model.DashboardListListResponse ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
DashboardListsApi apiInstance = new DashboardListsApi ( defaultClient );
try {
DashboardListListResponse result = apiInstance . listDashboardLists ();
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling DashboardListsApi#listDashboardLists" );
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 )
api . DashboardList . get_all () 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"
// Get all dashboard lists returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV1 ::api_dashboard_lists ::DashboardListsAPI ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = DashboardListsAPI ::with_config ( configuration );
let resp = api . list_dashboard_lists (). 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
/**
* Get all dashboard lists returns "OK" response
*/
import { client , v1 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v1 . DashboardListsApi ( configuration );
apiInstance
. listDashboardLists ()
. then (( data : v1.DashboardListListResponse ) => {
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"