- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
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.
Confluent payload
항목
유형
설명
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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)
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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")
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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")
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.
Confluent payload
항목
유형
설명
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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)
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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")
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.
Confluent payload
항목
유형
설명
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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)
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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)
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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)
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.
Confluent payload
항목
유형
설명
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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)
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.
항목
유형
설명
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.
{
"errors": [
"Bad Request"
]
}
Forbidden
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"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()
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"