Language
Site
サービスチェックエンドポイントを使用すると、モニターで使用するためにチェックステータスを投稿できます。 サービスチェックメッセージは 500 文字に制限されています。 500 文字を超えるメッセージでチェックが投稿された場合、最初の 500 文字のみが表示されます。 メッセージは、Critical または Warning のステータスのチェックに制限されます。
POST https://api.datadoghq.eu/api/v1/check_runhttps://api.ddog-gov.com/api/v1/check_runhttps://api.datadoghq.com/api/v1/check_runhttps://api.us3.datadoghq.com/api/v1/check_runhttps://api.us5.datadoghq.com/api/v1/check_run
サービスチェックのリストを送信します。
注: 有効な API キーが必要です。
サービスチェックのリクエスト本文。
[
{
"check": "app.ok",
"host_name": "host",
"status": 0,
"tags": [
"test:ExampleSubmitaServiceCheckreturnsPayloadacceptedresponse"
]
}
]Payload accepted
The payload accepted for intake.
{
"status": "ok"
}Bad Request
Error response object.
{
"errors": [
"Bad Request"
]
}Authentication Error
Error response object.
{
"errors": [
"Bad Request"
]
}Request timeout
Error response object.
{
"errors": [
"Bad Request"
]
}Payload too large
Error response object.
{
"errors": [
"Bad Request"
]
}Too many requests
Error response object.
{
"errors": [
"Bad Request"
]
}
# Curl command
curl -X POST "https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v1/check_run" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-d @- << EOF
{
"check": "app.ok",
"host_name": "app.host1",
"status": 0,
"tags": [
"environment:test"
]
}
EOF
"""
Submit a Service Check returns "Payload accepted" response
"""
from datadog_api_client.v1 import ApiClient, Configuration
from datadog_api_client.v1.api.service_checks_api import ServiceChecksApi
from datadog_api_client.v1.model.service_check import ServiceCheck
from datadog_api_client.v1.model.service_checks import ServiceChecks
from datadog_api_client.v1.model.service_check_status import ServiceCheckStatus
body = ServiceChecks(
[
ServiceCheck(
check="app.ok",
host_name="host",
status=ServiceCheckStatus(0),
tags=["test:ExampleSubmitaServiceCheckreturnsPayloadacceptedresponse"],
)
]
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = ServiceChecksApi(api_client)
response = api_instance.submit_service_check(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" python3 "example.py"
# Submit a Service Check returns "Payload accepted" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V1::ServiceChecksAPI.new
body = [
DatadogAPIClient::V1::ServiceCheck.new({
check: "app.ok",
host_name: "host",
status: DatadogAPIClient::V1::ServiceCheckStatus::OK,
tags: [
"test:ExampleSubmitaServiceCheckreturnsPayloadacceptedresponse",
],
}),
]
p api_instance.submit_service_check(body)
First install the library and its dependencies and then save the example to example.rb and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"
require 'rubygems'
require 'dogapi'
api_key = '<DATADOG_API_KEY>'
app_key = '<DATADOG_APPLICATION_KEY>'
dog = Dogapi::Client.new(api_key, app_key)
# 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'])
First install the library and its dependencies and then save the example to example.rb and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" rb "example.rb"
/**
* Submit a Service Check returns "Payload accepted" response
*/
import { v1 } from "@datadog/datadog-api-client";
const configuration = v1.createConfiguration();
const apiInstance = new v1.ServiceChecksApi(configuration);
let params: v1.ServiceChecksApiSubmitServiceCheckRequest = {
body: [
{
check: "app.ok",
hostName: "host",
status: 0,
tags: ["test:ExampleSubmitaServiceCheckreturnsPayloadacceptedresponse"],
},
],
};
apiInstance
.submitServiceCheck(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" tsc "example.ts"
// Submit a Service Check returns "Payload accepted" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
datadog "github.com/DataDog/datadog-api-client-go/api/v1/datadog"
)
func main() {
body := []datadog.ServiceCheck{
{
Check: "app.ok",
HostName: "host",
Status: datadog.SERVICECHECKSTATUS_OK,
Tags: []string{
"test:ExampleSubmitaServiceCheckreturnsPayloadacceptedresponse",
},
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceChecksApi.SubmitServiceCheck(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceChecksApi.SubmitServiceCheck`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `ServiceChecksApi.SubmitServiceCheck`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" go run "main.go"
// Submit a Service Check returns "Payload accepted" response
import com.datadog.api.v1.client.ApiClient;
import com.datadog.api.v1.client.ApiException;
import com.datadog.api.v1.client.Configuration;
import com.datadog.api.v1.client.api.ServiceChecksApi;
import com.datadog.api.v1.client.model.IntakePayloadAccepted;
import com.datadog.api.v1.client.model.ServiceCheck;
import com.datadog.api.v1.client.model.ServiceCheckStatus;
import java.time.*;
import java.util.*;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
ServiceChecksApi apiInstance = new ServiceChecksApi(defaultClient);
ArrayList<ServiceCheck> body =
new ArrayList<ServiceCheck>() {
{
add(
new ServiceCheck()
.check("app.ok")
.hostName("host")
.status(ServiceCheckStatus.OK)
.tags(
new ArrayList<String>() {
{
add("test:ExampleSubmitaServiceCheckreturnsPayloadacceptedresponse");
}
}));
}
};
try {
IntakePayloadAccepted result = apiInstance.submitServiceCheck(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ServiceChecksApi#submitServiceCheck");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" java "Example.java"
from datadog import initialize, api
from datadog.api.constants import CheckStatus
options = {'api_key': '<DATADOG_API_KEY>',
'app_key': '<DATADOG_APPLICATION_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)
First install the library and its dependencies and then save the example to example.py and run following commands:
export DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euddog-gov.com" DD_API_KEY="<DD_API_KEY>" python "example.py"