When true, the rule excludes the listed tags and indexes all others. When false (default), the rule includes only the listed tags.
ignored_metric_name_matches
[string]
Metric name prefixes excluded from the rule's scope.
metric_name_matches
[string]
Metric name prefixes (glob patterns) this rule applies to.
modified_at
date-time
Timestamp when the rule was last modified.
modified_by_handle
string
Handle of the user who last modified the rule.
name
string
Human-readable name for the rule.
options
object
Versioned configuration options for a tag indexing rule.
data
object
Data payload for tag indexing rule options.
dynamic_tags
object
Configuration for including dynamically queried tags.
queried_tags_window_seconds
int64
Window in seconds for evaluating queried tags.
related_asset_tags
boolean
When true, tags from related assets are included.
manage_preexisting_metrics
boolean
When true, the rule applies to metrics that were ingested before the rule was created.
metric_match
object
Criteria for matching metrics based on query state.
is_queried
boolean
Match metrics that are being queried.
not_queried
boolean
Match metrics that are not being queried.
not_used_in_assets
boolean
Match metrics not used in any dashboards or monitors.
queried_window_seconds
int64
Window in seconds for evaluating query state.
used_in_assets
boolean
Match metrics used in dashboards or monitors.
override_previous_rules
boolean
When true, this rule's tag list overrides tags configured by earlier rules for the same metric. When false (default), tags from all matching rules are combined.
version
int64
Options schema version. Only 1 is supported.
rule_order
int64
Evaluation order within the org. Lower values are evaluated first. Assigned server-side on create (max+1); pass on update to change the rule's position.
tags
[string]
Tag keys managed by this rule.
id
string
The unique identifier (UUID) of the tag indexing rule.
type
enum
The tag indexing rule resource type.
Allowed enum values: tag_indexing_rules
"""
Get a tag indexing rule returns "OK" response
"""fromosimportenvironfromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.metrics_apiimportMetricsApi# there is a valid "tag_indexing_rule" in the systemTAG_INDEXING_RULE_DATA_ID=environ["TAG_INDEXING_RULE_DATA_ID"]configuration=Configuration()configuration.unstable_operations["get_tag_indexing_rule"]=TruewithApiClient(configuration)asapi_client:api_instance=MetricsApi(api_client)response=api_instance.get_tag_indexing_rule(id=TAG_INDEXING_RULE_DATA_ID,)print(response)
# Get a tag indexing rule returns "OK" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.get_tag_indexing_rule".to_sym]=trueendapi_instance=DatadogAPIClient::V2::MetricsAPI.new# there is a valid "tag_indexing_rule" in the systemTAG_INDEXING_RULE_DATA_ID=ENV["TAG_INDEXING_RULE_DATA_ID"]papi_instance.get_tag_indexing_rule(TAG_INDEXING_RULE_DATA_ID)
// Get a tag indexing rule returns "OK" responsepackagemainimport("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")funcmain(){// there is a valid "tag_indexing_rule" in the systemTagIndexingRuleDataID:=os.Getenv("TAG_INDEXING_RULE_DATA_ID")ctx:=datadog.NewDefaultContext(context.Background())configuration:=datadog.NewConfiguration()configuration.SetUnstableOperationEnabled("v2.GetTagIndexingRule",true)apiClient:=datadog.NewAPIClient(configuration)api:=datadogV2.NewMetricsApi(apiClient)resp,r,err:=api.GetTagIndexingRule(ctx,TagIndexingRuleDataID)iferr!=nil{fmt.Fprintf(os.Stderr,"Error when calling `MetricsApi.GetTagIndexingRule`: %v\n",err)fmt.Fprintf(os.Stderr,"Full HTTP response: %v\n",r)}responseContent,_:=json.MarshalIndent(resp,""," ")fmt.Fprintf(os.Stdout,"Response from `MetricsApi.GetTagIndexingRule`:\n%s\n",responseContent)}
// Get a tag indexing rule returns "OK" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.MetricsApi;importcom.datadog.api.client.v2.model.TagIndexingRuleResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.getTagIndexingRule",true);MetricsApiapiInstance=newMetricsApi(defaultClient);// there is a valid "tag_indexing_rule" in the systemStringTAG_INDEXING_RULE_DATA_ID=System.getenv("TAG_INDEXING_RULE_DATA_ID");try{TagIndexingRuleResponseresult=apiInstance.getTagIndexingRule(TAG_INDEXING_RULE_DATA_ID);System.out.println(result);}catch(ApiExceptione){System.err.println("Exception when calling MetricsApi#getTagIndexingRule");System.err.println("Status code: "+e.getCode());System.err.println("Reason: "+e.getResponseBody());System.err.println("Response headers: "+e.getResponseHeaders());e.printStackTrace();}}}
// Get a tag indexing rule returns "OK" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_metrics::MetricsAPI;#[tokio::main]asyncfnmain(){// there is a valid "tag_indexing_rule" in the system
lettag_indexing_rule_data_id=std::env::var("TAG_INDEXING_RULE_DATA_ID").unwrap();letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.GetTagIndexingRule",true);letapi=MetricsAPI::with_config(configuration);letresp=api.get_tag_indexing_rule(tag_indexing_rule_data_id.clone()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* Get a tag indexing rule returns "OK" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.getTagIndexingRule"]=true;constapiInstance=newv2.MetricsApi(configuration);// there is a valid "tag_indexing_rule" in the system
constTAG_INDEXING_RULE_DATA_ID=process.env.TAG_INDEXING_RULE_DATA_IDasstring;constparams: v2.MetricsApiGetTagIndexingRuleRequest={id: TAG_INDEXING_RULE_DATA_ID,};apiInstance.getTagIndexingRule(params).then((data: v2.TagIndexingRuleResponse)=>{console.log("API called successfully. Returned data: "+JSON.stringify(data));}).catch((error: any)=>console.error(error));