이 페이지는 아직 영어로 제공되지 않습니다. 번역 작업 중입니다.
현재 번역 프로젝트에 대한 질문이나 피드백이 있으신 경우 언제든지 연락주시기 바랍니다.

Confluent Cloud

Manage your Datadog Confluent Cloud integration accounts and account resources directly through the Datadog API. See the Confluent Cloud page for more information.

PATCH https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}

개요

Update a Confluent resource with the provided resource id for the account associated with the provided account ID. This endpoint requires the manage_integrations permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

resource_id [required]

string

Confluent Account Resource ID.

요청

Body Data (required)

Confluent payload

Expand All

항목

유형

설명

data [required]

object

JSON:API request for updating a Confluent resource.

attributes [required]

object

Attributes object for updating a Confluent resource.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

The ID associated with a Confluent resource.

type [required]

enum

The JSON:API type for this request. Allowed enum values: confluent-cloud-resources

default: confluent-cloud-resources

{
  "data": {
    "attributes": {
      "enable_custom_metrics": false,
      "resource_type": "kafka",
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "resource-id-123",
    "type": "confluent-cloud-resources"
  }
}

응답

OK

Response schema when interacting with a Confluent resource.

Expand All

항목

유형

설명

data

object

Confluent Cloud resource data.

attributes [required]

object

Model representation of a Confluent Cloud resource.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

The ID associated with the Confluent resource.

type [required]

enum

The JSON:API type for this request. Allowed enum values: confluent-cloud-resources

default: confluent-cloud-resources

{
  "data": {
    "attributes": {
      "enable_custom_metrics": false,
      "id": "resource_id_abc123",
      "resource_type": "kafka",
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "resource_id_abc123",
    "type": "confluent-cloud-resources"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Update resource in Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new

body = DatadogAPIClient::V2::ConfluentResourceRequest.new({
  data: DatadogAPIClient::V2::ConfluentResourceRequestData.new({
    attributes: DatadogAPIClient::V2::ConfluentResourceRequestAttributes.new({
      enable_custom_metrics: false,
      resource_type: "kafka",
      tags: [
        "myTag",
        "myTag2:myValue",
      ],
    }),
    id: "resource-id-123",
    type: DatadogAPIClient::V2::ConfluentResourceType::CONFLUENT_CLOUD_RESOURCES,
  }),
})
p api_instance.update_confluent_resource("account_id", "resource_id", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

GET https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}

개요

Get a Confluent resource with the provided resource id for the account associated with the provided account ID. This endpoint requires the integrations_read permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

resource_id [required]

string

Confluent Account Resource ID.

응답

OK

Response schema when interacting with a Confluent resource.

Expand All

항목

유형

설명

data

object

Confluent Cloud resource data.

attributes [required]

object

Model representation of a Confluent Cloud resource.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

The ID associated with the Confluent resource.

type [required]

enum

The JSON:API type for this request. Allowed enum values: confluent-cloud-resources

default: confluent-cloud-resources

{
  "data": {
    "attributes": {
      "enable_custom_metrics": false,
      "id": "resource_id_abc123",
      "resource_type": "kafka",
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "resource_id_abc123",
    "type": "confluent-cloud-resources"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Get resource from Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new
p api_instance.get_confluent_resource("account_id", "resource_id")

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

DELETE https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}https://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources/{resource_id}

개요

Delete a Confluent resource with the provided resource id for the account associated with the provided account ID. This endpoint requires the manage_integrations permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

resource_id [required]

string

Confluent Account Resource ID.

응답

OK

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Delete resource from Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new
api_instance.delete_confluent_resource("account_id", "resource_id")

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

POST https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources

개요

Create a Confluent resource for the account associated with the provided ID. This endpoint requires the manage_integrations permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

요청

Body Data (required)

Confluent payload

Expand All

항목

유형

설명

data [required]

object

JSON:API request for updating a Confluent resource.

attributes [required]

object

Attributes object for updating a Confluent resource.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

The ID associated with a Confluent resource.

type [required]

enum

The JSON:API type for this request. Allowed enum values: confluent-cloud-resources

default: confluent-cloud-resources

{
  "data": {
    "attributes": {
      "resource_type": "kafka",
      "tags": [
        "myTag",
        "myTag2:myValue"
      ],
      "enable_custom_metrics": false
    },
    "id": "exampleconfluentcloud",
    "type": "confluent-cloud-resources"
  }
}

응답

OK

Response schema when interacting with a Confluent resource.

Expand All

항목

유형

설명

data

object

Confluent Cloud resource data.

attributes [required]

object

Model representation of a Confluent Cloud resource.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

The ID associated with the Confluent resource.

type [required]

enum

The JSON:API type for this request. Allowed enum values: confluent-cloud-resources

default: confluent-cloud-resources

{
  "data": {
    "attributes": {
      "enable_custom_metrics": false,
      "id": "resource_id_abc123",
      "resource_type": "kafka",
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "resource_id_abc123",
    "type": "confluent-cloud-resources"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Add resource to Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new

# there is a valid "confluent_account" in the system
CONFLUENT_ACCOUNT_DATA_ID = ENV["CONFLUENT_ACCOUNT_DATA_ID"]

body = DatadogAPIClient::V2::ConfluentResourceRequest.new({
  data: DatadogAPIClient::V2::ConfluentResourceRequestData.new({
    attributes: DatadogAPIClient::V2::ConfluentResourceRequestAttributes.new({
      resource_type: "kafka",
      tags: [
        "myTag",
        "myTag2:myValue",
      ],
      enable_custom_metrics: false,
    }),
    id: "exampleconfluentcloud",
    type: DatadogAPIClient::V2::ConfluentResourceType::CONFLUENT_CLOUD_RESOURCES,
  }),
})
p api_instance.create_confluent_resource(CONFLUENT_ACCOUNT_DATA_ID, body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

GET https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resourceshttps://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}/resources

개요

Get a Confluent resource for the account associated with the provided ID. This endpoint requires the integrations_read permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

응답

OK

Response schema when interacting with a list of Confluent resources.

Expand All

항목

유형

설명

data

[object]

The JSON:API data attribute.

attributes [required]

object

Model representation of a Confluent Cloud resource.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

The ID associated with the Confluent resource.

type [required]

enum

The JSON:API type for this request. Allowed enum values: confluent-cloud-resources

default: confluent-cloud-resources

{
  "data": [
    {
      "attributes": {
        "enable_custom_metrics": false,
        "id": "resource_id_abc123",
        "resource_type": "kafka",
        "tags": [
          "myTag",
          "myTag2:myValue"
        ]
      },
      "id": "resource_id_abc123",
      "type": "confluent-cloud-resources"
    }
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# List Confluent Account resources returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new
p api_instance.list_confluent_resource("account_id")

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

PATCH https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}

개요

Update the Confluent account with the provided account ID. This endpoint requires the manage_integrations permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

요청

Body Data (required)

Confluent payload

Expand All

항목

유형

설명

data [required]

object

Data object for updating a Confluent account.

attributes [required]

object

Attributes object for updating a Confluent account.

api_key [required]

string

The API key associated with your Confluent account.

api_secret [required]

string

The API secret associated with your Confluent account.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

type [required]

enum

The JSON:API type for this API. Should always be confluent-cloud-accounts. Allowed enum values: confluent-cloud-accounts

default: confluent-cloud-accounts

{
  "data": {
    "attributes": {
      "api_key": "TESTAPIKEY123",
      "api_secret": "update-secret",
      "tags": [
        "updated_tag:val"
      ]
    },
    "type": "confluent-cloud-accounts"
  }
}

응답

OK

The expected response schema when getting a Confluent account.

Expand All

항목

유형

설명

data

object

An API key and API secret pair that represents a Confluent account.

attributes [required]

object

The attributes of a Confluent account.

api_key [required]

string

The API key associated with your Confluent account.

resources

[object]

A list of Confluent resources associated with the Confluent account.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

A randomly generated ID associated with a Confluent account.

type [required]

enum

The JSON:API type for this API. Should always be confluent-cloud-accounts. Allowed enum values: confluent-cloud-accounts

default: confluent-cloud-accounts

{
  "data": {
    "attributes": {
      "api_key": "TESTAPIKEY123",
      "resources": [
        {
          "enable_custom_metrics": false,
          "id": "resource_id_abc123",
          "resource_type": "kafka",
          "tags": [
            "myTag",
            "myTag2:myValue"
          ]
        }
      ],
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "account_id_abc123",
    "type": "confluent-cloud-accounts"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Update Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new

# there is a valid "confluent_account" in the system
CONFLUENT_ACCOUNT_DATA_ATTRIBUTES_API_KEY = ENV["CONFLUENT_ACCOUNT_DATA_ATTRIBUTES_API_KEY"]
CONFLUENT_ACCOUNT_DATA_ID = ENV["CONFLUENT_ACCOUNT_DATA_ID"]

body = DatadogAPIClient::V2::ConfluentAccountUpdateRequest.new({
  data: DatadogAPIClient::V2::ConfluentAccountUpdateRequestData.new({
    attributes: DatadogAPIClient::V2::ConfluentAccountUpdateRequestAttributes.new({
      api_key: CONFLUENT_ACCOUNT_DATA_ATTRIBUTES_API_KEY,
      api_secret: "update-secret",
      tags: [
        "updated_tag:val",
      ],
    }),
    type: DatadogAPIClient::V2::ConfluentAccountType::CONFLUENT_CLOUD_ACCOUNTS,
  }),
})
p api_instance.update_confluent_account(CONFLUENT_ACCOUNT_DATA_ID, body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

GET https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}

개요

Get the Confluent account with the provided account ID. This endpoint requires the integrations_read permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

응답

OK

The expected response schema when getting a Confluent account.

Expand All

항목

유형

설명

data

object

An API key and API secret pair that represents a Confluent account.

attributes [required]

object

The attributes of a Confluent account.

api_key [required]

string

The API key associated with your Confluent account.

resources

[object]

A list of Confluent resources associated with the Confluent account.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

A randomly generated ID associated with a Confluent account.

type [required]

enum

The JSON:API type for this API. Should always be confluent-cloud-accounts. Allowed enum values: confluent-cloud-accounts

default: confluent-cloud-accounts

{
  "data": {
    "attributes": {
      "api_key": "TESTAPIKEY123",
      "resources": [
        {
          "enable_custom_metrics": false,
          "id": "resource_id_abc123",
          "resource_type": "kafka",
          "tags": [
            "myTag",
            "myTag2:myValue"
          ]
        }
      ],
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "account_id_abc123",
    "type": "confluent-cloud-accounts"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Get Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new

# there is a valid "confluent_account" in the system
CONFLUENT_ACCOUNT_DATA_ID = ENV["CONFLUENT_ACCOUNT_DATA_ID"]
p api_instance.get_confluent_account(CONFLUENT_ACCOUNT_DATA_ID)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

DELETE https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}https://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts/{account_id}

개요

Delete a Confluent account with the provided account ID. This endpoint requires the manage_integrations permission.

인수

경로 파라미터

이름

유형

설명

account_id [required]

string

Confluent Account ID.

응답

OK

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Delete Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new

# there is a valid "confluent_account" in the system
CONFLUENT_ACCOUNT_DATA_ID = ENV["CONFLUENT_ACCOUNT_DATA_ID"]
api_instance.delete_confluent_account(CONFLUENT_ACCOUNT_DATA_ID)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

POST https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accountshttps://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accountshttps://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accountshttps://api.datadoghq.com/api/v2/integrations/confluent-cloud/accountshttps://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accountshttps://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts

개요

Create a Confluent account. This endpoint requires the manage_integrations permission.

요청

Body Data (required)

Confluent payload

Expand All

항목

유형

설명

data [required]

object

The data body for adding a Confluent account.

attributes [required]

object

Attributes associated with the account creation request.

api_key [required]

string

The API key associated with your Confluent account.

api_secret [required]

string

The API secret associated with your Confluent account.

resources

[object]

A list of Confluent resources associated with the Confluent account.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with a Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

type [required]

enum

The JSON:API type for this API. Should always be confluent-cloud-accounts. Allowed enum values: confluent-cloud-accounts

default: confluent-cloud-accounts

{
  "data": {
    "attributes": {
      "api_key": "TESTAPIKEY123",
      "api_secret": "test-api-secret-123",
      "resources": [
        {
          "enable_custom_metrics": false,
          "id": "resource-id-123",
          "resource_type": "kafka",
          "tags": [
            "myTag",
            "myTag2:myValue"
          ]
        }
      ],
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "type": "confluent-cloud-accounts"
  }
}

응답

OK

The expected response schema when getting a Confluent account.

Expand All

항목

유형

설명

data

object

An API key and API secret pair that represents a Confluent account.

attributes [required]

object

The attributes of a Confluent account.

api_key [required]

string

The API key associated with your Confluent account.

resources

[object]

A list of Confluent resources associated with the Confluent account.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

A randomly generated ID associated with a Confluent account.

type [required]

enum

The JSON:API type for this API. Should always be confluent-cloud-accounts. Allowed enum values: confluent-cloud-accounts

default: confluent-cloud-accounts

{
  "data": {
    "attributes": {
      "api_key": "TESTAPIKEY123",
      "resources": [
        {
          "enable_custom_metrics": false,
          "id": "resource_id_abc123",
          "resource_type": "kafka",
          "tags": [
            "myTag",
            "myTag2:myValue"
          ]
        }
      ],
      "tags": [
        "myTag",
        "myTag2:myValue"
      ]
    },
    "id": "account_id_abc123",
    "type": "confluent-cloud-accounts"
  }
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# Add Confluent account returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new

body = DatadogAPIClient::V2::ConfluentAccountCreateRequest.new({
  data: DatadogAPIClient::V2::ConfluentAccountCreateRequestData.new({
    attributes: DatadogAPIClient::V2::ConfluentAccountCreateRequestAttributes.new({
      api_key: "TESTAPIKEY123",
      api_secret: "test-api-secret-123",
      resources: [
        DatadogAPIClient::V2::ConfluentAccountResourceAttributes.new({
          enable_custom_metrics: false,
          id: "resource-id-123",
          resource_type: "kafka",
          tags: [
            "myTag",
            "myTag2:myValue",
          ],
        }),
      ],
      tags: [
        "myTag",
        "myTag2:myValue",
      ],
    }),
    type: DatadogAPIClient::V2::ConfluentAccountType::CONFLUENT_CLOUD_ACCOUNTS,
  }),
})
p api_instance.create_confluent_account(body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

GET https://api.ap1.datadoghq.com/api/v2/integrations/confluent-cloud/accountshttps://api.datadoghq.eu/api/v2/integrations/confluent-cloud/accountshttps://api.ddog-gov.com/api/v2/integrations/confluent-cloud/accountshttps://api.datadoghq.com/api/v2/integrations/confluent-cloud/accountshttps://api.us3.datadoghq.com/api/v2/integrations/confluent-cloud/accountshttps://api.us5.datadoghq.com/api/v2/integrations/confluent-cloud/accounts

개요

List Confluent accounts. This endpoint requires the integrations_read permission.

응답

OK

Confluent account returned by the API.

Expand All

항목

유형

설명

data

[object]

The Confluent account.

attributes [required]

object

The attributes of a Confluent account.

api_key [required]

string

The API key associated with your Confluent account.

resources

[object]

A list of Confluent resources associated with the Confluent account.

enable_custom_metrics

boolean

Enable the custom.consumer_lag_offset metric, which contains extra metric tags.

id

string

The ID associated with the Confluent resource.

resource_type [required]

string

The resource type of the Resource. Can be kafka, connector, ksql, or schema_registry.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

tags

[string]

A list of strings representing tags. Can be a single key, or key-value pairs separated by a colon.

id [required]

string

A randomly generated ID associated with a Confluent account.

type [required]

enum

The JSON:API type for this API. Should always be confluent-cloud-accounts. Allowed enum values: confluent-cloud-accounts

default: confluent-cloud-accounts

{
  "data": [
    {
      "attributes": {
        "api_key": "TESTAPIKEY123",
        "resources": [
          {
            "enable_custom_metrics": false,
            "id": "resource_id_abc123",
            "resource_type": "kafka",
            "tags": [
              "myTag",
              "myTag2:myValue"
            ]
          }
        ],
        "tags": [
          "myTag",
          "myTag2:myValue"
        ]
      },
      "id": "account_id_abc123",
      "type": "confluent-cloud-accounts"
    }
  ]
}

Bad Request

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Forbidden

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

항목

유형

설명

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

코드 사례

# List Confluent accounts returns "OK" response

require "datadog_api_client"
api_instance = DatadogAPIClient::V2::ConfluentCloudAPI.new
p api_instance.list_confluent_account()

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"

PREVIEWING: dgreen15/github-error-fix