このセクションでは、HTTP API について取り上げ、Datadog でのデータの入出力の方法を説明します。
Datadog の HTTP API を使用するには、Datadog Postman コレクションをご利用ください
Datadog の API はリソース指向 URL を使用しています。リクエストの成否はステータスコードで示し、すべてのリクエストに対し JSON オブジェクトを返します。以下で具体的な仕組みを見ていきます。
注: cURL コードの例は、 BASH および GNU Core Utilities を使用することを想定したものです。macOS をお使いの方は Homebrew package manager から Coreutils をダウンロードして、次のコマンドでインストールが可能です: brew install coreutils
There are many client libraries that wrap the Datadog API.
SIGNATURE:
https://api.datadoghq.com/api/https://api.datadoghq.eu/api/Datadog の API へのすべてのリクエストに認証が必要です。データ書き込みリクエストには、レポートアクセス権と API キーが必要です。データ読み取りリクエストには、フルアクセス権のほかにアプリケーションキーも必要です。
from datadog import initialize, api
options = {'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>',
'api_host': 'https://api.datadoghq.com'}
initialize(**options)
require 'rubygems'
require 'dogapi'
dog = Dogapi::Client.new(:api_key => '<YOUR_API_KEY>', :application_key => '<YOUR_APP_KEY>', :endpoint => 'https://api.datadoghq.com')
curl "https://api.datadoghq.com/api/v1/validate" \
-H "DD-API-KEY: <YOUR_API_KEY>" \
-H "DD-APPLICATION-KEY: <YOUR_APPLICATION_KEY>"
Datadog API は、リクエストが成功したか失敗したかを HTTP ステータスコードで示します。
エラーは、サービスがリクエストを正しく処理しなかったことを示します。応答には、ステータスコードのほかに、詳細なエラーメッセージをエラー配列として含む JSON オブジェクトが含まれる場合があります。注: ライブラリを使用している場合、一部のエラーは、JSON オブジェクトを返す代わりに例外を生成します。
サービスがリクエストを処理できたのに何らかの問題が発生している場合 (たとえば、非推奨の API または API バージョンを使用している場合)、HTTP ステータスコードは成功を示し、応答本文には期待される結果のほかに、詳細な警告メッセージを含む警告配列も含まれます。
Status Codes:
200 OK201 Created202 Accepted204 No Content301 Moved Permanently304 Not Modified401 Unauthorized403 Forbidden404 Not Found409 Conflict413 Payload Too Large422 Unprocessable429 Too Many Requests500 Server ErrorExample Error Response:
{ 'errors': [
'Something bad happened to the server.',
'Your query made the server very sad.'
]
}
Example Warning Response:
{ 'some_thing': ...,
'some_other_thing': ...,
'warnings': [
'This is a deprecated API.'
]
}
一部の API エンドポイントでは、レートが制限されています。一定の時間内に所定のリクエスト数を超過すると、エラーが返されます。
レート制限がある API エンドポイントについては、ヘッダーが返されるので、制限にどの程度近づいているかを知ることができます。また、制限を超えた場合は、このヘッダーを確認して、いつ再試行できるかを判断できます。
デフォルトのレート制限を増加させたい場合は、Datadog のサポートチームにお問い合わせください。
API レート制限ポリシーについて
100/時間/Organization です。1000/集計/日/Organization です。集計は、類似のイベントのグループです。300/時間/Organization です。これは、オンデマンドで増やすことができます。60/時間/Organization です。これは、オンデマンドで増やすことができます。6000/分/Organization です。これは、オンデマンドで増やすことができます。Rate Limit Headers:
X-RateLimit-Limit number of requests allowed in a time periodX-RateLimit-Period length of time in seconds for resets (calendar aligned)X-RateLimit-Remaining number of allowed requests left in current time periodX-RateLimit-Reset time in seconds until next resetDatadog は、すべてのデータをキューに置いて非同期処理するため、API フロントエンドでは最小限のエラーチェックのみを行っています (これは、Datadog のシステムをお客様のシステムから切り離し、実稼働状態のお客様のデータを常に受け入れ続けるためです)。
したがって、202 の「成功」応答を受け取ることができても、そのデータが Datadog に表示されないことがあります。最も可能性が高い原因として、以下が挙げられます。
タイムスタンプが適切かどうかを確認するには、以下のコマンドを実行します。
date -u && curl -s -v https://app.datadoghq.com 2>&1 | grep -i '< date'
これは、現在のシステムの日付を出力してから、API エンドポイントの 1 つに、Datadog 側の日付を取得するようにリクエストを行います。これらの値が数分以上離れている場合は、サーバーの時間設定を確認する必要があります。
また、送信に必須ではないが、有効な入力を必要するフィールドもあります。たとえば、イベントを送信する際、priority フィールドには、4 つのオプションのいずれかが入力されている必要があります。
他のテキストを指定すると、コード 202 の「成功」の結果になりますが、イベントは表示されません。source_type_name が無効であっても、イベントの表示は妨げられませんが、そのフィールドは送信時に削除されます。
注: Datadog API キーは大文字と小文字が区別されます。POST エンドポイントの JSON 属性はすべて小文字にする必要があります。
サービスチェックエンドポイントを使用すると、モニターで使用されるチェックステータスをポストできます。
サービスチェックのメッセージは 500 文字に制限されます。500 文字を超えるメッセージを含むチェックがポストされた場合は、最初の 500 文字だけが表示されます。
check [必須]:
メッセージのテキスト
host_name [必須]:
チェックを送信するホストの名前
status [必須]:
チェックのステータスを示す整数値
timestamp [オプション]:
イベントの POSIX タイムスタンプ
message [オプション]:
このステータスが発生した理由の説明
tags [オプション]:
このチェックのキー:値タグのリスト
SIGNATURE:
POST /v1/check_run
EXAMPLE REQUEST:
from datadog import initialize, api
from datadog.api.constants import CheckStatus
options = {'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'}
initialize(**options)
check = 'app.ok'
host = 'app1'
status = CheckStatus.OK # equals 0
tags = ['env:test']
api.ServiceCheck.check(check=check, host_name=host, status=status, message='Response: 200 OK', tags=tags)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# submitting a check doesn't require an app_key
dog = Dogapi::Client.new(api_key)
dog.service_check('app.is_ok', 'app1', 0, :message => 'Response: 200 OK', :tags => ['env:test'])
currenttime=$(date +%s)
curl -X POST -H "Content-type: application/json" \
-d "{
\"check\": \"app.is_ok\",
\"host_name\": \"app1\",
\"timestamp\": $currenttime,
\"status\": 0,
\"tags\": [\"env:test\"]
}" \
"https://api.datadoghq.com/api/v1/check_run?api_key=<YOUR_API_KEY>"
EXAMPLE RESPONSE:
{
'status': 'ok'
}
["202", {
"status" => "ok"
}]
{
"status": "ok"
}
コメントは、Datadog について議論を交わす場です。コメントを作成、編集、削除、返信します。
コメントは、基本的に、イベントストリームに表示される特別な形式のイベントです。新しいディスカッションスレッドを開始したり、別のスレッドに返信することもできます。
message [必須]:
コメントのテキスト。
handle [オプション、デフォルト = アプリケーションキーの所有者]:
コメントを作成しているユーザーのハンドル。
related_event_id [オプション、デフォルト = None]:
返信対象の別のコメントまたはイベントの ID。
SIGNATURE:
POST /v1/comments
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Start a new discussion.
# Include a handle like this
api.Comment.create(
handle='matt@example.com',
message='Should we use COBOL or Fortran!'
)
# Or set it to None
# and the handle defaults
# to the owner of the application key
api.Comment.create(message='Should we use COBOL or Fortran?')
# Reply to a discussion.
api.Comment.create(
handle='joe@example.com',
message='Smalltalk?',
related_event_id=1234
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Make a comment.
dog.comment("I have something to say.")api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"message" : "There is a problem with the database."
}' \
"https://api.datadoghq.com/api/v1/comments"
EXAMPLE RESPONSE:
{
'comment': {
'handle': 'matt@example.com',
'id': 2603645287324504065,
'message': 'Should we use COBOL or Fortran?',
'resource': '/api/v1/comments/2603645287324504065',
'url': '/event/jump_to?event_id=2603645287324504065'
}
}
["200", {
"comment" => {
"url" => "/event/jump_to?event_id=1382579089039712607",
"resource" => "/api/v1/comments/1382579089039712607",
"message" => "I have something to say.",
"handle" => "mattp+org-carlotest141@datadoghq.com",
"id" => 1382579089039712607
}
}]{
"comment": {
"handle": "mattp+org-carlotest141@datadoghq.com",
"id": 1382561676571697516,
"message": "There is a problem with the database.",
"resource": "/api/v1/comments/1382561676571697516",
"url": "/event/jump_to?event_id=1382561676571697516"
}
}message [オプション、デフォルト = 元の message]:
コメントのテキスト。
handle [オプション、デフォルト = アプリケーションキーの所有者]:
コメントを作成しているユーザーのハンドル。
SIGNATURE:
PUT /v1/comments/<COMMENT_ID>
from datadog import initialize, api
from time import sleep
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Edit a comment.
newcomment = api.Comment.create(
message='Should we use COBOL or Fortran or Widgets?'
)
sleep(1)
api.Comment.update(
newcomment['comment']['id'],
message='I think differently now!'
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
comment_id = "1382579089039712607"
dog = Dogapi::Client.new(api_key, app_key)
# Update a comment.
dog.update_comment(comment_id, :message => "I've changed my mind again")api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
comment_id=<COMMENT_ID>
# Create a comment to edit. Use jq (http://stedolan.github.io/jq/download/) to get the comment id.
comment_id=$(curl -X POST -H "Content-type: application/json" -H "DD-API-KEY: ${api_key}" -H "DD-APPLICATION-KEY: ${app_key}" -d '{"message" : "This comment was submitted and will be edited by the api."}' "https://api.datadoghq.com/api/v1/comments}" | jq -r '.comment.resource|ltrimstr("/api/v1/comments/")')
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"message" : "Actually, I am changing my mind."
}' \
"https://api.datadoghq.com/api/v1/comments/${comment_id}"
EXAMPLE RESPONSE:
{
'comment': {
'handle': 'matt@example.com',
'id': 2603645287324504065,
'message': 'I think differently now.',
'resource': '/api/v1/comments/2603645287324504065',
'url': '/event/jump_to?event_id=2603645287324504065'
}
}
["200", {
"comment" => {
"url" => "/event/jump_to?event_id=1382579089039712607",
"resource" => "/api/v1/comments/1382579089039712607",
"message" => "I've changed my mind again",
"handle" => "mattp+org-carlotest141@datadoghq.com",
"id" => 1382579089039712607
}
}]{
"comment": {
"handle": "mattp+org-carlotest141@datadoghq.com",
"id": 1382557387240472966,
"message": "Actually, I am changing my mind.",
"resource": "/api/v1/comments/1382557387240472966",
"url": "/event/jump_to?event_id=1382557387240472966"
}
}このエンドポイントを使用すると、ダッシュボードをプログラムで作成、更新、削除、およびクエリできます。
title [必須]:
ダッシュボードのタイトル。widgets [必須]:
ダッシュボードに表示するウィジェットのリスト。ウィジェットの定義は、次の形式に従います。definition [必須]:
ウィジェットの定義。id [オプション、デフォルト=自動生成された整数]:
ウィジェットの ID。layout_type [必須]:
ダッシュボードのレイアウトタイプ。使用可能な値: ordered (以前の Timeboard) または free (以前の Screenboard レイアウト)description [オプション、デフォルト = None]:
ダッシュボードの説明。is_read_only [オプション、デフォルト = False]:
このダッシュボードが読み取り専用かどうか。True の場合は、作成者と管理者だけがダッシュボードに変更を加えることができます。notify_list [オプション、デフォルト = None]:
このダッシュボードに変更が加えられたときに通知するユーザーのハンドルのリスト。template_variables [オプション、デフォルト = None]:
このダッシュボードのテンプレート変数のリスト。テンプレート変数の定義は、次の形式に従います。name [必須]:
変数の名前。default [オプション、デフォルト = None]:
ダッシュボード読み込み時のテンプレート変数のデフォルト値。prefix [オプション、デフォルト = None]:
変数に関連付けられるタグプレフィックス。このプレフィックスを持つタグだけが変数ドロップダウンに表示されます。SIGNATURE:
POST /v1/dashboard
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type': 'timeseries',
'requests': [
{'q': 'avg:system.mem.free{*}'}
],
'title': 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
'name': 'host1',
'prefix': 'host',
'default': 'my-host'
}]
api.Dashboard.create(title=title,
widgets=widgets,
layout_type=layout_type,
description=description,
is_read_only=is_read_only,
notify_list=notify_list,
template_variables=template_variables)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a dashboard.
title = 'Average Memory Free Shell'
widgets = [{
'definition': {
'type' => 'timeseries',
'requests' => [
{'q' => 'avg:system.mem.free{*}'}
],
'title' => 'Average Memory Free'
}
}]
layout_type = 'ordered'
description = 'A dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
'name' => 'host1',
'prefix' => 'host',
'default' => 'my-host'
}]
dog.create_board(title, widgets, layout_type, {
'description' => description,
'is_read_only' => is_read_only,
'notify_list' => notify_list,
'template_variables' => template_variables
})
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"title" : "Average Memory Free Shell",
"widgets" : [{
"definition": {
"type": "timeseries",
"requests": [
{"q": "avg:system.mem.free{*}"}
],
"title": "Average Memory Free"
}
}],
"layout_type": "ordered",
"description" : "A dashboard with memory info.",
"is_read_only": true,
"notify_list": ["user@domain.com"],
"template_variables": [{
"name": "host1",
"prefix": "host",
"default": "my-host"
}]
}' \
"https://api.datadoghq.com/api/v1/dashboard"
EXAMPLE RESPONSE:
{
'notify_list':[
'user@domain.com'
],
'description':'A dashboard with memory info.',
'template_variables':[
{
'default':'my-host',
'prefix':'host',
'name':'host1'
}
],
'is_read_only':True,
'id':'qc9-tuk-9kv',
'title':'Average Memory Free Shell',
'url':'/dashboard/qc9-tuk-9kv/average-memory-free-shell',
'created_at':'2019-02-05T01:20:56.323548+00:00',
'modified_at':'2019-02-05T01:20:56.323548+00:00',
'author_handle':'user@domain.com',
'widgets':[
{
'definition':{
'requests':[
{
'q':'avg:system.mem.free{*}'
}
],
'type':'timeseries',
'title':'Average Memory Free'
},
'id':2252428653625902
}
],
'layout_type':'ordered'
}
[
"200",
{
"notify_list" => ["user@domain.com"],
"description" => nil,
"template_variables" => nil,
"is_read_only" => true,
"id" => "qc9-tuk-9kv",
"title" => "Average Memory Free Shell",
"url" => "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at" => "2019-02-05T01:35:46.388000+00:00",
"modified_at" => "2019-02-05T01:35:46.388000+00:00",
"author_handle" => "user@domain.com",
"widgets" => [
{
"definition" => {
"requests" => [
{ "q" => "avg:system.mem.free{*}"}
],
"type" => "timeseries",
"title" => "Average Memory Free"
},
"id" => 2252428653625902
}
],
"layout_type" => "ordered"
}
]
{
"notify_list": [
"user@domain.com"
],
"description": "A dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Average Memory Free Shell",
"url": "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T01:06:36.636295+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "avg:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Average Memory Free"
},
"id": 2252428653625902
}
],
"layout_type": "ordered"
}
title [必須]:
ダッシュボードのタイトル。widgets [必須]:
ダッシュボードに表示するウィジェットのリスト。ウィジェットの定義は、次の形式に従います。definition [必須]:
ウィジェットの定義。id [オプション、デフォルト=自動生成された整数]:
ウィジェットの ID。layout_type [必須]:
ダッシュボードのレイアウトタイプ。使用可能な値: ordered (以前の Timeboard) または free (以前の Screenboard レイアウト)description [オプション、デフォルト = None]:
ダッシュボードの説明。is_read_only [オプション、デフォルト = False]:
このダッシュボードが読み取り専用かどうか。True の場合は、作成者と管理者だけがダッシュボードに変更を加えることができます。notify_list [オプション、デフォルト = None]:
このダッシュボードに変更が加えられたときに通知するユーザーのハンドルのリスト。template_variables [オプション、デフォルト = None]:
このダッシュボードのテンプレート変数のリスト。テンプレート変数の定義は、次の形式に従います。name [必須]:
変数の名前。default [オプション、デフォルト = None]:
ダッシュボード読み込み時のテンプレート変数のデフォルト値。prefix [オプション、デフォルト = None]:
変数に関連付けられるタグプレフィックス。このプレフィックスを持つタグだけが変数ドロップダウンに表示されます。SIGNATURE:
PUT /v1/dashboard/<DASHBOARD_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
title = 'Sum of Memory Free'
widgets = [{
'definition': {
'type': 'timeseries',
'requests': [
{'q': 'sum:system.mem.free{*}'}
],
'title': 'Sum Memory Free Shell'
}
}]
layout_type = 'ordered'
description = 'An updated dashboard with memory info.'
is_read_only = True
notify_list = ['user@domain.com']
template_variables = [{
'name': 'host1',
'prefix': 'host',
'default': 'my-host'
}]
api.Dashboard.update(dashboard_id,
title=title,
widgets=widgets,
layout_type=layout_type,
description=description,
is_read_only=is_read_only,
notify_list=notify_list,
template_variables=template_variables)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
title = 'Sum of Memory Free'
widgets = [{
'definition': {
'type' => 'timeseries',
'requests' => [
{'q' => 'sum:system.mem.free{*}'}
],
'title' => 'Sum Memory Free Shell'
}
}]
layout_type = 'ordered'
description = 'An updated dashboard with memory info.'
is_read_only = true
notify_list = ['user@domain.com']
template_variables = [{
'name' => 'host1',
'prefix' => 'host',
'default' => 'my-host'
}]
dog.update_board(dashboard_id, title, widgets, layout_type, {
'description' => description,
'is_read_only' => is_read_only,
'notify_list' => notify_list,
'template_variables' => template_variables
})
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
dashboard_id="<DASHBOARD_ID>"
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"title" : "Sum of Memory Free",
"widgets" : [{
"definition": {
"type": "timeseries",
"requests": [
{"q": "sum:system.mem.free{*}"}
],
"title": "Sum Memory Free Shell"
}
}],
"layout_type": "ordered",
"description" : "An updated dashboard with memory info.",
"is_read_only": true,
"notify_list": ["user@domain.com"],
"template_variables": [{
"name": "host1",
"prefix": "host",
"default": "my-host"
}]
}' \
"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}"
EXAMPLE RESPONSE:
{
'notify_list':[
'user@domain.com'
],
'description':'An updated dashboard with memory info.',
'template_variables':[
{
'default':'my-host',
'prefix':'host',
'name':'host1'
}
],
'is_read_only':True,
'id':'qc9-tuk-9kv',
'title':'Sum of Memory Free',
'url':'/dashboard/qc9-tuk-9kv/sum-of-memory-free',
'created_at':'2019-02-05T01:06:36.636295+00:00',
'modified_at':'2019-02-05T02:14:15.769022+00:00',
'author_handle':'user@domain.com',
'widgets':[
{
'definition':{
'requests':[
{
'q':'sum:system.mem.free{*}'
}
],
'type':'timeseries',
'title':'Sum Memory Free Shell'
},
'id':6744688099018785
}
],
'layout_type':'ordered'
}
[
"200",
{
"notify_list" => ["user@domain.com"],
"description" => nil,
"template_variables" => nil,
"is_read_only" => false,
"id" => "qc9-tuk-9kv",
"title" => "Sum of Memory Free",
"url" => "/dashboard/qc9-tuk-9kv/sum-of-memory-free",
"created_at" => "2019-02-05T01:06:36.636295+00:00",
"modified_at" => "2019-02-05T02:19:06.792555+00:00",
"author_handle" => "user@domain.com",
"widgets" => [
{
"definition" => {
"requests" => [
{
"q" => "sum:system.mem.free{*}"
}
],
"type" => "timeseries",
"title" => "Sum Memory Free Shell"
},
"id" => 7763291144447019
}
],
"layout_type" => "ordered"
}
]
{
"notify_list": ["user@domain.com"],
"description": "An updated dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Sum of Memory Free",
"url": "/dashboard/qc9-tuk-9kv/sum-of-memory-free",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T02:08:57.399410+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "sum:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Sum Memory Free Shell"
},
"id": 6979333833881176
}
],
"layout_type": "ordered"
}
既存のダッシュボードを削除します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/dashboard/<DASHBOARD_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.delete(dashboard_id)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.delete_board(dashboard_id)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
dashboard_id="<DASHBOARD_ID>"
curl -X DELETE \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}"
EXAMPLE RESPONSE:
{
'deleted_dashboard_id': 'qc9-tuk-9kv'
}
["200", {"deleted_dashboard_id" => "qc9-tuk-9kv"}]
{
"deleted_dashboard_id": "qc9-tuk-9kv"
}
既存のダッシュボードの定義を取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/dashboard/<DASHBOARD_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
dashboard_id = '<DASHBOARD_ID>'
api.Dashboard.get(dashboard_id)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dashboard_id = '<DASHBOARD_ID>'
dog.get_board(dashboard_id)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
dashboard_id="<DASHBOARD_ID>"
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/dashboard/${dashboard_id}"
EXAMPLE RESPONSE:
{
'notify_list':[
'user@domain.com'
],
'description':'A dashboard with memory info.',
'template_variables':[
{
'default':'my-host',
'prefix':'host',
'name':'host1'
}
],
'is_read_only':True,
'id':'qc9-tuk-9kv',
'title':'Average Memory Free Shell',
'url':'/dashboard/qc9-tuk-9kv/average-memory-free-shell',
'created_at':'2019-02-05T01:20:56.323548+00:00',
'modified_at':'2019-02-05T01:20:56.323548+00:00',
'author_handle':'user@domain.com',
'widgets':[
{
'definition':{
'requests':[
{
'q':'avg:system.mem.free{*}'
}
],
'type':'timeseries',
'title':'Average Memory Free'
},
'id':2252428653625902
}
],
'layout_type':'ordered'
}
{
"notify_list": [
"user@domain.com"
],
"description": "A dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Average Memory Free Shell",
"url": "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T01:06:36.636295+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "avg:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Average Memory Free"
},
"id": 2252428653625902
}
],
"layout_type": "ordered"
}
{
"notify_list": [
"user@domain.com"
],
"description": "A dashboard with memory info.",
"template_variables": [
{
"default": "my-host",
"prefix": "host",
"name": "host1"
}
],
"is_read_only": true,
"id": "qc9-tuk-9kv",
"title": "Average Memory Free Shell",
"url": "/dashboard/qc9-tuk-9kv/average-memory-free-shell",
"created_at": "2019-02-05T01:06:36.636295+00:00",
"modified_at": "2019-02-05T01:06:36.636295+00:00",
"author_handle": "user@domain.com",
"widgets": [
{
"definition": {
"requests": [
{
"q": "avg:system.mem.free{*}"
}
],
"type": "timeseries",
"title": "Average Memory Free"
},
"id": 2252428653625902
}
],
"layout_type": "ordered"
}
すべてのダッシュボードを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/dashboard
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Dashboard.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_all_boards()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/dashboard"
EXAMPLE RESPONSE:
{
'dashboards': [{
'created_at': '2019-02-28T17:12:59.327729+00:00',
'is_read_only': False,
'description': 'My Screenboard Description',
'title': 'My Screenboard',
'url': '/dashboard/grh-zkj-h2c/my-screenboard',
'layout_type': 'free',
'modified_at': '2019-03-13T19:09:40.930616+00:00',
'author_handle':'user@domain.com',
'id': 'grh-zkj-h2c'
},
{
'created_at': '2019-02-28T17:45:11.535045+00:00',
'is_read_only': False,
'description': 'My Timeboard Description',
'title': 'My Timeboard',
'url': '/dashboard/4qf-77b-uhc/my-timeboard',
'layout_type': 'ordered',
'modified_at': '2019-03-11T14:22:03.131495+00:00',
'author_handle':'user@domain.com',
'id': '4qf-77b-uhc'
}
]
}
{
"dashboards": [{
"created_at" => "2019-02-28T17:12:59.327729+00:00",
"is_read_only" => false,
"description" => "My Screenboard Description",
"title" => "My Screenboard",
"url" => "/dashboard/grh-zkj-h2c/my-screenboard",
"layout_type" => "free",
"modified_at" => "2019-03-13T19:09:40.930616+00:00",
"author_handle": "user@domain.com",
"id" => "grh-zkj-h2c"
}, {
"created_at" => "2019-02-28T17:45:11.535045+00:00",
"is_read_only" => false,
"description" => "My Timeboard Description",
"title" => "My Timeboard",
"url" => "/dashboard/4qf-77b-uhc/my-timeboard",
"layout_type" => "ordered",
"modified_at" => "2019-03-11T14:22:03.131495+00:00",
"author_handle": "user@domain.com",
"id" => "4qf-77b-uhc"
}]
}
{
"dashboards": [{
"created_at": "2019-02-28T17:12:59.327729+00:00",
"is_read_only": false,
"description": "My Screenboard Description",
"title": "My Screenboard",
"url": "/dashboard/grh-zkj-h2c/my-screenboard",
"layout_type": "free",
"modified_at": "2019-03-13T19:09:40.930616+00:00",
"author_handle": "user@domain.com",
"id": "grh-zkj-h2c"
},
{
"created_at": "2019-02-28T17:45:11.535045+00:00",
"is_read_only": false,
"description": "My Timeboard Description",
"title": "My Timeboard",
"url": "/dashboard/4qf-77b-uhc/my-timeboard",
"layout_type": "ordered",
"modified_at": "2019-03-11T14:22:03.131495+00:00",
"author_handle": "user@domain.com",
"id": "4qf-77b-uhc"
}
]
}
APIを介してすべてのダッシュボードを簡単に整理、検索、およびチームや組織と共有できます。
既存のダッシュボードリストの定義を取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/dashboard/lists/manual/<LIST_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.get(4741)require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_dashboard_list(4741)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}"
EXAMPLE RESPONSE:
{
'name': 'My Dashboard List',
'created': '2018-03-16T09:44:41.476018+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T09:44:41.476030+00:00',
'is_favorite': False,
'dashboard_count': 0,
'type': 'manual_dashboard_list',
'id': 4741
}[
"200",
{
"is_favorite" => false,
"name" => "My Dashboard List",
"dashboard_count" => 0,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2018-03-16T09:44:41.476018+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T09:44:41.476030+00:00",
"id" => 4741
}
]{
"name": "My Dashboard List",
"created": "2018-03-16T09:44:41.476018+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T09:44:41.476030+00:00",
"is_favorite": False,
"dashboard_count": 0,
"type": "manual_dashboard_list",
"id": 4741
}Fetch all of your existing dashboard list definitions.
ARGUMENTS:
This endpoint takes no JSON arguments.
SIGNATURE:
GET /v1/dashboard/lists/manual
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.get_all()require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.get_all_dashboard_lists()api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual"
EXAMPLE RESPONSE:
{
'dashboard_lists': [
{
'name': 'My Dashboard List B',
'created': '2017-09-14T14:59:59.040891+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T13:03:52.698416+00:00',
'is_favorite': True,
'dashboard_count': 22,
'type': 'manual_dashboard_list',
'id': 142
},
{
'name': 'My Dashboard List A',
'created': '2017-11-17T11:17:43.273931+00:00',
'author': {
'handle': 'test2@datadoghq.com',
'name': 'Other Author Name'
},
'dashboards': None,
'modified': '2018-03-16T13:03:43.835281+00:00',
'is_favorite': False,
'dashboard_count': 12,
'type': 'manual_dashboard_list',
'id': 295
}
]
}[
"200",
{
"dashboard_lists" => [
{
"is_favorite" => true,
"name" => "My Dashboard List B",
"dashboard_count" => 22,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2017-09-14T14:59:59.040891+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T13:03:52.698416+00:00",
"id" => 142
},
{
"is_favorite" => false,
"name" => "My Dashboard List A",
"dashboard_count" => 12,
"author" => {
"handle" => "test2@datadoghq.com",
"name" => "Other Author Name"
},
"created" => "2017-11-17T11:17:43.273931+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T13:03:43.835281+00:00",
"id" => 295
}
]
}
]{
"dashboard_lists": [
{
"name": "My Dashboard List B",
"created": "2017-09-14T14:59:59.040891+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T13:03:52.698416+00:00",
"is_favorite": True,
"dashboard_count": 22,
"type": "manual_dashboard_list",
"id": 142
},
{
"name": "My Dashboard List A",
"created": "2017-11-17T11:17:43.273931+00:00",
"author": {
"handle": "test2@datadoghq.com",
"name": "Other Author Name"
},
"dashboards": None,
"modified": "2018-03-16T13:03:43.835281+00:00",
"is_favorite": False,
"dashboard_count": 12,
"type": "manual_dashboard_list",
"id": 295
}
]
}Create an empty dashboard list.
ARGUMENTS:
name [required]:
The name of the dashboard list.SIGNATURE:
POST /v1/dashboard/lists/manual
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
name = 'My Dashboard List'
api.DashboardList.create(name=name)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
name = 'My Dashboard List'
result = dog.create_dashboard_list(name)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name": "My Dashboard List"
}' \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual"
EXAMPLE RESPONSE:
{
'name': 'My Dashboard List',
'created': '2018-03-16T09:44:41.476018+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T09:44:41.476030+00:00',
'is_favorite': False,
'dashboard_count': 0,
'type': 'manual_dashboard_list',
'id': 4741
}[
"200",
{
"is_favorite" => false,
"name" => "My Dashboard List",
"dashboard_count" => 0,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2018-03-16T09:51:47.905261+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T09:51:47.905273+00:00",
"id" => 4741
}
]{
"name": "My Dashboard List",
"created": "2018-03-16T09:44:41.476018+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T09:44:41.476030+00:00",
"is_favorite": False,
"dashboard_count": 0,
"type": "manual_dashboard_list",
"id": 4741
}Update the name of a dashboard list
ARGUMENTS:
name [required]:
The name of the dashboard list.SIGNATURE:
PUT /v1/dashboard/lists/manual/<LIST_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
name = 'My Updated Dashboard List'
api.DashboardList.update(list_id, name=name)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
name = 'My Updated Dashboard List'
result = dog.update_dashboard_list(list_id, name)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name": "My Updated Dashboard List"
}' \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}"
EXAMPLE RESPONSE:
{
'name': 'My Updated Dashboard List',
'created': '2018-03-16T09:44:41.476018+00:00',
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'dashboards': None,
'modified': '2018-03-16T13:45:42.288026+00:00',
'is_favorite': False,
'dashboard_count': 5,
'type': 'manual_dashboard_list',
'id': 4741
}[
"200",
{
"is_favorite" => false,
"name" => "My Updated Dashboard List",
"dashboard_count" => 5,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"created" => "2018-03-16T09:44:41.476018+00:00",
"type" => "manual_dashboard_list",
"dashboards" => nil,
"modified" => "2018-03-16T13:45:42.288026+00:00",
"id" => 4741
}
]{
"name": "My Updated Dashboard List",
"created": "2018-03-16T09:44:41.476018+00:00",
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"dashboards": None,
"modified": "2018-03-16T13:45:42.288026+00:00",
"is_favorite": False,
"dashboard_count": 5,
"type": "manual_dashboard_list",
"id": 4741
}Delete an existing dashboard list.
ARGUMENTS:
This endpoint takes no JSON arguments.
SIGNATURE:
DELETE /v1/dashboard/lists/manual/<LIST_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.delete(4741)require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.delete_dashboard_list(4741)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X DELETE \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/dashboard/lists/manual/${list_id}"
EXAMPLE RESPONSE:
{
'deleted_dashboard_list_id': 4741
}[
"200",
{
"deleted_dashboard_list_id" => 4741
}
]{
"deleted_dashboard_list_id": 4741
}Fetch the dashboard list’s dashboard definitions.
ARGUMENTS:
This endpoint takes no JSON arguments.
SIGNATURE:
GET /v2/dashboard/lists/manual/<LIST_ID>/dashboards
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.DashboardList.v2.get_items(4741)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
result = dog.v2.get_items_of_dashboard_list(4741)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards"
EXAMPLE RESPONSE:
{
'total': 5,
'dashboards': [
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': None,
'name': None
},
'url': '/screen/integration/87/aws-dynamodb',
'title': 'AWS DynamoDB',
'modified': None,
'created': None,
'is_favorite': True,
'is_read_only': True,
'type': 'integration_screenboard',
'id': '87',
'icon': '/static/v/34.254868/images/saas_logos/small/amazon_dynamodb.png'
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': None,
'name': None
},
'url': '/dash/integration/23/postgres---metrics',
'title': 'Postgres - Metrics',
'modified': None,
'created': None,
'is_favorite': True,
'is_read_only': True,
'type': 'integration_timeboard',
'id': '23',
'icon': '/static/v/34.254868/images/saas_logos/small/postgres.png'
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': 'test1@datadoghq.com',
'name': 'Author Name'
},
'url': '/dashboard/qts-q2k-yq6/trace-api',
'title': 'Trace API',
'modified': '2018-03-16T13:39:39.517133+00:00',
'created': '2015-10-21T13:22:48.633391+00:00',
'is_favorite': False,
'is_read_only': False,
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6',
'icon': None
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': 'test2@datadoghq.com',
'name': 'Other Author Name'
},
'url': '/dashboard/rys-xwq-geh/agent-stats',
'title': 'Agent Stats',
'modified': '2018-03-16T12:54:25.968134+00:00',
'created': '2014-06-18T18:19:00.974763+00:00',
'is_favorite': False,
'is_read_only': False,
'type': 'custom_screenboard',
'id': 'rys-xwq-geh',
'icon': None
},
{
'popularity': 0,
'is_shared': False,
'author': {
'handle': None,
'name': None
},
'url': '/dash/host/3245468',
'title': 'agent-gui',
'modified': None,
'created': None,
'is_favorite': False,
'is_read_only': True,
'type': 'host_timeboard',
'id': '3245468',
'icon': None
}
]
}
[
"200",
{
"total" => 5,
"dashboards" => [
{
"popularity" => 0,
"title" => "AWS DynamoDB",
"is_favorite" => true,
"id" => "87",
"icon" => "/static/v/34.254868/images/saas_logos/small/amazon_dynamodb.png",
"is_shared" => false,
"author" => {
"handle" => nil,
"name" => nil
},
"url" => "/screen/integration/87/aws-dynamodb",
"created" => nil,
"modified" => nil,
"is_read_only" => true,
"type" => "integration_screenboard"
},
{
"popularity" => 0,
"title" => "Postgres - Metrics",
"is_favorite" => true,
"id" => "23",
"icon" => "/static/v/34.254868/images/saas_logos/small/postgres.png",
"is_shared" => false,
"author" => {
"handle" => nil,
"name" => nil
},
"url" => "/dash/integration/23/postgres---metrics",
"created" => nil,
"modified" => nil,
"is_read_only" => true,
"type" => "integration_timeboard"
},
{
"popularity" => 0,
"title" => "Trace API",
"is_favorite" => false,
"id" => "qts-q2k-yq6",
"icon" => nil,
"is_shared" => false,
"author" => {
"handle" => "test1@datadoghq.com",
"name" => "Author Name"
},
"url" => "/dashboard/qts-q2k-yq6/trace-api",
"created" => "2015-10-21T13:22:48.633391+00:00",
"modified" => "2018-03-16T13:39:39.517133+00:00",
"is_read_only" => false,
"type" => "custom_timeboard"
},
{
"popularity" => 0,
"title" => "Agent Stats",
"is_favorite" => false,
"id" => "rys-xwq-geh",
"icon" => nil,
"is_shared" => false,
"author" => {
"handle" => "test2@datadoghq.com",
"name" => "Other Author Name"
},
"url" => "/dashboard/rys-xwq-geh/agent-stats",
"created" => "2014-06-18T18:19:00.974763+00:00",
"modified" => "2018-03-16T12:54:25.968134+00:00",
"is_read_only" => false,
"type" => "custom_screenboard"
},
{
"popularity" => 0,
"title" => "agent-gui",
"is_favorite" => false,
"id" => "3245468",
"icon" => nil,
"is_shared" => false,
"author" => {
"handle" => nil,
"name" => nil
},
"url" => "/dash/host/3245468",
"created" => nil,
"modified" => nil,
"is_read_only" => true,
"type" => "host_timeboard"
}
]
}
]
{
"total": 5,
"dashboards": [
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": None,
"name": None
},
"url": "/screen/integration/87/aws-dynamodb",
"title": "AWS DynamoDB",
"modified": None,
"created": None,
"is_favorite": True,
"is_read_only": True,
"type": "integration_screenboard",
"id": "87",
"icon": "/static/v/34.254868/images/saas_logos/small/amazon_dynamodb.png"
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": None,
"name": None
},
"url": "/dash/integration/23/postgres---metrics",
"title": "Postgres - Metrics",
"modified": None,
"created": None,
"is_favorite": True,
"is_read_only": True,
"type": "integration_timeboard",
"id": "23",
"icon": "/static/v/34.254868/images/saas_logos/small/postgres.png"
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": "test1@datadoghq.com",
"name": "Author Name"
},
"url": "/dashboard/qts-q2k-yq6/trace-api",
"title": "Trace API",
"modified": "2018-03-16T13:39:39.517133+00:00",
"created": "2015-10-21T13:22:48.633391+00:00",
"is_favorite": False,
"is_read_only": False,
"type": "custom_timeboard",
"id": "qts-q2k-yq6",
"icon": None
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": "test2@datadoghq.com",
"name": "Other Author Name"
},
"url": "/dashboard/rys-xwq-geh/agent-stats",
"title": "Agent Stats",
"modified": "2018-03-16T12:54:25.968134+00:00",
"created": "2014-06-18T18:19:00.974763+00:00",
"is_favorite": False,
"is_read_only": False,
"type": "custom_screenboard",
"id": "rys-xwq-geh",
"icon": None
},
{
"popularity": 0,
"is_shared": False,
"author": {
"handle": None,
"name": None
},
"url": "/dash/host/3245468",
"title": "agent-gui",
"modified": None,
"created": None,
"is_favorite": False,
"is_read_only": True,
"type": "host_timeboard",
"id": "3245468",
"icon": None
}
]
}
既存のダッシュボードリストにダッシュボードを追加します。
dashboards [必須]:
リストに追加するダッシュボードのリスト。
ダッシュボードの定義は、次の形式に従います。
type [必須]:
ダッシュボードのタイプ。
以下のいずれかでなければなりません。
"custom_timeboard""custom_screenboard""integration_screenboard""integration_timeboard""host_timeboard"id [必須]:
ダッシュボードの ID。
SIGNATURE:
POST /v2/dashboard/lists/manual/<LIST_ID>/dashboards
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
dashboards = [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
api.DashboardList.v2.add_items(list_id, dashboards=dashboards)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
dashboards = [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
result = dog.v2.add_items_to_dashboard_list(list_id, dashboards)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"dashboards": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}' \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards"
EXAMPLE RESPONSE:
{
'added_dashboards_to_list': [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
}
[
"200",
{
"added_dashboards_to_list" => [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
}
]
{
"added_dashboards_to_list": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}
Update dashboards of an existing dashboard list.
ARGUMENTS:
dashboards [required]:
The new list of dashboards for the dashboard list.
Dashboard definitions follow this form:
type [required]:
The type of the dashboard.
The type must be one of:
"custom_timeboard""custom_screenboard""integration_screenboard""integration_timeboard""host_timeboard"id [required]:
The id of the dashboard.
SIGNATURE:
PUT /v2/dashboard/lists/manual/<LIST_ID>/dashboards
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
dashboards = [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
api.DashboardList.v2.update_items(list_id, dashboards=dashboards)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
dashboards = [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
result = dog.v2.update_items_of_dashboard_list(list_id, dashboards)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"dashboards": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}' \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards"
EXAMPLE RESPONSE:
{
'dashboards': [
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
}
[
"200",
{
"dashboards" => [
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
}
]
{
"dashboards": [
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}
Delete dashboards from an existing dashboard list.
ARGUMENTS:
dashboards [required]:
A list of dashboards to remove from the list.
Dashboard definitions follow this form:
type [required]:
The type of the dashboard.
The type must be one of:
"custom_timeboard""custom_screenboard""integration_screenboard""integration_timeboard""host_timeboard"id [required]:
The id of the dashboard.
SIGNATURE:
DELETE /v2/dashboard/lists/manual/<LIST_ID>/dashboards
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
list_id = 4741
dashboards = [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
api.DashboardList.v2.delete_items(list_id, dashboards=dashboards)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
list_id = 4741
dashboards = [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
result = dog.v2.delete_items_from_dashboard_list(list_id, dashboards)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
list_id=4741
curl -X DELETE \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"dashboards": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}' \
"https://api.datadoghq.com/api/v2/dashboard/lists/manual/${list_id}/dashboards"
EXAMPLE RESPONSE:
{
'deleted_dashboards_from_list': [
{
'type': 'custom_screenboard',
'id': 'rys-xwq-geh'
},
{
'type': 'custom_timeboard',
'id': 'qts-q2k-yq6'
},
{
'type': 'integration_screenboard',
'id': '87'
},
{
'type': 'integration_timeboard',
'id': '23'
},
{
'type': 'host_timeboard',
'id': '3245468'
}
]
}
[
"200",
{
"deleted_dashboards_from_list" => [
{
"type" => "custom_screenboard",
"id" => "rys-xwq-geh"
},
{
"type" => "custom_timeboard",
"id" => "qts-q2k-yq6"
},
{
"type" => "integration_screenboard",
"id" => "87"
},
{
"type" => "integration_timeboard",
"id" => "23"
},
{
"type" => "host_timeboard",
"id" => "3245468"
}
]
}
]
{
"deleted_dashboards_from_list": [
{
"type": "custom_screenboard",
"id": "rys-xwq-geh"
},
{
"type": "custom_timeboard",
"id": "qts-q2k-yq6"
},
{
"type": "integration_screenboard",
"id": "87"
},
{
"type": "integration_timeboard",
"id": "23"
},
{
"type": "host_timeboard",
"id": "3245468"
}
]
}
ダウンタイム設定を使用すると、アラートからいくつかのスコープをグローバルに除外することができ、モニター通知をより詳細に制御できます。ダウンタイム設定は、開始時間と終了時間を指定してスケジューリングされ、指定された Datadog タグに関連するすべてのアラートの発生を抑止します。
scope [必須]:
ダウンタイムが適用されるスコープ (例: host:app2)。複数のスコープは、カンマ区切りリストで指定します (例: env:dev,env:prod)。設定されるダウンタイムは、指定されたスコープのいずれかではなく、すべて (env:dev と env:prod の両方) と一致するソースに適用されます。monitor_tags [オプション、デフォルト = モニタータグフィルターなし]:
モニタータグのカンマ区切りリスト。これは、(scope パラメーターで絞り込まれる) モニタークエリで使用されるタグではなく、ダウンタイムが適用されるモニターに直接適用されるタグです。設定されるダウンタイムは、指定されたモニタータグのいずれかではなく、すべて (service:postgres と team:frontend の両方) と一致するモニターに適用されます。monitor_id [オプション、デフォルト = None]:
ダウンタイムが適用される単一のモニター。指定しない場合、ダウンタイムはすべてのモニターに適用されます。start [オプション、デフォルト = None]:
ダウンタイムを開始する時間の POSIX タイムスタンプ。指定しない場合、ダウンタイムは作成されるとすぐに開始します。end [オプション、デフォルト = None]:
ダウンタイムを終了する時間の POSIX タイムスタンプ。指定しない場合、ダウンタイムは (取り消されるまで) 無期限に有効になります。message [オプション、デフォルト = None]:
このダウンタイムの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。timezone [オプション、デフォルト = UTC]:
ダウンタイムのタイムゾーン。recurrence [オプション、デフォルト = None]:
さまざまなパラメーターを使用してダウンタイムの繰り返しを定義するオブジェクト。type: 繰り返しのタイプ。days、weeks、months、years から選択します。period: 繰り返す頻度を整数で指定します。たとえば、3 日ごとに繰り返す場合、type は days、period は 3 を指定します。week_days: (オプション) 繰り返す曜日のリスト。Mon、Tue、Wed、Thu、Fri、Sat、Sun から選択します。type が weeks の場合にのみ適用されます。最初の文字は大文字にする必要があります。until_occurrences: (オプション) ダウンタイムを再スケジューリングする回数。until_occurences と until_date は相互に排他的です。until_date: (オプション) 繰り返しが終了する日付を指定する POSIX タイムスタンプ。until_occurences と until_date は相互に排他的です。SIGNATURE:
POST /v1/downtime
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Repeat for 3 hours (starting now) on every week day for 4 weeks.
start_ts = int(time.time())
end_ts = start_ts + (3 * 60 * 60)
end_reccurrence_ts = start_ts + (4 * 7 * 24 * 60 * 60) # 4 weeks from now
recurrence = {
'type': 'weeks',
'period': 1,
'week_days': ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
'until_date': end_reccurrence_ts
}
# Schedule downtime
api.Downtime.create(
scope='env:staging',
start=start_ts,
end=end_ts,
recurrence=recurrence
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Repeat for 3 hours(starting now) on every week day for 4 weeks.
start_ts = Time.now.to_i
end_ts = start_ts + (3 * 60 * 60)
end_reccurrence_ts = start_ts + (4 * 7 * 24 * 60 * 60)# 4 weeks from now
recurrence = {
'type' => 'weeks',
'period' => 1,
'week_days' => ['Mon', 'Tue', 'Wed', 'Thu', 'Fri'],
'until_date' => end_reccurrence_ts
}
# Schedule downtime
dog.schedule_downtime('env:testing', :start => start_ts, :end => end_ts, :recurrence => recurrence)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
start=$(date +%s)
end=$(date -v+3H +%s)
end_recurrence=$(date -v+21d +%s)
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"scope": "env:prod",
"start": '"${start}"',
"end": '"${end}"',
"recurrence": {
"type": "weeks",
"period": 1,
"week_days": ["Mon", "Tue", "Wed", "Thu", "Fri"],
"until_date": '"${end_recurrence}"'
}
}' \
"https://api.datadoghq.com/api/v1/downtime"
EXAMPLE RESPONSE:
{
'active': True,
'canceled': None,
'creator_id': 3658,
'disabled': False,
'end': 1445978817,
'id': 169267576,
'message': None,
'monitor_id': None,
'monitor_tags': ['*'],
'parent_id': None,
'recurrence': {
'period': 1,
'type': 'weeks',
'until_date': 1448387217,
'until_occurrences': None,
'week_days': [
'Mon',
'Tue',
'Wed',
'Thu',
'Fri'
]
},
'scope': ['env:staging'],
'start': 1445968017,
'updater_id': None
}
[
"200", {
"disabled" => false,
"canceled" => nil,
"active" => true,
"message" => nil,
"id" => 169267581,
"end" => 1445978819,
"parent_id" => nil,
"monitor_id" => nil,
"monitor_tags": ["*"],
"recurrence" => {
"until_date" => 1448387219,
"until_occurrences" => nil,
"week_days" => ["Mon", "Tue", "Wed", "Thu", "Fri"],
"type" => "weeks",
"period" => 1
},
"start" => 1445968019,
"creator_id" => 3658,
"scope" => ["env:testing"],
"updater_id" => nil
}
]
{
"active": true,
"canceled": null,
"creator_id": 3658,
"disabled": false,
"end": 1445979093,
"id": 169267786,
"message": null,
"monitor_id": null,
"monitor_tags": ["*"],
"parent_id": null,
"recurrence": {
"period": 1,
"type": "weeks",
"until_date": 1447786293,
"until_occurrences": null,
"week_days": [
"Mon",
"Tue",
"Wed",
"Thu",
"Fri"
]
},
"scope": [
"env:prod"
],
"start": 1445968293,
"updater_id": null
}
id [必須]:
更新するダウンタイムの整数 IDscope [必須]:
ダウンタイムが適用されるスコープ (例: ‘host:app2’)。複数のスコープは、カンマ区切りリストで指定します (例: ‘env:dev,env:prod’)。設定されるダウンタイムは、指定されたスコープのいずれかではなく、すべて (env:dev と env:prod の両方) と一致するソースに適用されます。monitor_tags [オプション、デフォルト = モニタータグフィルターなし]:
モニタータグのカンマ区切りリスト。これは、(scope パラメーターで絞り込まれる) モニタークエリで使用されるタグではなく、ダウンタイムが適用されるモニターに直接適用されるタグです。設定されるダウンタイムは、指定されたモニタータグのいずれかではなく、すべて (service:postgres と team:frontend の両方) と一致するモニターに適用されます。monitor_id [オプション、デフォルト = None]:
ダウンタイムが適用される単一のモニター。指定しない場合、ダウンタイムはすべてのモニターに適用されます。start [オプション、default = 元の start]:
ダウンタイムを開始する時間の POSIX タイムスタンプ。end [オプション、default = 元の end]:
ダウンタイムを終了する時間の POSIX タイムスタンプ。指定しない場合、ダウンタイムは (取り消されるまで) 無期限に有効になります。message [必須、デフォルト = 元の message]:
このダウンタイムの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。timezone [オプション、デフォルト = 元の timezone ]:
ダウンタイムのタイムゾーン。recurrence [オプション、default = 元の recurrence]:
さまざまなパラメーターを使用してダウンタイムの繰り返しを定義するオブジェクト。type: 繰り返しのタイプ。days、weeks、months、years から選択します。period: 繰り返す頻度を整数で指定します。たとえば、3 日ごとに繰り返す場合、type は days、period は 3 を指定します。week_days: (オプション) 繰り返す曜日のリスト。Mon、Tue、Wed、Thu、Fri、Sat、Sun から選択します。type が weeks の場合にのみ適用されます。最初の文字は大文字にする必要があります。until_occurrences: (オプション) ダウンタイムを再スケジューリングする回数。until_occurences と until_date は相互に排他的です。until_date: (オプション) 繰り返しが終了する日付を指定する POSIX タイムスタンプ。until_occurences と until_date は相互に排他的です。SIGNATURE:
PUT /v1/downtime/<DOWNTIME_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get an existing downtime
stagingDowntimes = []
downtimes = api.Downtime.get_all()
for item in downtimes:
if item['scope'] == ['env:staging']:
stagingDowntimes.append(item)
# Update that downtime
api.Downtime.update(
stagingDowntimes[0]['id'],
scope='env:staging',
end=int(time.time()) + 60000,
message="Doing some testing on staging."
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Update downtime
stagingDowntimes = []
downtimes = dog.get_all_downtimes()
downtimes[1].each do |item |
print item['scope']
if item['scope'] == ['env:staging']
stagingDowntimes.push item
end
end
dog.update_downtime(stagingDowntimes[0]['id'], :scope => 'env:testing', :end => Time.now.to_i + 60000, :message => "Doing some testing on staging.")api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
downtime_id=4336
# Create a downtime to update
currenttime=$(date +%s)
downtime_id=$(curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d "{
\"scope\": \"env:prod\",
\"start\": \"${currenttime}\"
}" \
"https://api.datadoghq.com/api/v1/downtime}" | jq '.id')
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"scope": "env:staging",
"message": "Doing some testing on staging"
}' \
"https://api.datadoghq.com/api/v1/downtime/${downtime_id}"
EXAMPLE RESPONSE:
{
'active': True,
'disabled': False,
'end': 1420447087,
'id': 2910,
'message': 'Doing some testing on staging.',
'monitor_tags': ['*'],
'scope': ['env:staging'],
'start': 1420387032
}
[
"200", {
"end" => 1418303372,
"disabled" => false,
"start" => 1418224729,
"active" => true,
"monitor_tags": ["*"],
"scope" => ["env:testing"],
"message" => "Doing some testing on staging.",
"id" => 4336
}
]
{
"active": true,
"disabled": false,
"end": 1418303372,
"id": 4336,
"message": "Doing some testing on staging",
"monitor_tags": ["*"],
"scope": [
"env:staging"
],
"start": 1418224729
}
id [必須]:SIGNATURE:
DELETE /v1/downtime/<DOWNTIME_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Cancel downtime
api.Downtime.delete(1654)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.cancel_downtime(1655)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
downtime_id=1656
# Create a downtime to delete
currenttime=$(date +%s)
downtime_id=$(curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d "{
\"scope\": \"env:prod\",
\"start\": \"${currenttime}\"
}" \
"https://api.datadoghq.com/api/v1/downtime" | jq '.id')
curl -X DELETE \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/downtime/${downtime_id}"
EXAMPLE RESPONSE:
This endpoint does not return JSON on successful requests.
このエンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
scope [必須]:
指定されたスコープを持つすべてのダウンタイムを取り消します。次に例を示します。
SIGNATURE:
POST /v1/downtime/cancel/by_scope
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/bash
api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
curl -X POST \
-H "Content-type: application/json" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d "{
\"scope\": \"host:i-123\"
}" \
"https://api.datadoghq.com/api/v1/downtime/cancel/by_scope"
EXAMPLE RESPONSE:
#
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
#
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example {
"cancelled_ids":[123456789,123456790]
}このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/downtime/<DOWNTIME_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get a downtime
api.Downtime.get(2910)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
puts dog.get_downtime(<DOWNTIME_ID>)
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
downtime_id=2473
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/downtime/${downtime_id}"
EXAMPLE RESPONSE:
{'active': True,
'disabled': False,
'end': 1420447087,
'id': 2910,
'message': 'Doing some testing on staging.',
'monitor_tags': ['*'],
'scope': ['env:staging'],
'start': 1420387032
}
{
"end" => 1412793983,
"disabled" => true,
"start" => 1412792983,
"active" => false,
"monitor_tags" => ["*"],
"scope" => ["env:staging"],
"id" => 1625
}
{
"active": True,
"disabled": False,
"end": 1420447087,
"id": 2910,
"message": "Doing some testing on staging.",
"monitor_tags": ["*"],
"scope": ["env:staging"],
"start": 1420387032
}
current_only [オプション、デフォルト = False]:SIGNATURE:
GET /v1/downtime
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get all downtimes
print api.Downtime.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get all downtimes
dog.get_all_downtimes()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/downtime"
EXAMPLE RESPONSE:
[
{
'active': False,
'disabled': True,
'end': 1412793983,
'id': 1625,
'monitor_tags': ['*'],
'scope': ['env:staging'],
'start': 1412792983
},
{
'active': False,
'disabled': True,
'end': None,
'id': 1626,
'monitor_tags': ['*'],
'scope': ['*'],
'start': 1412792985
}
]
[
"200", [{
"end" => 1412793983,
"disabled" => true,
"start" => 1412792983,
"active" => false,
"monitor_tags" => ["*"],
"scope" => ["env:staging"],
"id" => 1625
}, {
"end" => nil,
"disabled" => true,
"start" => 1412792985,
"active" => false,
"monitor_tags" => ["*"],
"scope" => ["*"],
"id" => 1626
}]
]
[
{
"active": false,
"disabled": true,
"end": 1412793983,
"id": 1625,
"monitor_tags": ["*"],
"scope": [
"env:staging"
],
"start": 1412792983
},
{
"active": false,
"disabled": true,
"end": null,
"id": 1626,
"monitor_tags": ["*"],
"scope": [
"*"
],
"start": 1412792985
}
]
API を使用して埋め込み可能なグラフを操作します。
これまでに作成された埋め込み可能なグラフのリストを取得します。
戻り値: これまでに UI および API から作成された Embed に関する情報を含む JSON リスト。各 JSON グラフ応答は、GET api/v1/graph/embed/
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/graph/embed
EXAMPLE REQUEST:
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Call Embed API function
api.Embed.get_all()
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get all with API Call
dog.get_all_embeds()api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/graph/embed"
EXAMPLE RESPONSE:
{
"embedded_graphs": [
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title": "Embed created through API",
"revoked": False,
"dash_url": None,
"shared_by": 3658,
"dash_name": None
}
]
}
{
"embedded_graphs" => [{
"embed_id" => "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables" => [],
"html" => '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title" => "Embed created through API",
"revoked" => false,
"dash_url" => nil,
"shared_by" => 3658,
"dash_name" => nil
}]
}{ "embedded_graphs": [
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>",
"graph_title": "Embed created through API",
"revoked": false,
"dash_url": null,
"shared_by": 3658,
"dash_name": null
}
]
}
埋め込み可能なグラフを新しく作成します。
戻り値: GET api/v1/graph/embed/
注: 指定されたオーガニゼーションにまったく同じクエリに対応する Embed が既に存在する場合、新しい Embed は作成されず、古い Embed が返されます。
テンプレート変数の使用に関心がある方は、テンプレート変数を使用した埋め込み可能なグラフを参照してください。
graph_json [必須]:timeframe [オプション、デフォルト = 1_hour]:size [オプション、デフォルト = medium]:legend [オプション、デフォルト = no]:title [オプション、デフォルト = Embed created through API]:SIGNATURE:
POST /v1/graph/embed
EXAMPLE REQUEST:
from datadog import initialize, api
import json
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Create an embed graph definition as a dict and format as JSON
graph_json = {
"requests": [{
"q": "avg:system.load.1{*}"
}],
"viz": "timeseries",
"events": []
}
graph_json = json.dumps(graph_json)
api.Embed.create(
graph_json=graph_json,
timeframe="1_hour",
size="medium",
legend="no"
)
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Prepare parameters
graph_json = '{
"requests": [{
"q": "avg:system.load.1{*}"
}],
"viz": "timeseries",
"events": []
}
'
timeframe = "1_hour"
size = "medium"
legend = "no"
title = "Embed created through API"
# Create parameter hash
description = {:timeframe => timeframe, :size => size, :legend => legend, :title => title
}
# Make API Call
status, result = dog.create_embed(graph_json, description)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
curl -X POST \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d 'graph_json={"requests":[{"q":"avg:system.load.1{*}"}],"viz":"timeseries","events":[]}' \
-d "timeframe=1_hour" \
-d "size=medium" \
-d "legend=yes" \
"https://api.datadoghq.com/api/v1/graph/embed"
EXAMPLE RESPONSE:
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title": "Embed created through API",
"revoked": False,
"dash_url": None,
"shared_by": 3658,
"dash_name": None
}
{
"embed_id" => "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables" => [],
"html" => '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title" => "Embed created through API",
"revoked" => false,
"dash_url" => nil,
"shared_by" => 3658,
"dash_name" => nil
}{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>",
"graph_title": "Embed created through API",
"revoked": false,
"dash_url": null,
"shared_by": 3658,
"dash_name": null
}
embed_id を指定して、以前に作成した Embed の HTML フラグメントを取得します。
戻り値: 以下の 8 つの要素を持つ JSON オブジェクト。
失敗すると、戻り値はエラーメッセージ {errors: [messages]} を含む JSON になります。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/graph/embed/<EMBED_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Set Embed ID (token)
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Call Embed API function
api.Embed.get(embed_id, legend="no", size="medium", timeframe="1_hour")
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Initialize Embed Token / ID
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Get embed with API Call
dog.enable_embed(embed_id)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
embed_id="5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/graph/embed/${embed_id}"
EXAMPLE RESPONSE:
{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title": "Embed created through API",
"revoked": False,
"dash_url": None,
"shared_by": 3658,
"dash_name": None
}
{
"embed_id" => "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables" => [],
"html" => '<iframe src="https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true" width="600" height="300" frameBorder="0"></iframe>',
"graph_title" => "Embed created through API",
"revoked" => false,
"dash_url" => nil,
"shared_by" => 3658,
"dash_name" => nil
}{
"embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c",
"template_variables": [],
"html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>",
"graph_title": "Embed created through API",
"revoked": false,
"dash_url": null,
"shared_by": 3658,
"dash_name": null
}
特定の Embed を有効にします。
戻り値: 成功メッセージ {success: [message]} を含む JSON。失敗すると、戻り値はエラーメッセージ {errors: [messages]} を含む JSON になります。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/graph/embed/<EMBED_ID>/enable
EXAMPLE REQUEST:
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Set Embed ID (token)
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Call Embed API function
api.Embed.enable(embed_id)
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Initialize Embed Token / ID
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Enable with API Call
dog.enable_embed(embed_id)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
embed_id="5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/graph/embed/${embed_id}/enable"
EXAMPLE RESPONSE:
{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully enabled."
}
{
"success" => "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully enabled."
}{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully enabled."
}
特定の Embed を無効にします。
戻り値: 成功メッセージ {success: [message]} を含む JSON。失敗すると、戻り値は、エラーメッセージ {errors: [messages]} を含む JSON になります。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/graph/embed/<EMBED_ID>/revoke
EXAMPLE REQUEST:
from datadog import initialize, api
# Intialize request parameters including API/APP key
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Set Embed ID (token)
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Call Embed API function
api.Embed.revoke(embed_id)
require 'rubygems'
require 'dogapi'
# Initialize API Client
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Initialize Embed Token / ID
embed_id = "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
# Revoke with API Call
dog.revoke_embed(embed_id)api_key="<YOUR_API_KEY>"
app_key="<YOUR_APP_KEY>"
embed_id="5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c"
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/graph/embed/${embed_id}/revoke"
EXAMPLE RESPONSE:
{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully revoked."
}
{
"success" => "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully revoked."
}{
"success": "Embed 5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c successfully revoked."
}
このエンドポイントを使用して、イベントをストリームにポストできます。イベントにタグ付けし、優先度を設定し、他のイベントと統合します。
title [必須]:
イベントのタイトル。上限は 100 文字です。
Datadog Ruby ライブラリでは、msg_title を使用してください。text [必須]:
イベントの本文。上限は 4000 文字です。
テキストはマークダウンをサポートしています。
Datadog Ruby ライブラリでは、msg_text を使用してください。date_happened [オプション、default = 現在]:
イベントの POSIX タイムスタンプ 整数として (引用符なしで) 送信する必要があります。1 年と 24 日 (389 日) 以内のイベントに制限されます。priority [オプション、デフォルト = normal]:
イベントの優先度。normal か low のいずれか。host [オプション、デフォルト = None]:
イベントに関連付けるホスト名。ホストに関連付けられているタグがあれば、それらもこのイベントに適用されます。tags [オプション、デフォルト = None]:
イベントに適用するタグのリスト。alert_type [オプション、デフォルト = info]:
アラートイベントの場合は、error、warning、info、success のいずれかのタイプを設定します。aggregation_key [オプション、デフォルト = None]:
集約に使用する任意の文字列。上限は 100 文字です。
キーを指定した場合は、そのキーを使用するすべてのイベントがイベントストリーム内でグループ化されます。source_type_name [オプション、デフォルト = None]:
ポストされるイベントのタイプ。
オプションには、nagios、hudson、jenkins、my_apps、chef、puppet、git、bitbucket などがあります。
ソース属性値のリストはこちらを参照してください。related_event_id [オプション、デフォルト = None]:
親イベントの ID。整数として (引用符なしで) 送信する必要があります。device_name [オプション、デフォルト = None]:
イベントのポストに使用するデバイス名のリスト。SIGNATURE:
POST /v1/events
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
title = "Something big happened!"
text = 'And let me tell you all about it here!'
tags = ['version:1', 'application:web']
api.Event.create(title=title, text=text, tags=tags)
# If you are programmatically adding a comment to this new event
# you might want to insert a pause of .5 - 1 second to allow the
# event to be available.
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# submitting events doesn 't require an application_key,
# so we don't bother setting it
dog = Dogapi::Client.new(api_key)
dog.emit_event(Dogapi::Event.new('msg_text', :msg_title => 'Title'))
# If you are programmatically adding a comment to this new event
# you might want to insert a pause of.5 - 1 second to allow the
# event to be available.
curl -X POST -H "Content-type: application/json" \
-d '{
"title": "Did you hear the news today?",
"text": "Oh boy!",
"priority": "normal",
"tags": ["environment:test"],
"alert_type": "info"
}' \
"https://api.datadoghq.com/api/v1/events?api_key=<YOUR_API_KEY>"
EXAMPLE RESPONSE:
{
'event':
{
'date_happened': 1419436860,
'handle': None,
'id': 2603387619536318140,
'priority': 'normal',
'related_event_id': None,
'tags': ['version:1', 'application:web'],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': 'https://app.datadoghq.com/event/jump_to?event_id=2603387619536318140'
},
'status': 'ok'
}
[
"202", {
"status" => "ok",
"event" => {
"priority" => "normal",
"date_happened" => 1346452418,
"title" => "Title",
"url" =>
"https://app.datadoghq.com/event/jump_to?event_id=1378911893708573827",
"text" => "msg_text",
"tags" => [],
"related_event_id" => nil,
"id" => 1378911893708573827
}
}
]{
"event": {
"date_happened": 1346449298,
"handle": null,
"id": 1378859526682864843,
"priority": "normal",
"related_event_id": null,
"tags": [
"environment:test"
],
"text": null,
"title": "Did you hear the news today?",
"url": "https://app.datadoghq.com/event/jump_to?event_id=1378859526682864843"
},
"status": "ok"
}このエンドポイントを使用して、イベントの詳細をクエリできます。 注: クエリ対象のイベントに何らかのマークダウン形式が含まれている場合は、出力に %、\、n などの文字が表示される場合があります。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/events/<EVENT_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Event.get(2603387619536318140)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
event_id = '1375909614428331251'
dog.get_event(event_id)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
event_id=1377281704830403917
# Create an event to get
event_id=$(curl -X POST -H "Content-type: application/json" -d "{\"title\": \"Did you hear the news today?\"}" "https://api.datadoghq.com/api/v1/events?api_key=<YOUR_API_KEY>" | jq -r '.event.url|ltrimstr("https://app.datadoghq.com/event/event?id=")')
sleep 5
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/events/${event_id}"
EXAMPLE RESPONSE:
{
'event': {
'alert_type': 'info',
'date_happened': 1419436860,
'device_name': None,
'host': None,
'id': 2603387619536318140,
'payload': '{}',
'priority': 'normal',
'resource': '/api/v1/events/2603387619536318140',
'tags': ['application:web', 'version:1'],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': '/event/jump_to?event_id=2603387619536318140'
}
}
[
"200", {
"event" => {
"date_happened" => 1346273469,
"alert_type" => "info",
"resource" => "/api/v1/events/1375909614428331251",
"title" => "Something big happened!",
"url" => "/event/jump_to?event_id=1375909614428331251",
"text" => "And let me tell you all about it here!",
"tags" => ["application:web", "version:1"],
"id" => 1375909614428331251,
"priority" => "normal",
"host" => nil,
"device_name" => nil,
"payload" => "{}"
}
}
]{
"event": {
"alert_type": "info",
"date_happened": 1346355252,
"device_name": null,
"host": null,
"id": 1377281704830403917,
"payload": "{}",
"priority": "normal",
"resource": "/api/v1/events/1377281704830403917",
"tags": [
"environment:test"
],
"text": "Oh boy!",
"title": "Did you hear the news today?",
"url": "/event/jump_to?event_id=1377281704830403917"
}
}イベントストリームをクエリして、時間、優先度、ソース、タグなどで絞り込むことができます。 注: クエリ対象のイベントに何らかのマークダウン形式が含まれている場合は、出力に %、\、n などの文字が表示される場合があります。
start [必須]:
POSIX タイムスタンプ。end [必須]:
POSIX タイムスタンプ。priority [オプション、デフォルト = None]:
イベントの優先度。low か normal のいずれか。sources [オプション、デフォルト = None]:
ソースのカンマ区切り文字列。tags [オプション、デフォルト = None]:
タグのカンマ区切り文字列。負のタグフィルターを使用する場合は、タグの先頭に - を付けます。
詳細は、イベントストリームのドキュメントを参照してください。unaggregated [オプション、デフォルト = false]:
unaggregated を true に設定すると、指定された [start,end] タイムフレーム内のすべてのイベントが返されます。そうでない場合、タイムフレーム外のタイムスタンプを持つ親イベントに集約されたイベントは、出力に含まれません。SIGNATURE:
GET /v1/events
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
end_time = time.time()
start_time = end_time - 100
api.Event.query(
start=start_time,
end=end_time,
priority="normal",
tags=["-env:dev,application:web"],
unaggregated=True
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
end_time = Time.now.to_i
start_time = end_time - 100
dog.stream(start_time, end_time, :priority => "normal", :tags => ["-env:dev,application:web"], :unaggregated => true)# Note: this endpoint only accepts form-encoded requests.
currenttime=$(date +%s)
currenttime2=$(date --date='1 day ago' +%s)
curl -X GET \
-H "Content-type: application/json" \
-H "DD-API-KEY: $api_key" \
-H "DD-APPLICATION-KEY: $app_key" \
"https://api.datadoghq.com/api/v1/events?&start=${currenttime2}&end=${currenttime}&tags=check_type:api&sources=alert&unaggregated=true"
EXAMPLE RESPONSE:
{
'events': [
{
'alert_type': 'info',
'comments': [],
'date_happened': 1346273496,
'device_name': null,
'host': null,
'id': 1375910067732769979,
'is_aggregate': false,
'priority': 'normal',
'resource': '/api/v1/events/1375910067732769979',
'source': 'My Apps',
'tags': [
'application:web',
'version:1'
],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': '/event/jump_to?event_id=1375910067732769979'
},
{
'alert_type': 'info',
'comments': [],
'date_happened': 1346273469,
'device_name': null,
'host': null,
'id': 1375909614428331251,
'is_aggregate': false,
'priority': 'normal',
'resource': '/api/v1/events/1375909614428331251',
'source': 'My Apps',
'tags': [
'application:web',
'version:1'
],
'text': 'And let me tell you all about it here!',
'title': 'Something big happened!',
'url': '/event/jump_to?event_id=1375909614428331251'
}
]
}
["200", {
"events" => [{
"events" => [{
"alert_type" => "info",
"comments" => [],
"date_happened" => 1346273496,
"device_name" => null,
"host" => null,
"id" => 1375910067732769979,
"is_aggregate" => false,
"priority" => "normal",
"resource" => "/api/v1/events/1375910067732769979",
"source" => "My Apps",
"tags" => [
"application:web",
"version:1"
],
"text" => "And let me tell you all about it here!",
"title" => "Something big happened!",
"url" => "/event/jump_to?event_id=1375910067732769979"
}, {
"alert_type" => "info",
"comments" => [],
"date_happened" => 1346273469,
"device_name" => null,
"host" => null,
"id" => 1375909614428331251,
"is_aggregate" => false,
"priority" => "normal",
"resource" => "/api/v1/events/1375909614428331251",
"source" => "My Apps",
"tags" => [
"application:web",
"version:1"
],
"text" => "And let me tell you all about it here!",
"title" => "Something big happened!",
"url" => "/event/jump_to?event_id=1375909614428331251"
}]
}]
}]{
"events": [
{
"alert_type": "info",
"comments": [],
"date_happened": 1346273496,
"device_name": null,
"host": null,
"id": 1375910067732769979,
"is_aggregate": false,
"priority": "normal",
"resource": "/api/v1/events/1375910067732769979",
"source": "My Apps",
"tags": [
"application:web",
"version:1"
],
"text": "And let me tell you all about it here!",
"title": "Something big happened!",
"url": "/event/jump_to?event_id=1375910067732769979"
},
{
"alert_type": "info",
"comments": [],
"date_happened": 1346273469,
"device_name": null,
"host": null,
"id": 1375909614428331251,
"is_aggregate": false,
"priority": "normal",
"resource": "/api/v1/events/1375909614428331251",
"source": "My Apps",
"tags": [
"application:web",
"version:1"
],
"text": "And let me tell you all about it here!",
"title": "Something big happened!",
"url": "/event/jump_to?event_id=1375909614428331251"
}
]
}APIを使って graph のスナップショットを撮る
注: スナップショットは、作成されてから利用できるようになるまで、若干の遅延があります。
metric_query [必須]:
メトリクスクエリ。start [必須]:
クエリを開始する時間の POSIX タイムスタンプ。end [必須]:
クエリを終了する時間の POSIX タイムスタンプ。event_query [オプション、デフォルト = None]:
グラフにイベントバンドを追加するためのクエリ。graph_def [オプション、デフォルト = None]:
グラフを定義する JSON ドキュメント。metric_query の代わりに graph_def を使用できます。この JSON ドキュメントは、こちらで定義されている文法を使用し、単一行の書式にしてから URL エンコードする必要があります。title [オプション、デフォルト = None]:
グラフのタイトル。タイトルを指定しない場合、グラフにタイトルは付きません。SIGNATURE:
GET /v1/graph/snapshot
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Take a graph snapshot
end = int(time.time())
start = end - (60 * 60)
api.Graph.create(
graph_def='{\
"viz": "timeseries", \
"requests": [ \
{"q": "avg:system.load.1{*}", "conditional_formats": [], "type": "line"},\
{"q": "avg:system.load.5{*}", "type": "line"}, \
{"q": "avg:system.load.15{*}", "type": "line"}\
], \
"events": [\
{"q": "hosts:* ", "tags_execution": "and"}\
]}',
start=start,
end=end
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
end_ts = Time.now().to_i
start_ts = end_ts - (60 * 60)
dog.graph_snapshot("system.load.1{*}", start_ts, end_ts)#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
currenttime=$(date +%s)
currenttime2=$(date -v -1d +%s)
curl -X GET \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/graph/snapshot?metric_query=system.load.1\{*\}&start=${currenttime2}&end=${currenttime}"
EXAMPLE RESPONSE:
{
'graph_def': {"viz": "timeseries", "requests": [{"q": "avg:system.load.1{*}", "conditional_formats": [], "type": "line"}, {"q": "avg:system.load.5{*}", "type": "line"}, {"q": "avg:system.load.15{*}", "type": "line"}], "events": [{"q": "hosts:* ", "tags_execution": "and"}]}',
'metric_query': 'system.load.1{*}',
'snapshot_url': 'https://s3.amazonaws.com/dd-snapshots-prod/org_1499/2013-07-19/2459d291fc021c84f66aac3a87251b6c92b589da.png'
}
["200", {
"metric_query" => "system.load.1{*}",
"snapshot_url" =>
"https://s3.amazonaws.com/dd-snapshots-prod/org_1499/2013-07-19/7f6dd29198ce0872a6fdfab33f534ef8d64a23ea.png"
}]{
"metric_query": "system.load.1{*}",
"snapshot_url": "https://s3.amazonaws.com/dd-snapshots-prod/org_1499/2013-07-19/53fd79f024e7796f4ca399f1d90adf3cf95a9bb8.png"
}
This endpoint allows searching for hosts by name, alias, or tag. Hosts live within the past 3 hours are included. Results are paginated with a max of 100 results at a time.
ARGUMENTS:
filter [optional, default=None]:
Query string to filter search results.sort_field [optional, default=cpu]:
Sort hosts by the given field.
Options: status, apps, cpu, iowait, loadsort_dir [optional, default=desc]:
Direction of sort.
Options: asc, descstart [optional, default=0]:
Host result to start search from.count [optional, default=100]:
Number of host results to return. Max 100.from [optional, default=now - 2 hours]:
Number of seconds since UNIX epoch from which you want to search your hosts.SIGNATURE:
GET /v1/hosts
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Hosts.search()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.search_hosts()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/hosts"
EXAMPLE RESPONSE:
{
'total_returned': 1,
'host_list': [
{
'name': 'i-deadbeef',
'up': True,
'is_muted': False,
"last_reported_time": 1560000000,
'apps': [
'agent'
],
'tags_by_source': {
'Datadog': [
'host:i-deadbeef'
],
'Amazon Web Services': [
'account:staging'
]
},
'aws_name': 'mycoolhost-1',
'metrics': {
'load': 0.5,
'iowait': 3.2,
'cpu': 99.0
},
'sources': [
'aws',
'agent'
],
'meta': {
'nixV': [
'Ubuntu',
'14.04',
'trusty'
]
},
'host_name': 'i-deadbeef',
'id': 123456,
'aliases': [
'mycoolhost-1'
]
}
],
'total_matching': 1
}
["200", {
"total_returned": 1,
"host_list": [
{
"name": "i-deadbeef",
"up": true,
"is_muted": false,
"last_reported_time": 1560000000,
"apps": [
"agent"
],
"tags_by_source": {
"Datadog": [
"host:i-deadbeef"
],
"Amazon Web Services": [
"account:staging"
]
},
"aws_name": "mycoolhost-1",
"metrics": {
"load": 0.5,
"iowait": 3.2,
"cpu": 99.0
},
"sources": [
"aws",
"agent"
],
"meta": {
"nixV": [
"Ubuntu",
"14.04",
"trusty"
]
},
"host_name": "i-deadbeef",
"id": 123456,
"aliases": [
"mycoolhost-1"
]
}
],
"total_matching": 1
}]
{
"total_returned": 1,
"host_list": [
{
"name": "i-deadbeef",
"up": true,
'is_muted': true,
'mute_timeout': 1560010000,
"last_reported_time": 1560000000,
"apps": [
"agent"
],
"tags_by_source": {
"Datadog": [
"host:i-deadbeef"
],
"Amazon Web Services": [
"account:staging"
]
},
"aws_name": "mycoolhost-1",
"metrics": {
"load": 0.5,
"iowait": 3.2,
"cpu": 99.0
},
"sources": [
"aws",
"agent"
],
"meta": {
"nixV": [
"Ubuntu",
"14.04",
"trusty"
]
},
"host_name": "i-deadbeef",
"id": 123456,
"aliases": [
"mycoolhost-1"
]
}
],
"total_matching": 1
}
This endpoint returns the total number of active and up hosts in your Datadog account. Active means the host has reported in the past hour, and up means it has reported in the past two hours.
ARGUMENTS:
from [optional, default=now - 2 hours]:
Number of seconds since UNIX epoch from which you want to get the total number of active and up hosts.SIGNATURE:
GET /v1/hosts/totals
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
api.Hosts.totals()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.host_totals()
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/hosts/totals"
EXAMPLE RESPONSE:
{'total_up':1750,'total_active':1759}
["200", {"total_up":1750,"total_active":1759}]
{"total_up":1750,"total_active":1759}
end [オプション、デフォルト = None]:
ホストがミュート解除される時間の POSIX タイムスタンプ。省略した場合、ホストは、明示的にミュート解除されるまでミュートされたままになります。message [オプション、デフォルト = None]:
このホストのミュートに関連付けるメッセージ。override [オプション、デフォルト = False]:
true にした場合、ホストが既にミュートされていると、既存のホストミュート設定が置き換えられます。SIGNATURE:
POST /v1/host/<HOSTNAME>/mute
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Find a host to mute
hosts = api.Hosts.search(q='hosts:')
# Mute a host
api.Host.mute(hosts['results']['hosts'][0])
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
hostname = "test.host"
message = "Muting this host for a test."
end_ts = Time.now.to_i + 60 * 60
dog.mute_host(hostname, :message => message, :end => end_ts)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"message": "Muting this host for a test!"
}' \
"https://api.datadoghq.com/api/v1/host/test.host/mute"
EXAMPLE RESPONSE:
{
'action': 'Muted',
'hostname': 'test.host'
}
["200", {
"action"=>"Muted",
"message"=>"Muting this host for a test.",
"hostname"=>"test.host",
"end"=>1433345249
}]{
"action": "Muted",
"hostname": "test.host",
"message": "Muting this host for a test!"
}
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
POST /v1/host/<HOSTNAME>/unmute
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Find a host to unmute
hosts = api.Hosts.search(q='hosts:')
# Unmute host
api.Host.unmute(hosts['results']['hosts'][0])
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
hostname = "test.host"
dog.unmute_host(hostname)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json"
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/host/test.host/unmute"
EXAMPLE RESPONSE:
{
'action': 'Unmuted',
'hostname': 'test.host'
}
["200", {
"action" => "Unmuted",
"hostname" => "test.host"
}]{
"action": "Unmuted",
"hostname": "test.host"
}AWS エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-AWS インテグレーションの構成は、Datadog API から直接行います。 詳細については、[AWS インテグレーションのページ][7]を参照してください。
Datadog Organization で使用できるすべての Datadog-AWS インテグレーションをリストします。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/aws
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_integration('aws')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# List AWS Accounts (role-based only) in Datadog
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/aws"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"accounts" => [{
"errors" => [],
"account_id" => "<AWS_ACCOUNT_ID>",
"host_tags" => ["<KEY>:<VALUE>"],
"account_specific_namespace_rules" => {},
"role_name" => "DatadogAWSIntegrationRole",
"filter_tags" => ["<KEY>:<VALUE>"]
}]
}
{"accounts":
[{
"account_id": '112233445566',
"role_name": "SomeDatadogRole",
"filter_tags": ["filter123"],
"host_tags": ["account":"demo"],
"account_specific_namespace_rules": {"opsworks":false}
}]
}
Datadog-Amazon Web Services インテグレーションを作成します。
注: POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
access_key_id [オプション、デフォルト = None]:
AWS アカウントが GovCloud または China アカウントの場合に、対応するアクセスキー ID を入力します。
role_name [必須]:
Datadog ロールの委任名。 AWS アカウントのロール名の詳細については、Datadog AWS インテグレーション構成情報を参照してください。
filter_tags [オプション、デフォルト = None]:
この EC2 タグ (key:value 形式) の配列は、EC2 からメトリクスを収集する際に Datadog が使用するフィルターを定義します。? (1 文字) や * (複数文字) などのワイルドカードも使用できます。
定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。それ以外は無視されます。タグの前に ! を追加することで、指定されたタグに一致するホストを除外することもできます。
例: env:production,instance-type:c1.*,!region:us-east-1
EC2 のタグ付けの詳細については、AWS のタグ付けに関するドキュメントを参照してください。
host_tags [オプション、デフォルト = None]:
このインテグレーションを介して報告しているすべてのホストおよびメトリクスに追加されるタグ (key:value 形式) の配列。
account_specific_namespace_rules [オプション、デフォルト = None]:
この AWS アカウントでのみ特定の AWS ネームスペースに対してメトリクスの収集を有効または無効にするためのオブジェクト ({"namespace1":true/false, "namespace2":true/false} 形式)。ネームスペースのリストは、/v1/integration/aws/available_namespace_rules エンドポイントから取得できます。
SIGNATURE:
POST /v1/integration/aws
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
config = {
"account_id": "<AWS_ACCOUNT_ID>",
"filter_tags": ["<KEY>:<VALUE>"],
"host_tags": ["<KEY>:<VALUE>"],
"role_name": "DatadogAWSIntegrationRole",
"account_specific_namespace_rules": {"auto_scaling": false, "opsworks": false}
}
dog.create_integration('aws',config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Create an AWS Account in Datadog
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"filter_tags": ["<KEY>:<VALUE>"],
"host_tags": ["<KEY>:<VALUE>"],
"role_name": "DatadogAWSIntegrationRole",
"account_specific_namespace_rules": {
"auto_scaling": false,
"opsworks": false
}
}'\
"https://api.datadoghq.com/api/v1/integration/aws"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"external_id"=> "12345678910111213"
}
{
"external_id": "12345678910111213"
}
Update a Datadog-Amazon Web Services integration.
Note: Using the PUT method updates your integration configuration by replacing your current configuration with the new one sent to your Datadog organization.
ARGUMENTS:
account_id [required]:
Your AWS Account ID without dashes. It needs to be passed as query parameter. Consult the Datadog AWS integration to learn more about your AWS account ID.
role_name [required]:
Your Datadog role delegation name. It needs to be passed as query parameter. For more information about your AWS account Role name, see the Datadog AWS integration configuration info.
access_key_id [optional, default=None]:
If your AWS account is a GovCloud or China account, enter the corresponding Access Key ID.
filter_tags [optional, default=None]:
The array of EC2 tags (in the form key:value) defines a filter that Datadog uses when collecting metrics from EC2. Wildcards, such as ? (for single characters) and * (for multiple characters) can also be used.
Only hosts that match one of the defined tags are imported into Datadog. The rest are ignored. Host matching a given tag can also be excluded by adding ! before the tag.
e.x. env:production,instance-type:c1.*,!region:us-east-1
For more information on EC2 tagging, see the AWS tagging documentation.
host_tags [optional, default=None]:
Array of tags (in the form key:value) to add to all hosts and metrics reporting through this integration.
account_specific_namespace_rules [optional, default=None]:
An object (in the form {"namespace1":true/false, "namespace2":true/false}) that enables or disables metric collection for specific AWS namespaces for this AWS account only. A list of namespaces can be found at the /v1/integration/aws/available_namespace_rules endpoint.
SIGNATURE:
PUT /v1/integration/aws
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Update an AWS Account in Datadog
curl -X PUT \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"filter_tags": [
"<TAG_KEY>:<TAG_VALUE>"
],
"host_tags": [
"<TAG_KEY>:<TAG_VALUE>"
],
"account_specific_namespace_rules": {
"auto_scaling": false,
"opsworks": false
}
}' \
"https://api.datadoghq.com/api/v1/integration/aws?account_id=<YOUR_AWS_ACCOUNT_ID>&role_name=<ROLE_NAME>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example{}
特定の Datadog-AWS インテグレーションを削除します。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
role_name [必須]:
Datadog ロールの委任名。 AWS アカウントのロール名の詳細については、Datadog AWS インテグレーション構成情報を参照してください。
SIGNATURE:
DELETE /v1/integration/aws
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Delete an AWS Account in Datadog
curl -X DELETE \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"role_name": "DatadogAWSIntegrationRole"
}' \
"https://api.datadoghq.com/api/v1/integration/aws"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example{}特定の Datadog-AWS インテグレーションのすべてのネームスペース規則をリストします。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/aws/available_namespace_rules
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# List available namespace rules
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/aws/available_namespace_rules"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example["api_gateway","application_elb","appsync","auto_scaling","billing","budgeting","cloudfront","cloudsearch","cloudwatch_events","cloudwatch_logs","codebuild","collect_custom_metrics","crawl_alarms","ddos_protection","directconnect","dms","documentdb","dynamodb","ebs","ec2","ec2api","ec2spot","ecs","efs","elasticache","elasticbeanstalk","elastictranscoder","elb","emr","es","firehose","gamelift","iot","kinesis","kinesis_analytics","kms","lambda","lex","ml","mq","nat_gateway","network_elb","opsworks","polly","rds","redshift","rekognition","route53","s3","sagemaker","ses","sns","sqs","state_machine","storage_gateway","swf","vpn","waf","workspaces","xray"]特定の AWS アカウント ID/ロール名ペアに対して新しい AWS 外部 ID を作成します。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
role_name [必須]:
Datadog ロールの委任名。 AWS アカウントのロール名の詳細については、Datadog AWS インテグレーション構成情報を参照してください。
SIGNATURE:
PUT /v1/integration/aws/generate_new_external_id
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H "Content-type: application/json"
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d
'{
"account_id": "<YOUR_AWS_ACCOUNT_ID>",
"role_name": "DatadogAWSIntegrationRole"
}' \
"https://dd.datadoghq.com/api/v1/integration/aws/generate_new_external_id"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Get the list of current AWS services that Datadog offers automatic log collection.
Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
ARGUMENTS:
This endpoint takes no JSON arguments.
SIGNATURE:
GET /v1/integration/aws/logs/services
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/aws/logs/services"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Datadog-AWS ログ収集のために作成された Lambda の Lambda ARN を AWS アカウント ID に追加して、ログ収集を有効にします。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
lambda_arn [必須]:
Datadog-Amazon Web サービスのログ収集セットアップ中に作成された Datadog Lambda の ARN。
SIGNATURE:
POST /v1/integration/aws/logs
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"lambda_arn": "arn:aws:lambda:us-east-1:123456789012:function:PushLogs"
}'\
"https://api.datadoghq.com/api/v1/integration/aws/logs"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}AWS サービスの自動ログ収集を有効にします。
account_id [必須]:
AWS アカウント ID (ダッシュを含まない)。 AWS アカウント ID の詳細については、Datadog AWS インテグレーションを参照してください。
services [必須]: 自動ログ収集を有効にするように設定されるサービス ID の配列。 使用可能なサービスのリストは、AWS ログ対応サービスのリストの取得 API エンドポイントから入手できます。
SIGNATURE:
POST /v1/integration/aws/logs/services
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-H "Content-type: application/json" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"services": ["elb","s3"]
}'\
"https://api.datadoghq.com/api/v1/integration/aws/logs/services"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Delete a Datadog-AWS log collection configuration by removing the specific Lambda ARN associated with a given AWS account.
ARGUMENTS:
account_id [required]:
Your AWS Account ID without dashes. Consult the Datadog AWS integration to learn more about your AWS account ID.
lambda_arn [required]:
ARN of the Datadog Lambda created during the Datadog-Amazon Web services Log collection setup.
SIGNATURE:
DELETE /v1/integration/aws/logs
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"account_id": "<AWS_ACCOUNT_ID>",
"lambda_arn": "arn:aws:lambda:us-east-1:123456789012:function:PushLogs"
}'\
"https://api.datadoghq.com/api/v1/integration/aws/logs"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}Azure エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Azure インテグレーションの構成は、Datadog API から直接行います。 詳細については、[Datadog-Azure インテグレーションのページ][7]を参照してください。
現在のオーガニゼーションに構成されているすべての Datadog-Azure インテグレーションをリストします。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/azure
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_integration('azure')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/azure"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"tenant_name" => "<AZURE_TENANT_NAME>",
"errors" => [],
"host_filters" => "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>",
"client_id" => "<AZURE_CLIENT_ID>"
}
OKDatadog-Azure インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。PUT メソッドを使用すると、現在の構成を Datadog Organization に送信された新しい構成に置き換えて、インテグレーション構成が更新されます。現在の Organization に対する以下のフィールド値を取得する方法については、Datadog-Azure インテグレーションのインストール手順を参照してください。
tenant_name [必須]:
Azure Active Directory ID
client_id [必須]:
Azure Web アプリケーション ID.
client_secret [必須]:
Azure Web アプリケーション秘密キー.
host_filters [オプション、デフォルト = None]:
タグを使用して、Datadog にプルされる Azure インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
SIGNATURE:
POST /v1/integration/azure
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}
dog = Dogapi::Client.new(api_key, app_key)
dog.create_integration('azure', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
# Create an Azure account in Datadog
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/azure"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK特定の Datadog-Azure インテグレーションを削除します。
現在の Organization に対する以下のフィールド値を取得する方法については、Datadog-Azure インテグレーションのインストール手順を参照してください。
tenant_name [必須]:
Azure Active Directory ID
client_id [必須]:
Azure Web アプリケーション ID
host_filters [オプション、デフォルト = None]:
タグを使用して、Datadog にプルされる Azure インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
SIGNATURE:
DELETE /v1/integration/azure
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>"
}' \
"https://api.datadoghq.com/api/v1/integration/azure"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl exampleOK特定の Datadog-Azure インテグレーション用に定義されたホストフィルターのリストを更新します。
現在のオーガニゼーションに対する以下のフィールド値を取得する方法については、Datadog-Azure インテグレーションのインストール手順を参照してください。
tenant_name [必須]:
Azure Active Directory ID
client_id [必須]:
Azure Web アプリケーション ID
client_secret [必須]:
Azure Web アプリケーション秘密キー
host_filters [オプション、デフォルト = None]:
タグを使用して、Datadog にプルされる Azure インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
SIGNATURE:
POST /v1/integration/azure/host_filters
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<NEW_KEY>:<NEW_VALUE>"
}
dog = Dogapi::Client.new(api_key, app_key)
dog.create_integration('azure', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"tenant_name": "<AZURE_TENANT_NAME>",
"client_id": "<AZURE_CLIENT_ID>",
"client_secret": "<AZURE_CLIENT_SECRET>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/azure/host_filters"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OKGCP エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Google Cloud Platform (GCP) インテグレーションの構成は、Datadog API から直接行います。 Datadog-Google Cloud Platform インテグレーションについては、こちらを参照してください。
現在の Organization に構成されているすべての Datadog-GCP インテグレーションをリストします。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/gcp
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_integration('gcp')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/gcp"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"automute" => false,
"project_id" => "<GCP_PROJECT_ID>",
"client_email" => "<CLIENT_EMAIL>",
"errors" => [],
"host_filters" => "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}
OKDatadog-Google Cloud Platform インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。PUT メソッドを使用すると、現在の構成を Datadog Organization に送信された新しい構成に置き換えて、インテグレーション構成が更新されます。以下のすべてのフィールドの値は、サービスアカウントの GCP コンソールで作成された JSON サービスアカウントキーファイルから提供されます。現在の Organization に対してこのファイルを作成する方法については、Datadog-Google Cloud Platform インテグレーションのインストール手順を参照してください。 詳細については、Google Cloud のサービスアカウントキーの作成と管理に関するドキュメントを参照してください。
type [必須]:
JSON サービスアカウントキーにある service_account の値。
project_id [必須]:
JSON サービスアカウントキーにある Google Cloud プロジェクト ID。
private_key_id [必須]:
JSON サービスアカウントキーにある秘密キー ID。
private_key [必須]:
JSON サービスアカウントキーにある秘密キー名。
client_email [必須]:
JSON サービスアカウントキーにある電子メール。
client_id [必須]:
JSON サービスアカウントキーにある ID。
auth_uri [必須]:
https://accounts.google.com/o/oauth2/auth。
token_uri [必須]:
https://accounts.google.com/o/oauth2/token。
auth_provider_x509_cert_url [必須]:
https://www.googleapis.com/oauth2/v1/certs。
client_x509_cert_url [必須]:
https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>。ここで、<CLIENT_EMAIL> は JSON サービスアカウントキーにある電子メールです。
host_filters [オプション]:
タグを使用して、Datadog にプルされる GCE インスタンスを制限します。定義されたタグのいずれかに一致するホストだけが Datadog にインポートされます。
automute [オプション、デフォルト = false]:
予期される GCE インスタンスのシャットダウンに対してモニターをオフにします。
SIGNATURE:
POST /v1/integration/gcp
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"type": "service_account",
"project_id": "<GCP_PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}
dog = Dogapi::Client.new(api_key, app_key)
dog.create_integration('gcp', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"type": "service_account",
"project_id": "<GCP_PROJECT_ID>",
"private_key_id": "<PRIVATE_KEY_ID>",
"private_key": "<PRIVATE_KEY>",
"client_email": "<CLIENT_EMAIL>",
"client_id": "<CLIENT_ID>",
"auth_uri": "https://accounts.google.com/o/oauth2/auth",
"token_uri": "https://accounts.google.com/o/oauth2/token",
"auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
"client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/<CLIENT_EMAIL>",
"host_filters": "<KEY_1>:<VALUE_1>,<KEY_2>:<VALUE_2>"
}' \
"https://api.datadoghq.com/api/v1/integration/gcp"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK特定の Datadog-GCP インテグレーションを削除します。
project_id [必須]:
JSON サービスアカウントキーにある Google Cloud プロジェクト ID。
client_email [必須]:
JSON サービスアカウントキーにある電子メール。
SIGNATURE:
DELETE /v1/integration/gcp
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"project_id": "<GCP_PROJECT_ID>",
"client_email": "<CLIENT_EMAIL>"
}' \
"https://api.datadoghq.com/api/v1/integration/gcp"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
OK特定の Datadog-GCP インテグレーションのオートミュートを有効または無効にします。
project_id [必須]:
JSON サービスアカウントキーにある Google Cloud プロジェクト ID。
client_email [必須]:
JSON サービスアカウントキーにある電子メール。
automute [オプション、デフォルト = false]:
予期される GCE インスタンスのシャットダウンに対してモニターをオフにします。
SIGNATURE:
PUT /v1/integration/gcp
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"project_id": "<GCP_PROJECT_ID>",
"client_email": "<CLIENT_EMAIL>",
"automute": false
}
dog = Dogapi::Client.new(api_key, app_key)
dog.update_integration('gcp', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"project_id": "<GCP_PROJECT_ID>",
"client_email": "<CLIENT_EMAIL>",
"automute": <AUTOMUTE>
}' \
"https://api.datadoghq.com/api/v1/integration/gcp"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OKPagerDuty エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-PagerDuty インテグレーションの構成は、Datadog API から直接行います。 詳細については、[PagerDuty インテグレーションのページ][7]を参照してください。
Datadog-PagerDuty インテグレーションのすべての情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/pagerduty
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_integration('pagerduty')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/pagerduty"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"services" => [{
"service_name" => "<SERVICE_NAME_1>",
"service_key" => "*****"
}, {
"service_name" => "<SERVICE_NAME_2>",
"service_key" => "*****"
}], "schedules" => ["<SCHEDULE_1>", "<SCHEDULE_2>"],
"subdomain" => "<PAGERDUTY_SUB_DOMAIN>",
"api_token" => "*****"
}
OK新しい Datadog-PagerDuty インテグレーションを作成します。
注: 新しい PagerDuty 構成を作成 (PUT) する際は、すべての引数が必要です。
services :
PagerDuty サービスオブジェクトの配列。Datadog サービスの構成方法については、PagerDuty のドキュメントを参照してください。PagerDuty サービスオブジェクトは、以下の要素で構成されます。
service_name [必須]:
PagerDuty でのサービス名。
service_key [必須]:
Pagerduty でのサービス名に関連付けられたサービスキー。
subdomain :
PagerDuty アカウントのパーソナライズされたサブドメイン名。
schedules :
スケジュール URL の配列。例:
["https://my-pd.pagerduty.com/schedules#PCPYT4M", "https://my-pd.pagerduty.com/schedules#PKTPB7P"]
api_token :
PagerDuty API トークン。
SIGNATURE:
PUT /v1/integration/pagerduty
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"services": [
{
"service_name": "<SERVICE_NAME_1>",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
},
{
"service_name": "<SERVICE_NAME_2>",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
}
],
"subdomain": "<PAGERDUTY_SUB_DOMAIN>",
"schedules": ["<SCHEDULE_1>", "<SCHEDULE_2>"],
"api_token": "<PAGERDUTY_TOKEN>"
}
dog = Dogapi::Client.new(api_key, app_key)
dog.create_integration('pagerduty', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"services": [
{
"service_name": "<SERVICE_NAME_1>",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
},
{
"service_name": "<SERVICE_NAME_2>",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
}
],
"subdomain": "<PAGERDUTY_SUB_DOMAIN>",
"schedules": ["<SCHEDULE_1>", "<SCHEDULE_2>"],
"api_token": "<PAGERDUTY_TOKEN>"
}' \
"https://api.datadoghq.com/api/v1/integration/pagerduty"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OKDatadog-PagerDuty インテグレーションに新しいサービスとスケジュールを追加します。
services :
PagerDuty サービスオブジェクトの配列。Datadog サービスの構成方法については、PagerDuty のドキュメントを参照してください。PagerDuty サービスオブジェクトは、以下の要素で構成されます。
service_name [必須]:
PagerDuty でのサービス名。
service_key [必須]:
Pagerduty でのサービス名に関連付けられたサービスキー。
schedules :
スケジュール URL の配列:
["https://my-pd.pagerduty.com/schedules#PCPYT4M", "https://my-pd.pagerduty.com/schedules#PKTPB7P"]
SIGNATURE:
POST /v1/integration/pagerduty
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"services": [
{
"service_name": "test_00",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
},
{
"service_name": "test_01",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
}
],
"schedules": ["<SCHEDULE_1>", "<SCHEDULE_2>"],
}
dog = Dogapi::Client.new(api_key, app_key)
dog.update_integration('pagerduty', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"services": [
{
"service_name": "test_00",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
},
{
"service_name": "test_01",
"service_key": "<PAGERDUTY_SERVICE_KEY>"
}
],
"schedules": ["<SCHEDULE_1>", "<SCHEDULE_2>"],
}' \
"https://api.datadoghq.com/api/v1/integration/pagerduty"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OKDatadog-PagerDuty インテグレーションを削除します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/integration/pagerduty
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.delete_integration('pagerduty')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X DELETE \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/pagerduty"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OKSlack エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Slack インテグレーションの構成は、Datadog API から直接行います。 Datadog-Slack インテグレーションの詳細については、インテグレーションページを参照してください。
Datadog-Slack インテグレーションのすべての情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/slack
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_integration('slack')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/slack"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"channels" => [], "service_hooks" => [{
"url" => "*****",
"account" => "Main_Account"
}, {
"url" => "*****",
"account" => "doghouse"
}]
}
OK
Datadog-Slack インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。PUT メソッドを使用すると、現在の構成を Datadog Organization に送信された新しい構成に置き換えて、インテグレーション構成が更新されます。service_hooks [必須]:
サービスフックオブジェクトの配列 (Slack アカウントのサービスフックは Slack アカウント管理ページで生成されます)。サービスフックオブジェクトは、以下の要素で構成されます。
account [必須]:
Slack アカウント名。
url [必須]:
Slack サービスフックの URL。
注: 既存の Slack 構成に追加 (POST) または更新 (PUT) する際に、ペイロードに service_hooks は必要ありません。
SIGNATURE:
POST /v1/integration/slack
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"service_hooks": [
{
"account": "Main_Account",
"url": "https://hooks.slack.com/services/1/1/1"
},
{
"account": "doghouse",
"url": "https://hooks.slack.com/services/2/2/2"
}
]
}
dog = Dogapi::Client.new(api_key, app_key)
dog.create_integration('slack', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"service_hooks": [
{
"account": "Main_Account",
"url": "https://hooks.slack.com/services/1/1/1"
},
{
"account": "doghouse",
"url": "https://hooks.slack.com/services/2/2/2"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/slack"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK
Add channels to your Datadog-Slack integration.
ARGUMENTS:
channels [required]:
The array of slack channel objects to post to. A slack channel object is composed by:
channel_name [required]:
Your channel name e.g: #general, #private
transfer_all_user_comments [optional, default=False]:
To be notified for every comment on a graph, set it to true. If set to False use the @slack-channel_name syntax for comments to be posted to slack.
account [required]:
Account to which the channel belongs to.
SIGNATURE:
POST /v1/integration/slack
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"channels": [
{
"channel_name": "#channel_name_main_account",
"transfer_all_user_comments": "false",
"account": "Main_Account"
},
{
"channel_name": "#channel_name_doghouse",
"transfer_all_user_comments": "false",
"account": "doghouse"
}
]
}
dog = Dogapi::Client.new(api_key, app_key)
dog.update_integration('slack', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"channels": [
{
"channel_name": "#channel_name_main_account",
"transfer_all_user_comments": "false",
"account": "Main_Account"
},
{
"channel_name": "#channel_name_doghouse",
"transfer_all_user_comments": "false",
"account": "doghouse"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/slack"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK
Delete a Datadog-Slack integration.
ARGUMENTS:
This endpoint takes no JSON arguments.
SIGNATURE:
DELETE /v1/integration/slack
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.delete_integration('slack')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X DELETE \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/slack"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK
Webhooks エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Datadog-Webhooks インテグレーションの構成は、Datadog API から直接行います。 Datadog-Webhooks インテグレーションの詳細については、インテグレーションページを参照してください。
Datadog-Webhooks インテグレーションのすべての情報を取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/integration/webhooks
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.get_integration('webhooks')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/webhooks"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{
"hooks" => [{
"custom_payload" => "",
"name" => "Example",
"url" => "http://example.com",
"encode_as_form" => "false",
"headers" => "",
"use_custom_payload" => "false"
}]
}
OKDatadog-Webhooks インテグレーションを作成します。
注:
POST メソッドを使用すると、Datadog Organization の既存の構成に新しい構成を追加して、インテグレーション構成が更新されます。hooks [必須]:
Webhook オブジェクトの配列。Webhook オブジェクトは、以下の要素で構成されます。
name [必須]:
Webhook 名。
モニター通知で使用する方法については、こちらを参照してください。url [必須]:
Webhook の URL。use_custom_payload [オプション、デフォルト = False]:
true の場合は、Webhook にカスタムペイロードを指定することができます。
custom_payload [オプション、デフォルト = None]:
use_custom_payload が true の場合は、独自のペイロードを指定し、これらの変数を使用してリクエストに独自のカスタムフィールドを追加します。
encode_as_form [オプション、デフォルト = False]:
use_custom_payload が true の場合に、これを true に設定すると、ペイロードが URL エンコードされます。
headers [オプション、デフォルト = None]:
Webhook にアタッチされるヘッダー。
SIGNATURE:
POST /v1/integration/webhooks
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"hooks": [
{
"name": "Example",
"url": "http://example.com"
}
]
}
dog = Dogapi::Client.new(api_key, app_key)
dog.create_integration('webhooks', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"hooks": [
{
"name": "<WEBHOOK_NAME>",
"url": "<WEBHOOK_URL>"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/webhooks"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK特定の Webhook を Datadog Webhooks インテグレーションに追加します。
hooks [必須]:
Webhook オブジェクトの配列。Webhook オブジェクトは、以下の要素で構成されます。
name [必須]:
Webhook 名。
モニター通知で使用する方法については、こちらを参照してください。url [必須]:
Webhook の URL。use_custom_payload [オプション、デフォルト = False]:
true の場合は、Webhook にカスタムペイロードを指定することができます。
custom_payload [オプション、デフォルト = None]:
use_custom_payload が true の場合は、独自のペイロードを指定し、これらの変数を使用してリクエストに独自のカスタムフィールドを追加します。
encode_as_form [オプション、デフォルト = False]:
use_custom_payload が true の場合に、これを true に設定すると、ペイロードが URL エンコードされます。
headers [オプション、デフォルト = None]:
Webhook にアタッチされるヘッダー。
SIGNATURE:
POST /v1/integration/webhooks
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
config= {
"hooks": [
{
"name": "Example",
"url": "http://example.com/2"
}
]
}
dog = Dogapi::Client.new(api_key, app_key)
dog.update_integration('webhooks', config)
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"hooks": [
{
"name": "<WEBHOOK_NAME>",
"url": "<WEBHOOK_URL>"
}
]
}' \
"https://api.datadoghq.com/api/v1/integration/webhooks"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OK特定の Datadog-Webhooks インテグレーションを削除します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/integration/webhooks
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.delete_integration('webhooks')
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -v -X DELETE \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/integration/webhooks"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
{}
OKKey Management エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
DatadogのAPIとアプリケーションキーを管理
このエンドポイントを使用するには、API キーおよびアプリケーションキーと共に管理者権限が必要です。
すべてのキーのリストは Datadog API ページで参照できます。
現在のアカウントで利用できるすべての API キーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/api_key/
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://app.datadoghq.com/api/v1/api_key"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_keys": [
{
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "1111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:20:30"
},
{
"created_by": "jane@example.com",
"name": "<APP_KEY_NAME_2>",
"key": "2111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:19:53"
}
]
}
特定の API キーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/api_key/<API_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://app.datadoghq.com/api/v1/api_key/<API_KEY_TO_GET>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
名前を指定して API キーを作成します。
name [必須]:
API キーの名前。
SIGNATURE:
POST /v1/api_key/<API_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name": "<API_KEY_NAME>"
}' \
"https://app.datadoghq.com/api/v1/api_key"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
API キーの名前を編集します。
name [必須]:
API キーの名前。
SIGNATURE:
PUT /v1/api_key/<API_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name":"<NEW_API_KEY_NAME>"
}' \
"https://app.datadoghq.com/api/v1/api_key/<API_KEY_TO_EDIT>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
特定の API キーを削除します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/api_key/<API_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
-H 'Content-Type: application/json'
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://app.datadoghq.com/api/v1/api_key/<API_KEY_TO_DELETE>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"api_key": {
"created_by": "john@example.com",
"name": "<API_KEY_NAME>",
"key": "3111111111111111aaaaaaaaaaaaaaaa",
"created": "2019-04-05 09:47:00"
}
}
現在のアカウントで利用できるすべてのアプリケーションキーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/application_key/
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://app.datadoghq.com/api/v1/application_key"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_keys": [
{
"owner": "john@example.com",
"hash": "11111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
},
{
"owner": "jane@example.com",
"hash": "21111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME_2>"
}
]
}
特定のアプリケーションキーを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/application_key/<APP_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://app.datadoghq.com/api/v1/application_key/<APP_KEY_TO_GET>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
}
}
名前を指定してアプリケーションキーを作成します。
name [必須]:
アプリケーションキーの名前。
SIGNATURE:
POST /v1/application_key/<APP_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name": "<APP_KEY_NAME>"
}' \
"https://app.datadoghq.com/api/v1/application_key"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
}
}
アプリケーションキーの名前を編集します。
name [必須]:
アプリケーションキーの名前。
SIGNATURE:
PUT /v1/application_key/<APP_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name":"<NEW_APP_KEY_NAME>"
}' \
"https://app.datadoghq.com/api/v1/application_key/<APP_KEY_TO_EDIT>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<NEW_APP_KEY_NAME>"
}
}
特定のアプリケーションキーを削除します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/application_key/<APP_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X DELETE \
-H 'Content-Type: application/json'
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://app.datadoghq.com/api/v1/application_key/<APP_KEY_TO_DELETE>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"application_key": {
"owner": "john@example.com",
"hash": "31111111111111111111aaaaaaaaaaaaaaaaaaaa",
"name": "<APP_KEY_NAME>"
}
}
Logs エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
HTTP を使用して Datadog プラットフォームにログを送信します。HTTP リクエストごとの制限は以下のとおりです。
注: Datadog EU サイト (app.datadoghq.eu) の場合、HTTP ログのエンドポイントは http-intake.logs.datadoghq.eu です。
| 項目 | 説明 |
|---|---|
| プロトコル | http: 80 https: 443 |
| ホスト | Datadog US の場合: http-intake.logs.datadoghq.comDatadog EU の場合: http-intake.logs.datadoghq.eu |
| パス | /v1/input/<DATADOG_API_KEY> |
| クエリパラメーター | 使用できるクエリパラメーターは、予約済みログ属性です。?ddtags=<TAGS>&ddsource=<SOURCE>&service=<SERVICE>&hostname=<HOSTNAME> |
| メソッド | POST |
| コンテンツタイプ | 使用できるコンテンツタイプは、text/plain、application/json、application/logplex-1 です |
SIGNATURE:
https://http-intake.logs.datadoghq.com/v1/input/<DATADOG_API_KEY>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
## Simple Raw Message
## Log attributes can be passed as query parameters
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY>?ddtags=env:prod,user:my-user \
-H "Content-Type: text/plain" \
-d 'hello world'
## Multi Raw Messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: text/plain" \
--data-binary @- <<BODY
hello
world
BODY
## Simple JSON Message
## Log attributes can also be passed as key:value pairs in valid JSON messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/json" \
-d '{"message":"hello world", "ddsource":"<SOURCE>", "ddtags":"env:<ENV>,user:<USER_NAME>", "hostname":"<HOSTNAME>"}'
## Multi JSON Messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/json" \
--data-binary @- <<BODY
[
{
"message": "hello"
},
{
"message": "world"
}
]
BODY
## Simple Logplex Message
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/logplex-1" \
-d 'hello world'
## Multi Logplex Messages
curl -X POST https://http-intake.logs.datadoghq.com/v1/input/<API_KEY> \
-H "Content-Type: application/logplex-1" \
--data-binary @- <<BODY
hello
world
BODY
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}リストエンドポイントは、ログ検索クエリと一致するログを返します。結果はページ区切りされます。
オーガニゼーションのためのログのアーカイブを目的とする場合は、ログリスト API の代わりに Datadog のアーカイブ機能を使用することを検討してください。Datadog のログのアーカイブに関するドキュメントを参照してください。
query [必須]:
検索クエリ - ログ検索構文に従います。time.from [必須]:
リクエストされたログの最小タイムスタンプ。以下のいずれかの形式です。now -10m、now - 1h、now - 1d)time.to [必須]:
リクエストされたログの最大タイムスタンプ。以下のいずれかの形式です。now、now -10m、now - 1h、now - 1d)time.timezone [オプション、デフォルト = None]:
オフセット (例: 「”UTC+03:00」) または地域ゾーン (例: 「Europe/Paris」) で指定できます。time.offset [オプション、デフォルト = None]:
秒単位の値であること以外は time.timezone と同じです。
タイムゾーンとオフセットの両方が指定された場合、タイムゾーンは無視されます。startAt [オプション、デフォルト = None]:
リストで返される最初のログのハッシュ識別子 (ログの id 属性)。このパラメーターは、ページ区切り機能で使用されます。
注: 対応するログが、指定されたタイムウィンドウの範囲外の場合、このパラメーターは無視されます。sort [オプション、デフォルト = desc]:
結果が時間の古い順の場合は asc、新しい順の場合は desc。limit [オプション、デフォルト = 10]:
応答で返されるログの数 (最大 1000)。index [オプション、デフォルト = main]:
マルチインデックスのオーガニゼーションの場合に、リクエストが実行されるログインデックス。SIGNATURE:
POST api/v1/logs-queries/list
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H 'content-type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"query": "service:nginx -@http.method:POST",
"time": {
"from": "now - 1h",
"to": "now"
},
"sort": "desc",
"limit": 50
}' \
"https://api.datadoghq.com/api/v1/logs-queries/list"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
logs: [{
id: "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA",
content: {
timestamp: "2019-01-02T09:42:36.320Z",
tags: ['team:A'],
attributes: {
customAttribute: 123,
duration: 2345
},
host: 'i-123',
service: 'agent',
message: 'host connected to remote'
}
}],
nextLogId: "BBBBWgn...",
status: "ok"
}Index オブジェクトはログインデックスの構成を記述します。次の属性を持ちます。
name (読み取り専用):
インデックスの名前。filter.query :
このインデックスでは、フィルター条件に一致するログだけが考慮されます。
検索クエリはログ検索構文に従います。num_retention_days (読み取り専用):
このインデックスからログが削除されるまでの日数。daily_limit (読み取り専用):
レート制限されるまでに、このインデックスで送信できるログイベントの数。is_rate_limited (読み取り専用):
インデックスがレート制限されているかどうかを示すブール値。レート制限は、1 日の上限を超えるログが送信されたことを意味します。レート制限は毎日 UTC 午後 2 時にリセットされます。exclusion_filters
ExclusionFilter オブジェクトの配列 (以下を参照)。ログは、配列の順序に従い、各 ExclusionFilter のクエリに照らしてテストされます。最初に一致したアクティブな ExclusionFilter だけが適用され、他のフィルターは一致しても無視されます。
name :
除外フィルターの名前。is_enabled :
除外がアクティブ (最終的にログを除外する) かどうかを示すブール値。filter.query :
フィルター条件と親インデックスのクエリの両方に一致するログだけがこの除外フィルターで考慮されます。
検索クエリはログ検索構文に従います。filter.sample_rate :
この除外フィルターがアクティブな場合に除外されるログの割合。サンプリングは均一です。注: このエンドポイントを使用するには、API キーおよびアプリケーションキーと共に管理者権限が必要です。
このエンドポイントはオーガニゼーションの Index オブジェクトの配列を返します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/logs/config/indexes/
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'content-type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/indexes"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"indexes": [
{
"name": "<INDEX_NAME>",
"filter": {
"query": "<INDEX_FILTER_QUERY>"
},
"num_retention_days": 15,
"daily_limit": 150000000,
"is_rate_limited": false,
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
}
]
}
]
}
このエンドポイントは、名前で識別された Index を返します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/logs/config/indexes/<INDEX_NAME>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'content-type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/indexes/<INDEX_NAME>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"name": "<INDEX_NAME>",
"filter": {
"query": "<INDEX_FILTER_QUERY>"
},
"num_retention_days": 15,
"daily_limit": 150000000,
"is_rate_limited": false,
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
}
]
}
このエンドポイントは、名前で識別された Index を更新します。リクエストが正常に完了したときに、リクエスト本文で渡される Index オブジェクトを返します。
filter.query [オプション]:
このインデックスでは、フィルター条件に一致するログだけが考慮されます。検索クエリはログ検索構文に従います。exclusion_filters ExclusionFilter オブジェクトの配列 (以下を参照)。ログは、配列の順序に従って、各 ExclusionFilter のクエリに照らしてテストされます。最初に一致したアクティブな ExclusionFilter だけが適用され、他のフィルターは一致しても無視されます。ExclusionFilter オブジェクトは、除外フィルターの構成を記述します。次の属性を持ちます。
name [必須]:
除外フィルターの名前。is_enabled [オプション、デフォルト = False]:
除外がアクティブかどうかを示すブール値。filter.query [オプション]:
フィルター条件と親インデックスのクエリの両方に一致するログだけが、この除外フィルターで考慮されます。検索クエリはログ検索構文に従います。filter.sample_rate [必須]:
この除外フィルターがアクティブな場合に除外されるログの割合。サンプリングは均一です。SIGNATURE:
PUT /v1/logs/config/indexes/<INDEX_NAME>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H 'content-type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"filter": {
"query": "<NEW_INDEX_FILTER_QUERY>"
},
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
},
{
"name": "<INDEX_EXCLUSTION_FILTER_2>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY_2>",
"sample_rate": 1
}
}
]
}' \
"https://api.datadoghq.com/api/v1/logs/config/indexes/<INDEX_NAME>"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"name": "<INDEX_NAME>",
"filter": {
"query": "<NEW_INDEX_FILTER_QUERY>"
},
"num_retention_days": 15,
"daily_limit": 150000000,
"is_rate_limited": false,
"exclusion_filters": [
{
"name": "<INDEX_EXCLUSTION_FILTER_1>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY>",
"sample_rate": 1
}
},
{
"name": "<INDEX_EXCLUSTION_FILTER_2>",
"is_enabled": true,
"filter": {
"query": "<INDEX_EXCLUSTION_FILTER_QUERY_2>",
"sample_rate": 1
}
}
]
}
インデックス順序エンドポイントを使用して、オーガニゼーションのインデックスの処理順序を制御します。このエンドポイントは、オーガニゼーションのログに 1 つ以上のインデックスがある場合にのみ使用します。このインデックスを使用してインデックスの追加や削除を行うことはできません。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/logs/config/index-order
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H 'content-type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/index-order"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"index_names": [
"<INDEX_NAME_1>",
"<INDEX_NAME_2>"
]
}
このエンドポイントは、オーガニゼーションの IndexOrder を更新します。リクエストが正常に完了したときに、リクエスト本文で渡される IndexOrder オブジェクトを返します。
index_names [必須]: オーガニゼーションのインデックスを名前で識別する文字列の配列。ログは、配列の順序に従い、各インデックスのクエリフィルターに照らして 1 つずつテストされます。最終的に、ログは最初に一致したインデックスに保存されます。SIGNATURE:
PUT /v1/logs/config/index-order
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H 'content-type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"index_names": [
"<INDEX_NAME_2>",
"<INDEX_NAME_1>"
]
}' \
"https://api.datadoghq.com/api/v1/logs/config/index-order"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"index_names": [
"<INDEX_NAME_2>",
"<INDEX_NAME_1>"
]
}
Logs Pipelines エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
パイプラインとプロセッサーは、受信ログに対して操作を行い、ログをパースして構造化属性に変換することで、クエリを容易に行えるようにします。
注: これらのエンドポイントを使用できるのは、管理者ユーザーだけです。管理者によって作成されたアプリケーションキーを使用してください。
パイプラインの現在の順序を取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/logs/config/pipeline-order
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/pipeline-order"
EXAMPLE RESPONSE:
パイプラインの順序を更新します。
注: ログは順番に処理されます。パイプラインの順序を変更すると、他のパイプラインやそのプロセッサーによって処理されるデータの構造や内容が変化する可能性があります。
pipeline_ids [必須]:
<PIPELINE_ID> 文字列の順序付き配列。配列内のパイプライン ID の順序は、Datadog のパイプライン全体の順序を定義します。SIGNATURE:
PUT /v1/logs/config/pipeline-order
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X PUT \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"pipeline_ids": [
"<PIPELINE_1_ID>",
"<PIPELINE_2_ID>",
"<PIPELINE_3_ID>"
]
}' \
"https://api.datadoghq.com/api/v1/logs/config/pipeline-order"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"pipeline_ids": [
"<PIPELINE_1_ID>",
"<PIPELINE_2_ID>",
"<PIPELINE_3_ID>"
]
}
オーガニゼーションからすべてのパイプラインを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/logs/config/pipelines
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/pipelines"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
[
{
"id": "<PIPELINE_1_ID>",
"type": "pipeline",
"name": "<PIPELINE_1_NAME>",
"is_enabled": false,
"is_read_only": true,
"filter": {
"query": "<PIPELINE_1_FILTER>"
},
"processors": ["<PROCESSOR_PIPELINE_1ARRAY>"
]
},
{
"id": "<PIPELINE_2_ID>",
"type": "pipeline",
"name": "<PIPELINE_2_NAME>",
"is_enabled": false,
"is_read_only": true,
"filter": {
"query": "<PIPELINE_2_FILTER>"
},
"processors": ["<PROCESSOR_PIPELINE_2_ARRAY>"
]
}
]
オーガニゼーションから特定のパイプラインを取得します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/logs/config/pipelines/<PIPELINE_ID>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
pipeline_id=<PIPELINE_ID>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/${pipeline_id}"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"id": "<PIPELINE_ID>",
"type": "pipeline",
"name": "<PIPELINE_NAME>",
"is_enabled": false,
"is_read_only": true,
"filter": {
"query": "<PIPELINE_FILTER>"
},
"processors": [
{
"name": "<PROCESSOR_1_NAME>",
"is_enabled": true,
"source": "message",
"grok": {
"support_rules": "",
"match_rules": "<MATCHED_RULES>"
},
"type": "grok-parser"
},
{
"name": "Define timestamp as the official timestamp of the log",
"is_enabled": true,
"sources": [
"timestamp"
],
"type": "date-remapper"
},
{
"name": "Define level as the official log status",
"is_enabled": true,
"sources": [
"level"
],
"type": "status-remapper"
}
]
}
オーガニゼーションにパイプラインを作成します。
name [必須]:
パイプラインの名前。
is_enabled [オプション、デフォルト = False]:
パイプラインを有効にするためのブール値。
filter.query [オプション]: パイプラインフィルターを定義します。フィルター条件と一致するログだけが、このパイプラインによって処理されます。
processors [オプション]: プロセッサーまたはネストされたパイプラインの順序付き配列。プロセッサーごとのスキームの取得については、プロセッサーに関するドキュメントを参照してください。
SIGNATURE:
POST /v1/logs/config/pipelines
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
curl -X POST \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name": "<PIPELINE_NAME>",
"is_enabled": true,
"filter": {
"query": "<PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}' \
"https://api.datadoghq.com/api/v1/logs/config/pipelines"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"id": "7fKHTENgSkyGoJcCDbem-g",
"type": "pipeline",
"name": "<PIPELINE_NAME>",
"is_enabled": true,
"is_read_only": false,
"filter": {
"query": "<PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}
特定のパイプライン構成を更新して、プロセッサーやその順序を変更します。
name [必須]:
パイプラインの名前。
is_enabled [オプション、デフォルト = False]:
パイプラインを有効にするためのブール値。
filter.query [オプション]: パイプラインフィルターを定義します。フィルター条件と一致するログだけが、このパイプラインによって処理されます。
processors [オプション]: プロセッサーまたはネストされたパイプラインの順序付き配列。プロセッサーごとのスキームの取得については、プロセッサーに関するドキュメントを参照してください。
SIGNATURE:
PUT /v1/logs/config/pipelines/<PIPELINE_ID>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
pipeline_id=<PIPELINE_ID>
curl -X PUT \
-H 'Content-Type: application/json' \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name": "<NEW_PIPELINE_NAME>",
"is_enabled": true,
"filter": {
"query": "<NEW_PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}' \
"https://api.datadoghq.com/api/v1/logs/config/pipelines/${pipeline_id}"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"id": "<PIPELINE_ID>",
"type": "pipeline",
"name": "<NEW_PIPELINE_NAME>",
"is_enabled": true,
"is_read_only": false,
"filter": {
"query": "<NEW_PIPELINE_QUERY>"
},
"processors": [
{
"name": "Define date as the official timestamp of the log",
"is_enabled": true,
"sources": [
"date"
],
"type": "date-remapper"
}
]
}
指定されたパイプラインをオーガニゼーションから削除します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/logs/config/pipelines
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Make sure you replace the <DD_API_KEY> and <DD_APP_KEY> key below
# with the ones for your account
api_key=<DD_API_KEY>
app_key=<DD_APP_KEY>
pipeline_id=<PIPELINE_ID>
curl -X DELETE \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/logs/config/pipelines/${pipeline_id}"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{}メトリクスエンドポイントを使用して、以下を行うことができます。
Datadog の UI に表示されるグラフには、一定数のポイントしか含まれず、表示されているメトリクスのタイムフレームが長くなると、その一定数以下にポイントを抑えるために、ポイント間の集約が行われます。
したがって、クエリするデータのタイムフレームが長くなるほど、返されるポイントの集約度は高くなります。Datadog での最高粒度は 1 ポイント/秒です。この間隔 (1 秒) でポイントを送信し、ごく短い時間 (この場合はおよそ 100 秒未満) をクエリ API にリクエストすれば、送信したポイントがすべてそのまま返されます。そうでない場合、Datadog のアルゴリズムは、指定されたタイムウィンドウごとに約 150 個のポイントを返そうとするため、リクエストされた時間が長くなるほど、粒度の粗いデータが表示されることになります。この時間集計は平均化によって行われます。
メトリクスポイントは 1 秒の解像度で保存されますが、ポイントの送信は 15 秒間隔で行うことをお勧めします。 1 秒未満のタイムスタンプを持つメトリクスは、最も近い秒単位に丸められます。また、同じタイムスタンプを持つポイントが複数ある場合は、最新のポイントによって以前のポイントが上書きされます。
Datadog では、1 ホストあたり 100 個の時系列というソフト制限を設けています。 メトリクス名とタグの一意の組み合わせが 1 つの時系列になります。
このエンドポイントは、Datadog の Ruby クライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
特定の時間から現在までアクティブに報告しているメトリクスのリストを取得します。Python および Ruby ライブラリでは、このエンドポイントを使用できません。
from [必須]:
Unix Epoch 以降の秒数host [オプション]:
返されるメトリクスのリストを絞り込むためのホスト名。設定した場合は、対応するホスト名タグを持つメトリクスが取得されます。SIGNATURE:
GET /v1/metrics
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Taking the last 24hours
from_time = int(time.time()) - 60 * 60 * 24 * 1
result = api.Metric.list(from_time)
print(result)
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
from_time=$(date -v -1d +%s)
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d "from=${from_time}" \
-d "host=<HOSTNAME>" \
"https://api.datadoghq.com/api/v1/metrics"
EXAMPLE RESPONSE:
{
"metrics": [
"system.load.1",
"system.load.15",
"system.load.5",
"system.load.norm.1",
"system.load.norm.15",
"system.load.norm.5",
"system.mem.buffered",
"system.mem.cached",
"system.mem.committed",
"system.mem.free"
],
"from": 1467815773
}
{
"metrics": [
"system.load.1",
"system.load.15",
"system.load.5",
"system.load.norm.1",
"system.load.norm.15",
"system.load.norm.5",
"system.mem.buffered",
"system.mem.cached",
"system.mem.committed",
"system.mem.free"
],
"from": 1467815773
}{
"metrics": [
"system.load.1",
"system.load.15",
"system.load.5",
"system.load.norm.1",
"system.load.norm.15",
"system.load.norm.5",
"system.mem.buffered",
"system.mem.cached",
"system.mem.committed",
"system.mem.free"
],
"from": 1467815773
}メトリクスエンドポイントを使用して、Datadog のダッシュボードでグラフ化できる時系列データをポストできます。圧縮ペイロードの上限は 3.2 メガバイト (3200000)、非圧縮ペイロードでは 62 メガバイト (62914560) です。
series [必須]:
配列内の各項目に次の引数が含まれる JSON 配列を渡します。
metric [必須]:
時系列の名前。type [オプション、デフォルト = gauge]:
メトリクスのタイプ。gauge、rate、count のいずれかです。interval [オプション、デフォルト = None]:
メトリクスのタイプが rate または count の場合に、該当する間隔を定義します。points [必須]:
ポイントの JSON 配列。各ポイントは次の形式になります。
[[POSIX_timestamp, numeric_value], ...]
注: タイムスタンプは現在の秒です。数値の形式は 32 ビット浮動小数点ゲージタイプ値です。
「現在」は、その時点の 10 分先から過去 1 時間以内の時間と定義されます。host [オプション]:
メトリクスを生成したホストの名前。tags [オプション、デフォルト = None]:
メトリクスに関連付けられているタグのリスト。SIGNATURE:
POST /v1/series
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>'
}
initialize(**options)
now = time.time()
future_10s = now + 10
# Submit a single point with a timestamp of `now`
api.Metric.send(metric='page.views', points=1000)
# Submit a point with a timestamp (must be ~current)
api.Metric.send(metric='my.pair', points=(now, 15))
# Submit multiple points.
api.Metric.send(
metric='my.series',
points=[
(now, 15),
(future_10s, 16)
]
)
# Submit a point with a host and tags.
api.Metric.send(
metric='my.series',
points=100,
host="myhost.example.com",
tags=["version:1"]
)
# Submit multiple metrics
api.Metric.send([{
'metric': 'my.series',
'points': 15
}, {
'metric': 'my1.series',
'points': 16
}])
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
dog = Dogapi::Client.new(api_key)
# Submit one metric value.
dog.emit_point('some.metric.name', 50.0, :host => "my_host.example.com")
# Submit multiple metric values
points = [
[Time.now, 0],
[Time.now + 10, 10.0],
[Time.now + 20, 20.0]
]
dog.emit_points('some.metric.name', points, :tags => ["version:1"])
# Emit differents metrics in a single request to be more efficient
dog.batch_metrics do
dog.emit_point('test.api.test_metric',10)
dog.emit_point('test.api.this_other_metric', 1)
end
currenttime=$(date +%s)
curl -X POST -H "Content-type: application/json" \
-d "{ \"series\" :
[{\"metric\":\"test.metric\",
\"points\":[[$currenttime, 20]],
\"type\":\"rate\",
\"interval\": 20,
\"host\":\"test.example.com\",
\"tags\":[\"environment:test\"]}
]
}" \
"https://api.datadoghq.com/api/v1/series?api_key=<YOUR_API_KEY>"
このエンドポイントを使用して、任意の期間のメトリクスをクエリできます。クエリからグラフまでで説明されているクエリ構文を使用してください。
注: Python では、from は予約語です。そのため、Python API では、代わりに関数呼び出しで start パラメーターと end パラメーターを使用します。
from [Python 以外では必須]:
Unix Epoch からの秒数to [Python 以外では必須]:
Unix Epoch からの秒数start [Python では必須、デフォルト = None]:
Unix Epoch 以降の秒数end [Python では必須、デフォルト = None]:
Unix Epoch 以降の秒数query [必須]:
クエリ文字列SIGNATURE:
GET /v1/query
EXAMPLE REQUEST:
from datadog import initialize, api
import time
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
now = int(time.time())
query = 'system.cpu.idle{*}by{host}'
print api.Metric.query(start=now - 3600, end=now, query=query)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get points from the last hour
from = Time.now - 3600
to = Time.now
query = 'system.cpu.idle{*}by{host}'
dog.get_points(query, from, to)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
to_time=$(date +%s)
from_time=$(date --date='1 day ago' +%s)
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/query?&query=avg:system.cpu.user\{*\}by\{host\}&from=${from_time}&to=${to_time}"
EXAMPLE RESPONSE:
{
'status': 'ok',
'res_type': 'time_series',
'series': [{
'end': 1430313599000,
'metric': 'system.cpu.idle',
'interval': 30,
'start': 1430312070000,
'length': 10,
'aggr': None,
'attributes': {},
'pointlist': [
[1430312070000.0, 75.08000183105469],
[1430312100000.0, 99.33000183105469],
[1430312130000.0, 99.83499908447266],
[1430312160000.0, 100.0],
[1430312190000.0, 99.66999816894531],
[1430312220000.0, 100.0],
[1430312250000.0, 99.83499908447266],
[1430312280000.0, 99.66999816894531],
[1430312310000.0, 99.83499908447266],
[1430312340000.0, 99.66999816894531]
],
'expression': 'system.cpu.idle{host:vagrant-ubuntu-trusty-64}',
'scope': 'host:vagrant-ubuntu-trusty-64',
'unit': None,
'display_name': 'system.cpu.idle'
}],
'from_date': 1430309983000,
'group_by': ['host'],
'to_date': 1430313583000,
'query': 'system.cpu.idle{*}by{host}',
'message': u''
}
{
'status' => 'ok',
'res_type' => 'time_series',
'series' => [{
'end' => 1430313599000,
'metric' => 'system.cpu.idle',
'interval' => 30,
'start' => 1430312070000,
'length' => 10,
'aggr' => nil,
'attributes' => {},
'pointlist' => [
[1430312070000.0, 75.08000183105469],
[1430312100000.0, 99.33000183105469],
[1430312130000.0, 99.83499908447266],
[1430312160000.0, 100.0],
[1430312190000.0, 99.66999816894531],
[1430312220000.0, 100.0],
[1430312250000.0, 99.83499908447266],
[1430312280000.0, 99.66999816894531],
[1430312310000.0, 99.83499908447266],
[1430312340000.0, 99.66999816894531]
],
'expression' => 'system.cpu.idle{host:vagrant-ubuntu-trusty-64}',
'scope' => 'host:vagrant-ubuntu-trusty-64',
'unit' => nil,
'display_name' => 'system.cpu.idle'
}],
'from_date' => 1430309983000,
'group_by' => ['host'],
'to_date' => 1430313583000,
'query' => 'system.cpu.idle{*}by{host}',
'message' => ''
}{
"status": "ok",
"res_type": "time_series",
"series": [
{
"metric": "system.cpu.idle",
"attributes": {},
"display_name": "system.cpu.idle",
"unit": null,
"pointlist": [
[
1430311800000,
98.19375610351562
],
[
1430312400000,
99.85856628417969
]
],
"end": 1430312999000,
"interval": 600,
"start": 1430311800000,
"length": 2,
"aggr": null,
"scope": "host:vagrant-ubuntu-trusty-64",
"expression": "system.cpu.idle{host:vagrant-ubuntu-trusty-64}"
}
],
"from_date": 1430226140000,
"group_by": [
"host"
],
"to_date": 1430312540000,
"query": "system.cpu.idle{*}by{host}",
"message": ""
}メトリクスメタデータエンドポイントを使用して、特定のメトリクスに関するメタデータを取得できます。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
GET /v1/metrics/<METRIC_NAME>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
metric = 'system.cpu.idle'
api.Metadata.get(metric_name=metric)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get metadata on metric
result = dog.get_metadata('system.net.bytes_sent')
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
metric_name="system.net.bytes_sent"
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/metrics/${metric_name}"
EXAMPLE RESPONSE:
{
'description': 'Percent of time the CPU spent in an idle state.',
'short_name': 'cpu idle',
'integration': 'system',
'statsd_interval': None,
'per_unit': None,
'type': 'gauge',
'unit': 'percent'
}
{
"description" => "Percent of time the CPU spent in an idle state.",
"short_name" => "cpu idle",
"integration" => "system",
"statsd_interval" => nil,
"per_unit" => nil,
"type" => "gauge",
"unit" => "percent"
}{
"description": "My custom description",
"short_name":"bytes sent",
"integration": null,
"statsd_interval": null,
"per_unit": "second",
"type": "gauge",
"unit": "byte"
}メトリクスメタデータエンドポイントを使用して、メトリクスのメタデータのフィールドを編集できます。 サポートされているタイプについては、こちらを参照してください。
type [必須]:
メトリクスタイプ (gauge、rate など)description [オプション、デフォルト = None]:
メトリクスの説明の文字列short_name [必須]:
メトリクスの短縮名の文字列unit [オプション、デフォルト = None]:
メトリクスの主単位 (byte、operation など)per_unit [オプション、デフォルト = None]:
メトリクスの基準単位。たとえば、バイト/秒の場合の秒statsd_interval [オプション、デフォルト = None]:
該当する場合は、メトリクスの StatsD フラッシュ間隔 (秒単位)SIGNATURE:
PUT /v1/metrics/<METRIC_NAME>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
metric = 'system.net.bytes_sent'
params = {
'description': 'My custom description',
'short_name': 'bytes sent',
'type': 'gauge',
'unit': 'byte',
'per_unit': 'second'
}
api.Metadata.update(metric_name=metric, **params)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
updates = {
"type" => "gauge",
"description" => "my custom description",
"short_name" => "bytes sent",
"unit" => "byte",
"per_unit" => "second"
}
# Submit updates for metric
result = dog.update_metadata('system.net.bytes_sent', updates)api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
metric_name="system.net.bytes_sent"
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"type": "gauge",
"description": "my custom description",
"short_name": "bytes sent",
"unit": "byte",
"per_unit": "second"
}' \
"https://api.datadoghq.com/api/v1/metrics/${metric_name}"
EXAMPLE RESPONSE:
{
'description': 'My custom description',
'short_name': 'bytes sent',
'integration': None,
'statsd_interval': None,
'per_unit': 'second',
'type': 'gauge',
'unit': 'byte'
}
{
"description" => "My custom description",
"short_name" => "bytes sent",
"integration" => nil,
"statsd_interval" => nil,
"per_unit" => "second",
"type" => "gauge",
"unit" => "byte"
}{
"description": "my custom description",
"short_name": "bytes sent",
"integration": null,
"statsd_interval": null,
"per_unit": "second",
"type": "gauge",
"unit": "byte"
}このエンドポイントを使用して、Datadog にある過去 24 時間のメトリクスを検索できます。
q [必須]:
クエリ文字列。先頭に metrics: を付ける必要があります。SIGNATURE:
GET /v1/search
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for the Datadog API
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
dog.search("metrics:test")
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d "api_key=${api_key}" \
-d "application_key=${app_key}" \
"https://api.datadoghq.com/api/v1/search?q=metrics:aws"
EXAMPLE RESPONSE:
{
'results': {
'metrics': [
'test.metric.metric',
'test.tag.metric'
]
}
}
["200", {
"results" => {
"metrics" => ["test.metric"]
}
}]
{
"results": {
"metrics": [
"test.metric"
]
}
}
モニターを使用すると、気になるメトリクスまたはチェックを監視して、定義されたしきい値を超えたときにチームに通知することができます。 モニターの作成方法については、モニターの作成ページを参照してください。
モニターをプログラムで管理およびデプロイしている場合は、Datadog UI でモニターを定義し、有効な JSON をエクスポートする方が簡単です。
type [必須]:
モニターの種類を以下から選択します。| モニターの種類 | 種類の属性値 |
|---|---|
| 異常値 | query alert |
| apm | query alert |
| 複合条件 | composite |
| カスタム | service check |
| イベント | event alert |
| 予測値 | query alert |
| ホスト | service check |
| インテグレーション | query alert または service check |
| ライブプロセス | process alert |
| logs | log alert |
| メトリクス | metric alert |
| ネットワーク | service check |
| 外れ値 | query alert |
| プロセス | service check |
| Watchdog | event alert |
query [必須]:
クエリは、モニターがトリガーするタイミングを定義します。クエリ構文は、作成するモニターの種類に依存します。
time_aggr(time_window):space_aggr:metric{tags} [by {key}] operator #
time_aggr: avg、sum、max、min、change、または pct_changetime_window: last_#m (# は 5、10、15、30)、last_#h(# は 1、2、4)、または last_1dspace_aggr: avg、sum、min、または maxtags: 1 つ以上のタグ (カンマ区切り)、または *key: key:value タグ構文内の ‘key’。グループ内のタグごとに異なるアラートを定義します (マルチアラート)operator: <、<=、>、>=、==、または !=#: しきい値の設定に使用される整数または小数_change_ または _pct_change_ 時間集計関数を使用する場合は、代わりに change_aggr(time_aggr(time_window), timeshift):space_aggr:metric{tags} [by {key}] operator # を次のように使用します。
change_aggr change、pct_changetime_aggr avg、sum、max、min 詳細はこちらtime_window last#m (1、5、10、15、30)、last#h (1、2、4)、または last_#d (1 または 2)timeshift #m_ago (5、10、15、30)、#h_ago (1、2、4)、または 1d_ago次のクエリを使用して、外れ値モニターを作成できます: avg(last_30m):outliers(avg:system.cpu.user{role:es-events-data} by {host}, 'dbscan', 7) > 0
"check".over(tags).last(count).count_by_status()
check チェックの名前。例: datadog.agent.uptags 引用符で囲まれた 1 つ以上のタグ (カンマ区切り)、または “*“。例: .over("env:prod", "role:db")count 最大しきい値 (options で定義) 以上である必要があります。例: ステータス 1 を critical、3 を OK、2 を warn と通知する場合は、count を 3 にする必要があります。上限値は 10 です。events('sources:nagios status:error,warning priority:normal tags: "string query"').rollup("count").last("1h")"
event イベントクエリ文字列。string_query イベントタイトルおよびテキストと照合するフリーテキストクエリ。sources イベントソース (カンマ区切り)。ソース属性値のリストはこちらを参照してください。status イベントステータス (カンマ区切り)。有効なオプション: error、warn、info。priority イベントの優先度 (カンマ区切り)。有効なオプション: low、normal、all。host イベントを報告しているホスト (カンマ区切り)。tags イベントタグ (カンマ区切り)。excluded_tags 除外されるイベントタグ (カンマ区切り)。rollup 統計のロールアップ方法。現時点でサポートされている方法は count だけです。last カウントをロールアップするタイムフレーム。例: 60s、4h。サポートされているタイムフレーム: s、m、h、d。processes(search).over(tags).rollup('count').last(timeframe) operator #
search プロセスの問い合わせに使用するフリーテキスト検索文字列。一致するプロセスは、ライブプロセスページの結果と一致します。tags 1 つ以上のタグ (カンマ区切り)timeframe カウントをロールアップするタイムフレーム。例: 60s、4h。サポートされているタイムフレーム: s、m、h、doperator <、<=、>、>=、==、または !=# しきい値の設定に使用される整数または小数12345 && 67890。ここで、12345 と 67890 は非複合条件モニターの ID です
name [必須、デフォルト = dynamic。クエリに基づく]:
アラートの名前。
message [必須、デフォルト = dynamic。クエリに基づく]:
このモニターの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。
tags [オプション、デフォルト = 空のリスト]:
モニターに関連付けられるタグのリスト。API からすべてのモニター詳細を取得する際は、monitor_tags 引数を使用して、これらのタグで結果を絞り込みます。API からのみ使用できます。Datadog UI には表示されず、編集もできません。
options [オプション、デフォルト = {}]:
モニターのオプションの辞書。すべての種類に共通のオプションと、一部の種類のモニターに固有のオプションがあります。
silenced スコープからタイムスタンプへの辞書または None。各スコープは、指定された POSIX タイムスタンプまで、または値が None の場合は無制限にミュートされます。デフォルト: None
例:
{'*': None}role:db をミュートするには: {'role:db': 1412798116}new_host_delay モニター結果の評価を開始する前に、ホストがブートし、アプリケーションが完全に起動するまで待つ時間 (秒単位)。負でない整数である必要があります。デフォルト: 300
notify_no_data データが報告を停止したことをこのモニターが通知するかどうかを示すブール値。デフォルト: false
no_data_timeframe データが報告を停止してから何分後にモニターが通知を行うか。notify_no_data が true に設定されている場合、このパラメーターは必須です。メトリクスアラートの場合は少なくともモニタータイムフレームの 2 倍、サービスのチェックの場合は少なくとも 2 分にする必要があります。デフォルト: メトリクスアラートの場合はタイムフレームの 2 倍、サービスチェックの場合は 2 分
timeout_h データを報告していないモニターが、トリガーされた状態から自動的に回復するまでの時間数。デフォルト: None。
require_full_window このモニターがウィンドウ全体のデータを取得するまで評価を行わないかどうかを示すブール値。疎なメトリクスの場合は False に設定することを強くお勧めします。そうしないと、一部の評価がスキップされます。デフォルト: “on average”、”at all times”、および “in total” 集計の場合は True、それ以外の場合は False。
renotify_interval モニターが最後に通知してから現在のステータスを再通知するまでの分数。これは、回復していないことを再通知するだけです。デフォルト: None。
escalation_message 再通知に含めるメッセージ。他の場所と同様に ‘@username’ 通知をサポートします。renotify_interval が None の場合は適用されません。デフォルト: None。
notify_audit タグ付けされたユーザーに、このモニターへの変更が通知されるかどうかを示すブール値。デフォルト: False
locked このモニターへの変更を作成者または管理者に制限するかどうかを示すブール値。デフォルト: False
include_tags このモニターからの通知のタイトルに、トリガーしているタグを自動的に挿入するかどうかを示すブール値。デフォルト: True 例:
[Triggered on {host:h1}] Monitor Title[Triggered] Monitor Titleこれらのオプションは異常値モニターにのみ適用され、他の種類のモニターでは無視されます。
threshold_windows recovery_window と trigger_window からなる辞書。
recovery_window 異常メトリクスがどのくらいの期間正常であればアラートから回復するかを記述します。trigger_window メトリクスがどのくらいの期間異常であればアラートをトリガーするかを記述します。
例: {'threshold_windows': {'recovery_window': 'last_15m', 'trigger_window': 'last_15m'}}
これらのオプションはメトリクスアラートにのみ適用されます。
thresholds しきい値タイプ別のしきい値の辞書。メトリクスアラートには、critical と warning という 2 種類のしきい値があります。Critical はクエリで定義されますが、このオプションで指定することもできます。Warning しきい値は、しきい値オプションを使用してのみ指定できます。
モニターにリカバリしきい値を使用する場合は、critical_recovery および warning_recovery 属性を使用します。
例: `{'critical': 90, 'warning': 80, 'critical_recovery': 70, 'warning_recovery': 50}`
evaluation_delay 評価を遅延させる時間 (秒単位)。負以外の整数です。たとえば、この値を 300 (5 分)、タイムフレームを last_5m、時刻を 7:00 に設定すると、モニターは、6:50 から 6:55 までのデータを評価します。これは、モニターが評価時に常にデータを取得できるため、AWS CloudWatch などのバックフィルされるメトリクスで役立ちます。
これらのオプションはサービスのチェックにのみ適用され、他の種類のモニターでは無視されます。
thresholds ステータス別のしきい値の辞書。サービスのチェックは複数のしきい値を持つことができるため、直接クエリでは定義しません。
例: `{'ok': 1, 'critical': 1, 'warning': 1}`
リクエストに無効なモニターオプションが含まれている場合は、次のような応答が返されます。
Error: 400 - ["Invalid monitor option:<invalid option>"]
SIGNATURE:
POST /v1/monitor
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Create a new monitor
monitor_options = {
"notify_no_data": True,
"no_data_timeframe": 20
}
tags = ["app:webserver", "frontend"]
api.Monitor.create(
type="metric alert",
query="avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
name="Bytes received on host0",
message="We may need to add web hosts if this is consistently high.",
tags=tags,
options=monitor_options
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a new monitor
options = {
'notify_no_data' => true,
'no_data_timeframe' => 20
}
tags = ['app:webserver', 'frontend']
dog.monitor("metric alert", "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", :name => "Bytes received on host0", :message => "We may need to add web hosts if this is consistently high.", :tags => tags, :options => options)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"type": "metric alert",
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"name": "Bytes received on host0",
"message": "We may need to add web hosts if this is consistently high.",
"tags": ["app:webserver", "frontend"],
"options": {
"notify_no_data": true,
"no_data_timeframe": 20
}
}' \
"https://api.datadoghq.com/api/v1/monitor"
EXAMPLE RESPONSE:
{'creator': {'email': 'matt@example.com',
'handle': 'matt@example.com',
'id': 1896,
'name': u'Matt'},
'id': 2081,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'tags': ['app:webserver', 'frontend'],
'options': {'no_data_timeframe': 20,
'notify_audit': False,
'notify_no_data': True,
'silenced': {}},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T16:34:14.014039+00:00'
}
["200", {
"name" => "Bytes received on host0",
"org_id" => 1499,
"tags" => ["app:webserver", "frontend"],
"options" => {
"notify_no_data" => true,
"no_data_timeframe" => 20,
"notify_audit" => false,
"silenced" => {}
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "We may need to add web hosts if this is consistently high.",
"type" => "metric alert",
"id" => 92089,
"multi" => false,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00"
}]{
"id": 92090,
"message": "We may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"tags": ["app:webserver", "frontend"],
"options": {
"no_data_timeframe": 20,
"notify_audit": false,
"notify_no_data": true,
"silenced": {}
},
"org_id": 1499,
"query": "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
"state": {},
"type": "metric alert",
"multi": false,
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T16:34:14.014039+00:00"
}
group_states [オプション、デフォルト = None]:
この引数を設定すると、指定したグループ状態に関する追加情報があれば、それを含むデータが返されます。たとえば、最後の通知タイムスタンプ、最後の解決タイムスタンプ、モニターがトリガーした最後の時間などです。この引数は、どのグループ状態を追加するかを含む文字列リストを指定します。all、alert、warn、no data から 1 つ以上を選択します。例: ‘alert,warn’”SIGNATURE:
GET /v1/monitor/<MONITOR_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get a monitor's details
api.Monitor.get(2081, group_states='all')
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get a monitors's details
dog.get_monitor(91879, :group_states => 'all')#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Show a monitor
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d "group_states=all" \
"https://api.datadoghq.com/api/v1/monitor/${monitor_id}"
EXAMPLE RESPONSE:
{
'id': 2081,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {
'no_data_timeframe': 20,
'notify_audit': False,
'notify_no_data': True,
'silenced': {}
},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T16:34:14.014039+00:00',
"state": {
"groups": {
"host:host0": {
"last_nodata_ts": null,
"last_notified_ts": 1481909160,
"last_resolved_ts": 1481908200,
"last_triggered_ts": 1481909160,
"name": "host:host0",
"status": "Alert",
"triggering_value": {
"from_ts": 1481909037,
"to_ts": 1481909097,
"value": 1000
}
}
}
}
}
["200", {
"name" => "Bytes received on host0",
"org_id" => 1499,
"options" => {
"no_data_timeframe" => 20,
"notify_no_data" => false,
"notify_audit" => false,
"silenced" => {}
},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "We may need to add web hosts if this is consistently high.",
"type" => "metric alert",
"id" => 91879,
"multi" => false,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00",
"state" => {
"groups" => {
"host:host0" => {
"last_nodata_ts" => null,
"last_notified_ts" => 1481909160,
"last_resolved_ts" => 1481908200,
"last_triggered_ts" => 1481909160,
"name" => "host:host0",
"status" => "Alert",
"triggering_value" => {
"from_ts" => 1481909037,
"to_ts" => 1481909097,
"value" => 1000
}
}
}
}
}]
{
"id": 91879,
"message": "We may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"options": {
"no_data_timeframe": 20,
"notify_audit": false,
"notify_no_data": false,
"silenced": {}
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"type": "metric alert",
"multi": false,
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T16:34:14.014039+00:00",
"state": {
"groups": {
"host:host0": {
"last_nodata_ts": null,
"last_notified_ts": 1481909160,
"last_resolved_ts": 1481908200,
"last_triggered_ts": 1481909160,
"name": "host:host0",
"status": "Alert",
"triggering_value": {
"from_ts": 1481909037,
"to_ts": 1481909097,
"value": 1000
}
}
}
}
}
query [必須]:
アラートするメトリクスクエリ。name [必須]:
モニターの名前。message [オプション、デフォルト = dynamic。クエリに基づく]:
このモニターの通知に含めるメッセージ。イベントと同じ「@username」表記を使用して、特定のユーザーに電子メール通知を送信できます。options [オプション、デフォルト = {}]:
使用可能なオプションについては、モニターの作成に関するドキュメントを参照してください。tags [オプション、デフォルト = None]:
モニターに関連付けられるタグのリスト。モニターの分類と絞り込みに役立ちます。SIGNATURE:
PUT /v1/monitor/<MONITOR_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Edit an existing monitor
api.Monitor.update(
2081,
query="avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100",
name="Bytes received on host0",
message="We may need to add web hosts if this is consistently high."
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Edit an existing monitor
dog.update_monitor(91879, "avg(last_5m):sum:system.net.bytes_rcvd{host:host0} > 100", :message => "Bytes received on host0", :name => "We may need to add web hosts if this is consistently high.")#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Edit a monitor
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"name": "Bytes received on host0",
"message": "We may need to add web hosts if this is consistently high."
}' \
"https://api.datadoghq.com/api/v1/monitor/${monitor_id}"
EXAMPLE RESPONSE:
{
'id': 2081,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {'notify_audit': False, 'notify_no_data': False, 'silenced': {}},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
[
"200", {
"name" => "We may need to add web hosts if this is consistently high.",
"org_id" => 1499,
"options" => {
"notify_no_data" => false, "notify_audit" => false, "silenced" => {}
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "Bytes received on host0",
"type" => "metric alert",
"id" => 91879,
"multi" => false,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T18:39:24.391207+00:00"
}
]{ "id": 91879,
"message": "We may need to add web hosts if this is consistently high.",
"name": "Bytes received on host0",
"options": {
"notify_audit": false,
"notify_no_data": false,
"silenced": {}
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"state": {},
"type": "metric alert",
"multi": false,
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T18:39:24.391207+00:00"}このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
DELETE /v1/monitor/<MONITOR_ID>
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Delete a monitor
api.Monitor.delete(2081)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Delete a monitor
dog.delete_monitor(62625)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Delete a monitor
curl -X DELETE "https://api.datadoghq.com/api/v1/monitor/${monitor_id}?api_key=${api_key}&application_key=${app_key}"
EXAMPLE RESPONSE:
{
'deleted_monitor_id': 2081
}
["200", {
"deleted_monitor_id" => 62625
}]{
"deleted_monitor_id": 59409
}group_states [オプション、デフォルト = None]:
この引数を設定すると、指定したグループ状態に関する追加情報があれば、それを含むデータが返されます。たとえば、最後の通知タイムスタンプ、最後の解決タイムスタンプ、モニターがトリガーした最後の時間などです。この引数は、どのグループ状態を追加するかを含む文字列リストを指定します。’all’、’alert’、’warn’、’no data’ から 1 つ以上を選択します。例: ‘alert,warn’name [オプション、デフォルト = None]:
モニターを名前で絞り込むための文字列tags [オプション、デフォルト = None]:
どのタグを使用してモニターのリストをスコープで絞り込むかを示すカンマ区切りのリスト。例: host:host0。詳細については、上のモニターの作成セクションにある query 引数の tags パラメーターを参照してください。monitor_tags [オプション、デフォルト = None]:
どのサービスタグやカスタムタグを使用してモニターのリストを絞り込むかを示すカンマ区切りのリスト。Datadog UI で作成されたタグには、自動的に service キーが付加されます (例: service:my-app)。with_downtimes [オプション、デフォルト = true]:
この引数を true に設定した場合は、モニターごとの現在のすべてのダウンタイムを含むデータが返されます。page [オプション、デフォルト = 0]:
ページ区切りする場合の開始ページ。この引数が指定されない場合、リクエストは、すべてのモニターをページ区切りなしで返します。page_size [オプション、デフォルト = 100]:
1 ページで返されるモニターの数。page 引数が指定されていない場合、page_size 制限は無視され、デフォルトですべてのモニターが返されます。一方、page が指定され、page_size が指定されていない場合、この引数はデフォルトで 100 になります。SIGNATURE:
GET /v1/monitor
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Get all monitor details
print api.Monitor.get_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Get all monitor details
dog.get_all_monitors()#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor"
EXAMPLE RESPONSE:
[
{'creator': {
'email': 'matt@example.com',
'handle': 'matt@example.com',
'id': 1896,
'name': u'Matt'
},
'id': 2085,
'message': u'',
'name': '**system.net.bytes_rcvd** over **host:host0** was **> 100** on average during the **last 1h**.',
'options': {'notify_audit': False, 'notify_no_data': False, 'silenced': {}},
'org_id': 2,
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'},
{'creator': {'email': 'matt@example.com',
'handle': 'matt@example.com',
'id': 1896,
'name': u'Matt'},
'id': 2083,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {'no_data_timeframe': 20,
'notify_audit': False,
'notify_no_data': True,
'silenced': {}},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'multi': False,
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
]
[
"200", [{
"name" => "Bytes received on host0",
"org_id" => 1499,
"options" => {
"notify_no_data" => false, "notify_audit" => false, "silenced" => {}
},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "We may need to add web hosts if this is consistently high.",
"type" => "metric alert",
"multi" => false,
"id" => 91879,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00"
}, {
"name" =>
"**system.net.bytes_rcvd** over **host:host0** was **> 100** on average during the **last 1h**.",
"org_id" => 1499,
"options" => {
"notify_audit" => true,
"timeout_h" => nil,
"silenced" => {},
"no_data_timeframe" => false,
"notify_no_data" => false,
"renotify_interval" => nil,
"escalation_message" => ""
},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100",
"message" => "",
"type" => "metric alert",
"multi" => false,
"id" => 91875,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T16:34:14.014039+00:00"
}]
][
{
"tags":[
],
"deleted":null,
"query":"change(avg(last_5m),last_1m):avg:apache.net.hits{*} by {host} > 500",
"message":"Host {{host.name}} with IP {{host.ip}} is under heavy load.",
"matching_downtimes":[
],
"id":1111111,
"multi":true,
"name":"example title",
"created":"2019-03-11T17:20:45.414125+00:00",
"created_at":1552324845000,
"creator":{
"id":1111111,
"handle":"example@example.com",
"name":"Jane Doe",
"email":"example@example.com"
},
"org_id":1111111,
"modified":"2019-03-11T17:20:45.414125+00:00",
"overall_state_modified":"2019-03-19T12:55:48.320241+00:00",
"overall_state":"No Data",
"type":"query alert",
"options":{
"notify_audit":false,
"locked":false,
"timeout_h":0,
"silenced":{
},
"include_tags":true,
"no_data_timeframe":null,
"require_full_window":true,
"new_host_delay":300,
"notify_no_data":false,
"renotify_interval":0,
"escalation_message":"",
"thresholds":{
"critical":500,
"warning":250
}
}
},
{
"tags":[
],
"deleted":null,
"query":"avg(last_1m):outliers(avg:apache.net.hits{*} by {host}, 'DBSCAN', 3) > 0",
"message":"@example@example.com",
"matching_downtimes":[
],
"id":1111111,
"multi":true,
"name":"example title",
"created":"2019-03-11T18:10:09.957865+00:00",
"created_at":1552327809000,
"creator":{
"id":111111,
"handle":"example@example.com",
"name":"Jane Doe",
"email":"example@example.com"
},
"org_id":1111111,
"modified":"2019-03-11T18:11:25.217705+00:00",
"overall_state_modified":"2019-03-20T12:50:45.684420+00:00",
"overall_state":"No Data",
"type":"query alert",
"options":{
"notify_audit":false,
"locked":false,
"timeout_h":0,
"silenced":{
},
"include_tags":true,
"no_data_timeframe":null,
"require_full_window":true,
"new_host_delay":300,
"notify_no_data":false,
"renotify_interval":0,
"escalation_message":""
}
}
]resolve [必須]:
特定の monitor_id に対して解決するグループの配列。例:
{"monitor_id": "group_to_resolve"}
1 つのモニターで複数のグループがサポートされます。例:
resolve: [{"monitor_id": "group_1"}, {"monitor_id": "group_2"}]
擬似グループ ALL_GROUPS を使用して、トリガーされたすべてのグループを解決することもできます。
resolve: [{"monitor_id": "ALL_GROUPS"}]
SIGNATURE:
POST https://api.datadoghq.com/monitor/bulk_resolve
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"resolve": [
{"<YOUR_MONITOR_ID>": "<YOUR_FIRST_GROUP>"},
{"<YOUR_MONITOR_ID>": "<YOUR_SECOND_GROUP>"}
]
}' \
"https://app.datadoghq.com/monitor/bulk_resolve"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
[
{
"tags": [
"*"
],
"deleted": null,
"query": "avg(last_1h):avg:system.cpu.user{role:cassandra} by {host} > 10",
"message": "I'm a dummy test.",
"id": 2610751,
"multi": true,
"name": "[Do not mind] This is a test",
"created": "2017-08-09T14:30:38.584147+00:00",
"created_at": 1502289038000,
"org_id": 11287,
"modified": "2017-08-09T14:36:48.176919+00:00",
"overall_state_modified": "2017-08-11T12:21:05.949182+00:00",
"overall_state": "Alert",
"type": "metric alert",
"options": {
"notify_audit": false,
"locked": false,
"timeout_h": 0,
"silenced": {},
"include_tags": false,
"no_data_timeframe": 10,
"new_host_delay": 300,
"require_full_window": false,
"notify_no_data": false,
"renotify_interval": 0,
"escalation_message": "",
"thresholds": {
"critical": 10,
"warning": 5
}
}
}
]ミュートすると、すべてのモニターが電子メールによる通知とイベントストリームへのポストを停止します。アラートページをチェックしないと、状態変更は表示されません。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
POST /v1/monitor/mute_all
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Mute all monitors
api.Monitor.mute_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Mute all alerts
dog.mute_monitors()#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor/mute_all"
EXAMPLE RESPONSE:
{
'active': True,
'disabled': False,
'end': None,
'id': 2728,
'message': None,
'scope': ['*'],
'start': 1419440110
}
[
"200", {
"end" => nil,
"disabled" => false,
"start" => 1412805855,
"active" => true,
"scope" => ["*"],
"id" => 1647
}
]{
"active": true,
"disabled": false,
"end": null,
"id": 1648,
"scope": [
"*"
],
"start": 1412805856
}すべてのモニターのミュートを無効にします。すべてミュートが有効になっていなかった場合は、エラーを生成します。
このエンドポイントは、JSON 引数を受け取りません。
SIGNATURE:
POST /v1/monitor/unmute_all
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Unmute all alerts
api.Monitor.unmute_all()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Unmute all alerts
dog.unmute_monitors()#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor/unmute_all"
EXAMPLE RESPONSE:
This endpoint does not return JSON on successful requests.
scope [オプション、デフォルト = None]:
ミュートする対象のスコープ。例: role:db。
たとえば、アラートが {host} でグループ化されている場合は、host:app1 をミュートできます。end [オプション、デフォルト = None]:
ミュートの終了時間を示す POSIX タイムスタンプ。SIGNATURE:
POST /v1/monitor/<MONITOR_ID>/mute
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Mute a monitor
api.Monitor.mute(2088)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Mute a monitor
dog.mute_monitor(62628)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Mute a monitor
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor/${monitor_id}/mute"
EXAMPLE RESPONSE:
{
'id': 2088,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {
'notify_audit': False,
'notify_no_data': False,
'silenced': {
'*': None
}
},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
[
"200", {
"name" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"org_id" => 1499,
"options" => {
"notify_no_data" => false,
"notify_audit" => true,
"timeout_h" => nil,
"silenced" => {
"*" => nil
},
"is_data_sparse" => false,
"renotify_interval" => nil
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"message" => "",
"type" => "metric alert",
"id" => 62628,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T18:39:24.391207+00:00"
}
]{
"id": 62628,
"message": "",
"name": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"options": {
"is_data_sparse": false,
"notify_audit": true,
"notify_no_data": false,
"renotify_interval": null,
"silenced": {
"*": null
},
"timeout_h": null
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"state": {},
"type": "metric alert",
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T18:39:24.391207+00:00"
}
scope [オプション、デフォルト = None]:
ミュートする対象のスコープ。
たとえば、アラートが {host} でグループ化されている場合は、’host:app1’ をミュートできます。all_scopes [オプション、デフォルト = False]:
すべてのスコープのミュートをクリアします。SIGNATURE:
POST /v1/monitor/<MONITOR_ID>/unmute
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Unmute all alerts
api.Monitor.unmute(2088)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Unmute all alerts
dog.unmute_monitor(62628)#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
monitor_id=<YOUR_MONITOR_ID>
# Unmute a monitor
curl -X POST \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor/${monitor_id}/unmute"
EXAMPLE RESPONSE:
{
'id': 2088,
'message': 'We may need to add web hosts if this is consistently high.',
'name': 'Bytes received on host0',
'options': {
'notify_audit': False,
'notify_no_data': False,
'silenced': {}
},
'org_id': 2,
'overall_state': 'No Data',
'query': 'avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 100',
'type': 'metric alert',
'created': '2015-12-18T16:34:14.014039+00:00',
'modified': '2015-12-18T18:39:24.391207+00:00'
}
[
"200", {
"name" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"org_id" => 1499,
"options" => {
"notify_no_data" => false,
"notify_audit" => true,
"timeout_h" => nil,
"silenced" => {},
"is_data_sparse" => false,
"renotify_interval" => nil
},
"state" => {},
"query" => "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"message" => "",
"type" => "metric alert",
"id" => 62628,
"created" => "2015-12-18T16:34:14.014039+00:00",
"modified" => "2015-12-18T18:39:24.391207+00:00"
}
]{
"id": 62628,
"message": "",
"name": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"options": {
"is_data_sparse": false,
"notify_audit": true,
"notify_no_data": false,
"renotify_interval": null,
"silenced": {
"*": null
},
"timeout_h": null
},
"org_id": 1499,
"query": "avg(last_1h):sum:system.net.bytes_rcvd{host:host0} > 200",
"state": {},
"type": "metric alert",
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T18:39:24.391207+00:00"
}このエンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
モニター定義を検証します。モニター定義の構成の詳細については、モニターの作成を参照してください。
SIGNATURE:
POST /v1/monitor/validate
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"type": "metric alert",
"query": "THIS QUERY IS INVALID",
"name": "Bytes received on host0",
"message": "We may need to add web hosts if this is consistently high.",
"tags": ["app:webserver", "frontend"],
"options": {
"notify_no_data": true,
"no_data_timeframe": 20
}
}' \
"https://api.datadoghq.com/api/v1/monitor/validate"
EXAMPLE RESPONSE:
{}["200", {}]{
"errors": [
"The value provided for parameter 'query' is invalid"
]
}
モニターの詳細を検索および絞り込みをします。
query [オプション]:
モニターの管理ページで検索クエリを入力した後、そのページの URL に含まれるクエリパラメーター値をこのパラメーターの値として使用します。詳細については、モニター管理に関するドキュメントのページを参照してください。
クエリには、query="type:metric status:alert" のように、モニター属性をスペースで区切り、いくつでも含めることができます。
page [オプション、デフォルト = 0]:
ページ区切りする場合の開始ページ。
per_page [オプション、デフォルト = 30]:
1 ページで返されるモニターの数。
sort [オプション、デフォルト = null]:
ソート順序を示すカンマ区切りの文字列 (例: name,asc)。サポートされているフィールドは次のとおりです。
namestatustagsSIGNATURE:
GET /v1/monitor/search
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Search monitors
api.Monitor.search()
# Examples of possible query parameters:
# api.Monitor.search(query="id:7100311")
# api.Monitor.search(query="title:foo metric:system.core.idle status:Alert")
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Search monitors
dog.search_monitors()
# Examples of possible query parameters:
# dog.search_monitors(query="id:7100311")
# dog.search_monitors(query="title:foo metric:system.core.idle status:Alert")
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
query=<MANAGE_MONITOR_QUERY>
page=<PAGE_NUMBER>
per_page=<PER_PAGE>
sort=<SORT>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor/search?query=${query}&page=${page}&per_page=${per_page}&sort=${sort}"
EXAMPLE RESPONSE:
{ u'counts':
{ u'muted': [{ u'count': 1, u'name': False}],
u'status': [{ u'count': 1, u'name': u'Alert'}],
u'tag': [ { u'count': 1, u'name': u'env:myenv'},
{ u'count': 1, u'name': u'service:sample'}],
u'type': [{ u'count': 1, u'name': u'apm'}]},
u'metadata': { u'page': 0,
u'page_count': 1,
u'per_page': 30,
u'total_count': 1},
u'monitors':
[ { u'classification': u'apm',
u'creator': { u'handle': u'jane@example.com',
u'id': 795042,
u'name': u'Jane'},
u'id': 6797333,
u'last_triggered_ts': 1540483133,
u'metrics': [ u'trace.servlet.request.hits',
u'trace.servlet.request.errors'],
u'name': u'Service sample has a high error rate on env:myenv',
u'notifications': [ { u'handle': u'jane@example.com',
u'name': u'Jane'}],
u'org_id': 11287,
u'scopes': [u'env:myenv', u'service:sample'],
u'status': u'Alert',
u'tags': [u'env:myenv', u'service:sample'],
u'type': u'query alert'}]}
["200",
{"counts"=>
{"status"=>[{"count"=>1, "name"=>"Alert"}],
"muted"=>[{"count"=>1, "name"=>false}],
"tag"=>
[{"count"=>1, "name"=>"env:myenv"},
{"count"=>1, "name"=>"service:sample"}],
"type"=>[{"count"=>1, "name"=>"apm"}]},
"monitors"=>
[{"status"=>"Alert",
"scopes"=>["env:myenv", "service:sample"],
"classification"=>"apm",
"creator"=>
{"handle"=>"jane@example.com",
"id"=>795042,
"name"=>"Jane"},
"metrics"=>["trace.servlet.request.hits", "trace.servlet.request.errors"],
"notifications"=>
[{"handle"=>"jane@example.com", "name"=>"Jane"}],
"last_triggered_ts"=>1540483133,
"id"=>6797333,
"name"=>"Service sample has a high error rate on env:myenv",
"tags"=>["env:myenv", "service:sample"],
"org_id"=>11287,
"type"=>"query alert"}],
"metadata"=>{"total_count"=>1, "page_count"=>1, "page"=>0, "per_page"=>30}}]
{
"counts": {
"status": [
{
"count": 4,
"name": "No Data"
},
{
"count": 2,
"name": "OK"
}
],
"muted": [
{
"count": 3,
"name": false
},
{
"count": 3,
"name": true
}
],
"tag": [
{
"count": 6,
"name": "service:cassandra"
}
],
"type": [
{
"count": 6,
"name": "metric"
}
]
},
"monitors": [
{
"status": "No Data",
"scopes": [
"!availability-zone:us-east-1c",
"name:cassandra"
],
"classification": "metric",
"creator": {
"handle": "xxxx@datadoghq.com",
"name": "xxxx@datadoghq.com",
"id": {
"handle": "xxxx@datadoghq.com",
"id": 1234,
"name": null
}
},
"metrics": [
"system.cpu.user"
],
"notifications": [
{
"handle": "xxxx@datadoghq.com",
"name": "xxxx@datadoghq.com"
}
],
"last_triggered_ts": null,
"id": 2699850,
"name": "Cassandra CPU is high on {{host.name}} in {{availability-zone.name}}",
"tags": [
"service:cassandra"
],
"org_id": 1234,
"type": "metric alert"
},
{
"status": "OK",
(...)
},
],
"metadata": {
"total_count": 6,
"page_count": 6,
"page": 0,
"per_page": 30
}
}モニターグループの詳細を検索および絞り込みをします。
query [オプション]:
モニターの管理ページで検索クエリを入力した後、そのページの URL に含まれるクエリパラメーター値をこのパラメーターの値として使用します。詳細については、モニター管理に関するドキュメントのページを参照してください。
page [オプション、デフォルト = 0]:
ページ区切りする場合の開始ページ。
per_page [オプション、デフォルト = 30]:
1 ページで返されるモニターの数。
sort [オプション、デフォルト = null]:
ソート順序を示すカンマ区切りの文字列 (例: name,asc)。サポートされているフィールドは次のとおりです。
namestatustagsSIGNATURE:
GET /v1/monitor/groups/search
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Search monitor groups
api.Monitor.search_groups()
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Search monitor groups
dog.search_monitor_groups()
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
query=<MANAGE_MONITOR_QUERY>
page=<PAGE_NUMBER>
per_page=<PER_PAGE>
sort=<SORT>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/monitor/groups/search?query=${query}&page=${page}&per_page=${per_page}&sort=${sort}"
EXAMPLE RESPONSE:
{ u'counts':
{ u'status': [{ u'count': 1, u'name': u'Alert'}],
u'type': [{ u'count': 1, u'name': u'apm'}]},
u'groups': [ { u'group': u'*',
u'group_tags': [u'*'],
u'last_nodata_ts': 0,
u'last_triggered_ts': 1540483133,
u'monitor_id': 6797333,
u'monitor_name': u'Service sample has a high error rate on env:myenv',
u'status': u'Alert'}],
u'metadata': { u'page': 0,
u'page_count': 1,
u'per_page': 30,
u'total_count': 1}}
["200",
{"counts"=>
{"status"=>[{"count"=>1, "name"=>"Alert"}],
"type"=>[{"count"=>1, "name"=>"apm"}]},
"groups"=>
[{"status"=>"Alert",
"last_triggered_ts"=>1540483133,
"group"=>"*",
"monitor_id"=>6797333,
"group_tags"=>["*"],
"last_nodata_ts"=>0,
"monitor_name"=>"Service sample has a high error rate on env:myenv"}],
"metadata"=>{"total_count"=>1, "page_count"=>1, "page"=>0, "per_page"=>30}}]
{
"counts": {
"status": [
{
"count": 2,
"name": "OK"
}
],
"type": [
{
"count": 2,
"name": "metric"
}
]
},
"groups": [
{
"status": "OK",
"last_triggered_ts": 1525702966,
"group": "*",
"monitor_id": 2738266,
"group_tags": [
"*"
],
"last_nodata_ts": 0,
"monitor_name": "[demo] Cassandra disk usage is high on {{host.name}}"
},
{
"status": "OK",
"last_triggered_ts": 1525703008,
"group": "*",
"monitor_id": 1576648,
"group_tags": [
"*"
],
"last_nodata_ts": 0,
"monitor_name": "[demo] Disk usage is high on {{host.name}}"
}
],
"metadata": {
"total_count": 2,
"page_count": 2,
"page": 0,
"per_page": 30
}
}Organization エンドポイントは、Datadog のクライアントライブラリでサポートされていません。この機能の使用を希望される場合は、Datadog のサポートチームにお問い合わせください。
Organization を作成、編集、および管理できます。マルチ Organization のアカウントについては、こちらを参照してください。
このエンドポイントには、マルチオーガニゼーションのアカウント機能が必要です。また、サポートに問い合わせて、エンドポイントを有効にしておく必要があります。
name [必須]:
新しい子オーガニゼーションの名前。32 文字に制限されます。subscription [必須]:
サブスクリプションタイプの JSON 配列。使用できるタイプは、trial、free、pro です。billing [必須]:
課金タイプの JSON 配列。parent_billing だけがサポートされています。新しい子オーガニゼーションが作成されたら、応答に示された org.public_id、api_key.key、および application_key.hash を使用して、子オーガニゼーションとやり取りできます。
SIGNATURE:
POST /v1/org
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"name" :"My Org",
"subscription" :{"type":"pro"},
"billing" :{"type":"parent_billing"}
}' \
"https://api.datadoghq.com/api/v1/org"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"org" : {
"name" : "My Org",
"public_id" : "axd2s",
"subscription" : {
"type" : "pro"
},
"billing" : {
"type" : "parent_billing"
}
},
"user" : {
"name" : "Organization admin",
"handle" : "test@datadoghq.com",
...
},
"api_key" : {
"created_by": "user",
"key": "6ccdfb88ff1aa63192c326"
...
},
"application_key": {
"owner": "Organization admin",
"hash": "88e5ae6a71f51d1d5a0071a24f",
...
}
}
SIGNATURE:
GET /v1/org
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X GET \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
"https://api.datadoghq.com/api/v1/org"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"orgs" : [{
"name" : "My Org",
"public_id" : "axd2s",
"subscription" : {
"type" : "pro"
},
"billing" : {
"type" : "bill-parent"
}
}]
}
name [オプション]:
オーガニゼーション名。settings [オプション]:
設定の JSON 配列。設定は次のとおりです。saml - ブール値プロパティ enabled を設定して、SAML を使用したシングルサインオンを有効または無効にします。すべての SAML 設定の詳細については、SAML に関するドキュメントを参照してください。saml_idp_initiated_login enabled というブール値プロパティがあります。saml_strict_mode enabled というブール値プロパティがあります。saml_autocreate_users_domains enabled (ブール値) と domains (@ 記号なしのドメインのリスト) という 2 つのプロパティがあります。SIGNATURE:
PUT /v1/org/<PUBLIC_ID>
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=axd2s
curl -X PUT \
-H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"settings": {
"saml": {
"enabled": true
},
"saml_strict_mode": {
"enabled": true
},
"saml_idp_initiated_login": {
"enabled": true
},
"saml_autocreate_users_domains": {
"enabled": true,
"domains": [
"my-org.com",
"example.com"
]
}
}
}' \
"https://api.datadoghq.com/api/v1/org/${public_id}"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"org": {
"public_id": "axd2s",
"name": "My Org",
"billing": {},
"created": "2016-10-06 21:41:12",
"settings": {
"saml_can_be_enabled": true,
"saml_idp_initiated_login": {
"enabled": true
},
"saml": {
"enabled": true
},
"saml_idp_endpoint": "https://idp.datadoghq.com/idp/profile/SAML2/POST/SSO",
"saml_autocreate_users_domains": {
"domains": [
"my-org.com",
"example.com"
],
"enabled": true
},
"saml_login_url": "https://app.datadoghq.com/account/login/id/c81e728d9",
"saml_idp_metadata_uploaded": true,
"saml_strict_mode": {
"enabled": true
}
},
"subscription": {
"type": "pro"
}
}
}
現在の SAML IdP から Identity Provider (IdP) メタデータを更新するためのオプションがいくつかあります。
Content-Type: multipart/form-dataidp_file [必須]:
アップロードする XML メタデータファイルのパス。Content-Type: application/xml本文には IdP メタデータ XML ファイルの内容が含まれている必要があります。
SIGNATURE:
POST /v1/org/<PUBLIC_ID>/idp_metadata
EXAMPLE REQUEST:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
public_id=<DD_APP_PUBLIC_ID>
# Upload IdP file using multipart/form-data
curl -X POST \
-H "Content-Type: multipart/form-data" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-F "idp_file=@metadata.xml" \
"https://api.datadoghq.com/api/v1/org/${public_id}/idp_metadata"
# OR
# Upload IdP file using application/xml
curl -X POST \
-H "Content-Type: application/xml" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
--data-binary "@metadata.xml" \
"https://api.datadoghq.com/api/v1/org/${public_id}/idp_metadata"
EXAMPLE RESPONSE:
# This is not yet supported by the Python Client for Datadog API
# Consult the curl example
# This is not yet supported by the Ruby Client for Datadog API
# Consult the curl example
{
"message": "IdP metadata successfully uploaded for org Datadog HQ"
}
Service Level Objectives (or SLOs) are a key part of the site reliability engineering toolkit. SLOs provide a framework for defining clear targets around application performance, which ultimately help teams provide a consistent customer experience, balance feature development with platform stability, and improve communication with internal and external users.
For more information on creating SLOs, see the Configuring Service Level Objectives info.
Create a JSON to define your SLO.
ARGUMENTS:
type [required]:
The type of the SLO, chosen from:| SLO Type | supported value |
|---|---|
| event | metric |
| monitor | monitor |
name [required, default = dynamic, based on query]:
The name of the SLO.description [optional, default = empty]:
A description of the SLO.tags [optional, default = empty list]:
A list of tags to associate with your SLO.thresholds [required]:
A list of Target thresholds, requires at least 1.
timeframe [required]:
The timeframe to apply to the target value. Valid options are 7d, 30d, 90d.target [required]:
The target value to associate with the SLI that defines the SLO.target_displauy [optional, default = dynamic, based on query]:
The target display value that includes the requires level of precision.warning [optional, default = none]:
A warning target value to indicate when the SLI is close to breaching the target.warning_display [optional, default = dynamic, based on query]:
A warning target display value that includes the requires level of precision.For more information, see Monitor SLOs.
monitor_ids [required, default = empty list]:
Specify up to 20 monitor IDs directly for a monitor-based SLO. You can optionally on-create-dynamically select
monitor IDs using the following option instead:groups [optional, default = empty list]:
Note: Only valid on single monitor SLOs Specify the selected groups as a sub query of the selected monitor.There is one type of event based SLO, a metric query. For more information, see Event SLOs.
query [required]:
The query defines the metric-based SLO query. It requires two arguments:
numerator [required]:
Defines the sum of the good eventsdenominator [required]:
Defines the sum of the total events. Note: this should always be >= good eventsSIGNATURE:
POST /v1/slo
EXAMPLE REQUEST:
from datadog import initialize, api
options = {
'api_key': '<YOUR_API_KEY>',
'app_key': '<YOUR_APP_KEY>'
}
initialize(**options)
# Create a new SLO
thresholds = [
{"timeframe": "7d", "target": 95},
{"timeframe": "30d", "target": 95, "warning": 97},
]
tags = ["app:webserver", "frontend"]
api.ServiceLevelObjective.create(
type="metric",
name="Custom Metric SLO",
description="SLO tracking custom service SLO",
query={
"numerator": "sum:my.custom.metric{type:good}.as_count()",
"denominator": "sum:my.custom.metric{*}.as_count()"
},
tags=tags,
thresholds=thresholds
)
require 'rubygems'
require 'dogapi'
api_key = '<YOUR_API_KEY>'
app_key = '<YOUR_APP_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# Create a new SLO
thresholds = [
{:timeframe => "7d", :target => 95},
{:timeframe => "30d", :target => 95, :warning => 97},
]
tags = ['app:webserver', 'frontend']
dog.create_service_level_objective(
:type => "metric",
:name => "Custom Metric SLO",
:description => "SLO tracking custom service SLO",
:numerator => "sum:my.custom.metric{type:good}.as_count()",
:denominator => "sum:my.custom.metric{*}.as_count()",
:tags => tags,
:thresholds => thresholds
)
#!/bin/sh
# Replace the API and APP keys below
# with the ones for your account
api_key=<YOUR_API_KEY>
app_key=<YOUR_APP_KEY>
curl -X POST -H "Content-type: application/json" \
-H "DD-API-KEY: ${api_key}" \
-H "DD-APPLICATION-KEY: ${app_key}" \
-d '{
"type": "monitor",
"name": "Critical Foo Host Uptime",
"description": "Track the uptime of host foo which is critical to the core business.",
"tags": ["app:core", "kpi"],
"monitor_ids": [42],
"thresholds": [
{"timeframe": "30d", "target": 95, "warning": 98}
]
}' \
"https://api.datadoghq.com/api/v1/slo"
EXAMPLE RESPONSE:
{
"data": [
{
"id": "12341234123412341234123412341234",
"description": "Track the uptime of host foo which is critical to the core business.",
"name": "Critical Foo Host Uptime",
"tags": ["app:core", "kpi"],
"type": "monitor",
"type_id": 0,
"monitor_ids": [42],
"thresholds": [
{
"timeframe": "30d",
"target": 95,
"warning": 98
}
],
"creator": {
"handle": "foo",
"email": "foo@foo.example.com",
"id": 42,
},
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T16:34:14.014039+00:00"
}
],
"error": null
}
{
"data": [
{
"id": "12341234123412341234123412341234",
"description": "Track the uptime of host foo which is critical to the core business.",
"name": "Critical Foo Host Uptime",
"tags": ["app:core", "kpi"],
"type": "monitor",
"type_id": 0,
"monitor_ids": [42],
"thresholds": [
{
"timeframe": "30d",
"target": 95,
"warning": 98
}
],
"creator": {
"handle": "foo",
"email": "foo@foo.example.com",
"id": 42,
},
"created": "2015-12-18T16:34:14.014039+00:00",
"modified": "2015-12-18T16:34:14.014039+00:00"
}
],
"error": null
}
{
"data": [
{
"id": "12341234123412341234123412341234",
"description": "Track the uptime of host foo which is critical to the core business.",
"name": "Critical Foo Host Uptime",
"tags": ["app:core", "kpi"],
"type": "monitor",
"type_id": 0,
"monitor_ids": [42],
"thresholds": [
{
"timeframe": "30d",
"target": 95,
"warning": 98
}
],
"creator": {
"handle"