GET https://api.ap1.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.ap2.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.datadoghq.eu/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.ddog-gov.com/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.us2.ddog-gov.com/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.us3.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid} https://api.us5.datadoghq.com/api/v2/integration/oci/tenancies/{tenancy_ocid}
Overview Get a single tenancy config object by its OCID. Returns detailed configuration including authentication credentials, enabled services, region settings, and collection preferences.
Arguments Path Parameters The OCID of the tenancy config to retrieve.
Response OK
Response containing a single OCI tenancy integration configuration.
Expand All
A single OCI tenancy integration configuration resource object containing the tenancy ID, type, and configuration attributes.
Attributes of an OCI tenancy integration configuration, including authentication details, region settings, and collection options.
The identifier of the billing plan associated with the OCI tenancy.
Version number of the integration the tenancy is integrated with
Whether cost data collection from OCI is enabled for the tenancy.
The OCID of the OCI compartment used by the Datadog integration stack.
The OCID of the OCI Resource Manager stack used by the Datadog integration.
The home region of the OCI tenancy (for example, us-ashburn-1).
Log collection configuration for an OCI tenancy, indicating which compartments and services have log collection enabled.
List of compartment tag filters scoping log collection to specific compartments.
Whether log collection is enabled for the tenancy.
List of OCI service names for which log collection is enabled.
Metrics collection configuration for an OCI tenancy, indicating which compartments and services are included or excluded.
List of compartment tag filters scoping metrics collection to specific compartments.
Whether metrics collection is enabled for the tenancy.
List of OCI service names excluded from metrics collection.
The name of the parent OCI tenancy, if applicable.
Region configuration for an OCI tenancy, indicating which regions are available, enabled, or disabled for data collection.
List of OCI regions available for data collection in the tenancy.
List of OCI regions explicitly disabled for data collection.
List of OCI regions enabled for data collection.
resource_collection_enabled
Whether resource collection from OCI is enabled for the tenancy.
The human-readable name of the OCI tenancy.
The OCID of the OCI user used by the Datadog integration for authentication.
The OCID of the OCI tenancy.
OCI tenancy resource type.
Allowed enum values: oci_tenancy
default: oci_tenancy
{
"data" : {
"attributes" : {
"config_version" : 2 ,
"cost_collection_enabled" : true ,
"dd_compartment_id" : "ocid.compartment.test" ,
"dd_stack_id" : "ocid.stack.test" ,
"home_region" : "us-ashburn-1" ,
"logs_config" : {
"compartment_tag_filters" : [
"compartment.test"
],
"enabled" : true ,
"enabled_services" : [
"compute"
]
},
"metrics_config" : {
"compartment_tag_filters" : [
"compartment.test"
],
"enabled" : true ,
"excluded_services" : [
"compute"
]
},
"regions_config" : {
"available" : [
"us-ashburn-1" ,
"us-phoenix-1"
],
"disabled" : [
"us-phoenix-1"
],
"enabled" : [
"us-ashburn-1"
]
},
"resource_collection_enabled" : true ,
"user_ocid" : "ocid.user.test"
},
"id" : "ocid.tenancy.test" ,
"type" : "oci_tenancy"
}
} Too many requests
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Path parameters export tenancy_ocid = "CHANGE_ME" # Curl command curl -X GET "https://api.ap1.datadoghq.com "https://api.ap2.datadoghq.com "https://api.datadoghq.eu "https://api.ddog-gov.com "https://api.us2.ddog-gov.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/integration/oci/tenancies/${tenancy_ocid} " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Get tenancy config returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.oci_integration_api import OCIIntegrationApi
configuration = Configuration ()
with ApiClient ( configuration ) as api_client :
api_instance = OCIIntegrationApi ( api_client )
response = api_instance . get_tenancy_config (
tenancy_ocid = "tenancy_ocid" ,
)
print ( response )
Instructions First install the library and its dependencies and then save the example to example.py and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Get tenancy config returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient :: V2 :: OCIIntegrationAPI . new
p api_instance . get_tenancy_config ( "tenancy_ocid" )
Instructions First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Get tenancy config returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewOCIIntegrationApi ( apiClient )
resp , r , err := api . GetTenancyConfig ( ctx , "tenancy_ocid" )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `OCIIntegrationApi.GetTenancyConfig`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `OCIIntegrationApi.GetTenancyConfig`:\n%s\n" , responseContent )
}
Instructions First install the library and its dependencies and then save the example to main.go and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Get tenancy config returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.OciIntegrationApi ;
import com.datadog.api.client.v2.model.TenancyConfig ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
OciIntegrationApi apiInstance = new OciIntegrationApi ( defaultClient );
try {
TenancyConfig result = apiInstance . getTenancyConfig ( "tenancy_ocid" );
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling OciIntegrationApi#getTenancyConfig" );
System . err . println ( "Status code: " + e . getCode ());
System . err . println ( "Reason: " + e . getResponseBody ());
System . err . println ( "Response headers: " + e . getResponseHeaders ());
e . printStackTrace ();
}
}
}
Instructions First install the library and its dependencies and then save the example to Example.java and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Get tenancy config returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_oci_integration ::OCIIntegrationAPI ;
#[tokio::main]
async fn main () {
let configuration = datadog ::Configuration ::new ();
let api = OCIIntegrationAPI ::with_config ( configuration );
let resp = api . get_tenancy_config ( "tenancy_ocid" . to_string ()). await ;
if let Ok ( value ) = resp {
println! ( " {:#?} " , value );
} else {
println! ( " {:#?} " , resp . unwrap_err ());
}
}
Instructions First install the library and its dependencies and then save the example to src/main.rs and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Get tenancy config returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
const apiInstance = new v2 . OCIIntegrationApi ( configuration );
const params : v2.OCIIntegrationApiGetTenancyConfigRequest = {
tenancyOcid : "tenancy_ocid" ,
};
apiInstance
. getTenancyConfig ( params )
. then (( data : v2.TenancyConfig ) => {
console . log (
"API called successfully. Returned data: " + JSON . stringify ( data )
);
})
. catch (( error : any ) => console . error ( error ));
Instructions First install the library and its dependencies and then save the example to example.ts and run following commands:
DD_SITE = "datadoghq.com us3.datadoghq.com us5.datadoghq.com datadoghq.eu ap1.datadoghq.com ap2.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"