Batch rows query
POST
https://api.datadoghq.com/api/v2/reference-tables/queries/batch-rowshttps://api.us3.datadoghq.com/api/v2/reference-tables/queries/batch-rowshttps://api.us5.datadoghq.com/api/v2/reference-tables/queries/batch-rowshttps://api.datadoghq.eu/api/v2/reference-tables/queries/batch-rowshttps://api.ap1.datadoghq.com/api/v2/reference-tables/queries/batch-rowshttps://api.ap2.datadoghq.com/api/v2/reference-tables/queries/batch-rowshttps://api.uk1.datadoghq.com/api/v2/reference-tables/queries/batch-rowshttps://api.ddog-gov.com/api/v2/reference-tables/queries/batch-rowshttps://api.us2.ddog-gov.com/api/v2/reference-tables/queries/batch-rowsPrésentation
Batch query reference table rows by their primary key values. Returns only found rows in the included array.
Requête
Body Data (required)
Champ
Type
Description
dataobject
Data object for a batch rows query request.
attributesobject
Attributes for a batch rows query request.
row_ids [required][string]
List of row identifiers to query from the reference table.
table_id [required]string
Unique identifier of the reference table to query.
type [required]enum
Resource type identifier for batch queries of reference table rows.
reference-tables-batch-rows-queryAllowed enum values:
reference-tables-batch-rows-query{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}Réponse
Successfully retrieved rows. Some or all requested rows were found. Response includes found rows in the included section.
Response object for a batch rows query against a reference table.
Champ
Type
Description
dataobject
Data object for a batch rows query response.
idstring
Unique identifier of the batch query.
relationshipsobject
Relationships of the batch rows query response data.
rowsobject
Relationship data containing the list of matching rows.
data[object]
id [required]string
The primary key value that uniquely identifies the row to delete.
type [required]enum
Row resource type.
rowAllowed enum values:
rowtype [required]enum
Resource type identifier for batch queries of reference table rows.
reference-tables-batch-rows-queryAllowed enum values:
reference-tables-batch-rows-queryincluded[object]
Full row resources matching the query, included alongside the relationship references in data.
attributesobject
Column values for this row in the reference table.
valuesobject
Key-value pairs representing the row data, where keys are field names from the schema.
idstring
Row identifier, corresponding to the primary key value.
type [required]enum
Row resource type.
rowAllowed enum values:
row{
"data": {
"id": "00000000-0000-0000-0000-000000000000",
"relationships": {
"rows": {
"data": [
{
"id": "row_id_1",
"type": "row"
},
{
"id": "row_id_2",
"type": "row"
}
]
}
},
"type": "reference-tables-batch-rows-query"
},
"included": [
{
"attributes": {
"values": {
"ip_address": "102.130.113.9"
}
},
"id": "row_id_1",
"type": "row"
},
{
"attributes": {
"values": {
"ip_address": "102.130.113.10"
}
},
"id": "row_id_2",
"type": "row"
}
]
}Bad Request
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Forbidden
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Not Found
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Too many requests
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Internal Server Error
API error response.
Champ
Type
Description
errors [required][string]
A list of errors.
{
"errors": [
"Bad Request"
]
}Exemple de code
Batch rows query
## default
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF## default
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOF
## Batch query reference table rows by their primary key values.
# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"
curl -X POST "https://api.${DD_SITE}/api/v2/reference-tables/queries/batch-rows" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
"data": {
"attributes": {
"row_ids": [
"row_id_1",
"row_id_2"
],
"table_id": "00000000-0000-0000-0000-000000000000"
},
"type": "reference-tables-batch-rows-query"
}
}
EOFBatch rows query
// Batch rows query returns "Successfully retrieved rows. Some or all requested rows were found. Response includes found
// rows in the included section." 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() {
body := datadogV2.BatchRowsQueryRequest{
Data: &datadogV2.BatchRowsQueryRequestData{
Attributes: &datadogV2.BatchRowsQueryRequestDataAttributes{
RowIds: []string{
"row_id_1",
"row_id_2",
},
TableId: "00000000-0000-0000-0000-000000000000",
},
Type: datadogV2.BATCHROWSQUERYDATATYPE_REFERENCE_TABLES_BATCH_ROWS_QUERY,
},
}
ctx := datadog.NewDefaultContext(context.Background())
ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewReferenceTablesApi(apiClient)
resp, r, err := api.BatchRowsQuery(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ReferenceTablesApi.BatchRowsQuery`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `ReferenceTablesApi.BatchRowsQuery`:\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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"Batch rows query
// Batch rows query returns "Successfully retrieved rows. Some or all requested rows were found.
// Response includes found
// rows in the included section." response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ReferenceTablesApi;
import com.datadog.api.client.v2.model.BatchRowsQueryDataType;
import com.datadog.api.client.v2.model.BatchRowsQueryRequest;
import com.datadog.api.client.v2.model.BatchRowsQueryRequestData;
import com.datadog.api.client.v2.model.BatchRowsQueryRequestDataAttributes;
import com.datadog.api.client.v2.model.BatchRowsQueryResponse;
import java.util.Arrays;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
ReferenceTablesApi apiInstance = new ReferenceTablesApi(defaultClient);
BatchRowsQueryRequest body =
new BatchRowsQueryRequest()
.data(
new BatchRowsQueryRequestData()
.attributes(
new BatchRowsQueryRequestDataAttributes()
.rowIds(Arrays.asList("row_id_1", "row_id_2"))
.tableId("00000000-0000-0000-0000-000000000000"))
.type(BatchRowsQueryDataType.REFERENCE_TABLES_BATCH_ROWS_QUERY));
try {
BatchRowsQueryResponse result = apiInstance.batchRowsQuery(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling ReferenceTablesApi#batchRowsQuery");
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"Batch rows query
"""
Batch rows query returns "Successfully retrieved rows. Some or all requested rows were found. Response includes found
rows in the included section." response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.reference_tables_api import ReferenceTablesApi
from datadog_api_client.v2.model.batch_rows_query_data_type import BatchRowsQueryDataType
from datadog_api_client.v2.model.batch_rows_query_request import BatchRowsQueryRequest
from datadog_api_client.v2.model.batch_rows_query_request_data import BatchRowsQueryRequestData
from datadog_api_client.v2.model.batch_rows_query_request_data_attributes import BatchRowsQueryRequestDataAttributes
body = BatchRowsQueryRequest(
data=BatchRowsQueryRequestData(
attributes=BatchRowsQueryRequestDataAttributes(
row_ids=[
"row_id_1",
"row_id_2",
],
table_id="00000000-0000-0000-0000-000000000000",
),
type=BatchRowsQueryDataType.REFERENCE_TABLES_BATCH_ROWS_QUERY,
),
)
configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
api_instance = ReferenceTablesApi(api_client)
response = api_instance.batch_rows_query(body=body)
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"Batch rows query
# Batch rows query returns "Successfully retrieved rows. Some or all requested rows were found. Response includes found
# rows in the included section." response
require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::ReferenceTablesAPI.new
body = DatadogAPIClient::V2::BatchRowsQueryRequest.new({
data: DatadogAPIClient::V2::BatchRowsQueryRequestData.new({
attributes: DatadogAPIClient::V2::BatchRowsQueryRequestDataAttributes.new({
row_ids: [
"row_id_1",
"row_id_2",
],
table_id: "00000000-0000-0000-0000-000000000000",
}),
type: DatadogAPIClient::V2::BatchRowsQueryDataType::REFERENCE_TABLES_BATCH_ROWS_QUERY,
}),
})
p api_instance.batch_rows_query(body)
Instructions
First install the library and its dependencies and then save the example to example.rb and run following commands:
DD_SITE="datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"Batch rows query
// Batch rows query returns "Successfully retrieved rows. Some or all requested
// rows were found. Response includes found rows in the included section." response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_reference_tables::ReferenceTablesAPI;
use datadog_api_client::datadogV2::model::BatchRowsQueryDataType;
use datadog_api_client::datadogV2::model::BatchRowsQueryRequest;
use datadog_api_client::datadogV2::model::BatchRowsQueryRequestData;
use datadog_api_client::datadogV2::model::BatchRowsQueryRequestDataAttributes;
#[tokio::main]
async fn main() {
let body = BatchRowsQueryRequest::new().data(
BatchRowsQueryRequestData::new(BatchRowsQueryDataType::REFERENCE_TABLES_BATCH_ROWS_QUERY)
.attributes(BatchRowsQueryRequestDataAttributes::new(
vec!["row_id_1".to_string(), "row_id_2".to_string()],
"00000000-0000-0000-0000-000000000000".to_string(),
)),
);
let configuration = datadog::Configuration::new();
let api = ReferenceTablesAPI::with_config(configuration);
let resp = api.batch_rows_query(body).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" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us3.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us5.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="datadoghq.eu" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ap2.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="uk1.datadoghq.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runDD_SITE="us2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo runBatch rows query
/**
* Batch rows query returns "Successfully retrieved rows. Some or all requested rows were found. Response includes found
* rows in the included section." response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration({
authMethods: {
AuthZ: {
accessToken: process.env.DD_BEARER_TOKEN as string,
},
},
});
const apiInstance = new v2.ReferenceTablesApi(configuration);
const params: v2.ReferenceTablesApiBatchRowsQueryRequest = {
body: {
data: {
attributes: {
rowIds: ["row_id_1", "row_id_2"],
tableId: "00000000-0000-0000-0000-000000000000",
},
type: "reference-tables-batch-rows-query",
},
},
};
apiInstance
.batchRowsQuery(params)
.then((data: v2.BatchRowsQueryResponse) => {
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" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us3.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us5.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="datadoghq.eu" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ap2.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="uk1.datadoghq.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"DD_SITE="us2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" tsc "example.ts"