API 참조

Datadog API는 HTTP REST API입니다. API는 리소스 중심의 URL을 사용하여 API를 호출하고, 상태 코드를 사용하여 요청의 성공 또는 실패를 표시하며 모든 요청에서 JSON을 반환하고 표준 HTTP 응답 코드를 사용합니다. Datadog API를 사용하여 프로그래밍 방식으로 Datadog 플랫폼에 접근할 수 있습니다.

시작하기

DD-API-KEY 헤더를 사용하여 API 키로 API를 인증합니다. 일부 엔드포인트의 경우 DD-APPLICATION-KEY 헤더를 사용하는 애플리케이션 키가 필요합니다.

API[Postman에서 실행] 시도해 보기(https://god.gw.postman.com/run-collection/20651290-809b13c1-4ada-46c1-af65-ab276c434068?action=collection%2Ffork&source=rip_markdown&collection-url=entityId%3D20651290-809b13c1-4ada-46c1-af65-ab276c434068%26entityType%3Dcollection%26workspaceId%3Dbf049f54-c695-4e91-b879-0cad1854bafa)

참고: Postman을 통해 Datadog API를 인증하려면 Datadog API와 애플리케이션 키 값을 Datadog API 수집의 수집 변수에 추가해야 합니다.

API 사용하기는 엔드포인트에 대한 가이드입니다.

참고:

  • API 및 애플리케이션 키 값을 Datadog API 수집의 변수 탭에 추가하세요.
  • cURL 코드 예제에서는 BASH 및 GNU coreutils를 사용한다고 가정합니다. macOS에서는 Homebrew 패키지 관리자를 사용하여 coreutils를 설치할 수 있습니다: brew install coreutils

클라이언트 라이브러리

기본적으로 Datadog API 설명서는 cURL로 예제를 보여줍니다. 각 엔드포인트에서 공식 클라이언트 라이브러리 언어 중 하나를 선택하면 해당 라이브러리의 코드 예제를 볼 수 있습니다. 각 라이브러리를 설치하려면:

설치

Maven - 프로젝트의 POM에 이 종속성을 추가합니다:

<dependency>
  <groupId>com.datadoghq</groupId>
  <artifactId>datadog-api-client</artifactId>
  <version>2.26.0</version>
  <scope>compile</scope>
</dependency>

Gradle - 프로젝트의 빌드 파일에 이 종속성을 추가합니다:

compile "com.datadoghq:datadog-api-client:2.26.0"

사용법

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.Configuration;
import com.datadog.api.<VERSION>.client.api.*;
import com.datadog.api.<VERSION>.client.model.*;

참고: 사용할 엔드포인트에 따라 <VERSION>을 v1 또는 v2로 대체합니다.

예시

예시 실행을 위한 Maven pom.xml:

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>example</artifactId>
  <version>1</version>
  <dependencies>
    <dependency>
      <groupId>com.datadoghq</groupId>
      <artifactId>datadog-api-client</artifactId>
      <version>2.26.0</version>
      <scope>compile</scope>
    </dependency>
  </dependencies>
</project>

CLASSPATH 변수에 모든 종속성이 포함되어 있는지 확인합니다.

export CLASSPATH=$(mvn -q exec:exec -Dexec.executable=echo -Dexec.args="%classpath")

예시 실행을 위한 Gradle build.gradle:

plugins {
    id 'java'
    id 'application'
}

repositories {
    jcenter()
}

dependencies {
    implementation 'com.datadoghq:datadog-api-client:2.26.0'
}

application {
    mainClassName = 'Example.java'
}

gradle run 명령을 실행하여 예시를 실행합니다.

설치

pip install datadog

사용법

import datadog

설치

pip3 install datadog-api-client

사용법

import datadog_api_client

설치

gem install dogapi

사용법

require 'dogapi'

설치

gem install datadog_api_client -v 2.24.0

사용법

require 'datadog_api_client'

설치

go mod init main && go get github.com/DataDog/datadog-api-client-go/v2/api/datadog

사용법

import (
        "github.com/DataDog/datadog-api-client-go/v2/api/datadog"
        "github.com/DataDog/datadog-api-client-go/v2/api/datadog<VERSION>"
)

참고: 사용할 엔드포인트에 따라 <VERSION>V1 또는 V2로 대체합니다.

설치

패키지는 @datadog/datadog-api-client 아래에 있으며 NPM 또는 Yarn을 통해 설치할 수 있습니다:

# NPM
npm install @datadog/datadog-api-client

# Yarn
yarn add @datadog/datadog-api-client

사용법

import { <VERSION> } from 'datadog-api-client';

참고: 사용할 엔드포인트에 따라 <VERSION>을 v1 또는 v2로 대체합니다.

또는 라이브러리를 직접 확인하세요:

Java
Python
Ruby
go
go

애플리케이션을 시작하려고 하시나요? Datadog의 시작하기 문서를 확인하세요.

참고 자료

Additional helpful documentation, links, and articles: