Note : This endpoint is in preview and is subject to change.
If you have any feedback, contact Datadog support .
GET https://api.ap1.datadoghq.com/api/v2/org_group_policy_suggestions https://api.ap2.datadoghq.com/api/v2/org_group_policy_suggestions https://api.datadoghq.eu/api/v2/org_group_policy_suggestions https://api.ddog-gov.com/api/v2/org_group_policy_suggestions https://api.us2.ddog-gov.com/api/v2/org_group_policy_suggestions https://api.uk1.datadoghq.com/api/v2/org_group_policy_suggestions https://api.datadoghq.com/api/v2/org_group_policy_suggestions https://api.us3.datadoghq.com/api/v2/org_group_policy_suggestions https://api.us5.datadoghq.com/api/v2/org_group_policy_suggestions
Información general List suggested organization group policies. Requires a filter on org group ID.
This endpoint requires the org_group_read permission.
Argumentos Cadenas de consulta filter[org_group_id] [required ]
Filter policies by org group ID.
Respuesta OK
Response containing a list of org group policy suggestions.
Expand All
An array of org group policy suggestions.
Attributes of an org group policy suggestion.
consensus_ratio [required ]
The ratio of member orgs whose configuration agrees on the recommended value.
The name of the suggested policy.
recommended_value [required ]
The recommended value for the policy, based on member org consensus.
The status of the policy suggestion.
Allowed enum values: pending,accepted,dismissed
The ID of the org group policy suggestion.
Relationships of an org group policy suggestion.
Relationship to a single org group.
A reference to an org group.
Org groups resource type.
Allowed enum values: org_groups
Org group policy suggestions resource type.
Allowed enum values: org_group_policy_suggestions
{
"data" : [
{
"attributes" : {
"consensus_ratio" : 0.75 ,
"policy_name" : "monitor_timezone" ,
"recommended_value" : "UTC" ,
"status" : "pending"
},
"id" : "1a2b3c4d-5e6f-7890-abcd-ef0123456789" ,
"relationships" : {
"org_group" : {
"data" : {
"id" : "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ,
"type" : "org_groups"
}
}
},
"type" : "org_group_policy_suggestions"
}
]
} Bad Request
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Unauthorized
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Forbidden
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
Short human-readable summary of the error.
{
"errors" : [
{
"detail" : "Missing required attribute in body" ,
"meta" : {},
"source" : {
"header" : "Authorization" ,
"parameter" : "limit" ,
"pointer" : "/data/attributes/title"
},
"status" : "400" ,
"title" : "Bad Request"
}
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Ejemplo de código Copia
# Required query arguments export filter[org_group_id] = "a1b2c3d4-e5f6-7890-abcd-ef0123456789" # 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.uk1.datadoghq.com "https://api.datadoghq.com "https://api.us3.datadoghq.com "https://api.us5.datadoghq.com /api/v2/org_group_policy_suggestions ? filter[org_group_id] = ${filter[org_group_id]} " \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
List org group policy suggestions returns "OK" response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.org_groups_api import OrgGroupsApi
from uuid import UUID
configuration = Configuration ()
configuration . unstable_operations [ "list_org_group_policy_suggestions" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = OrgGroupsApi ( api_client )
response = api_instance . list_org_group_policy_suggestions (
filter_org_group_id = UUID ( "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ),
)
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" python3 "example.py"
# List org group policy suggestions returns "OK" response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.list_org_group_policy_suggestions" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: OrgGroupsAPI . new
p api_instance . list_org_group_policy_suggestions ( "a1b2c3d4-e5f6-7890-abcd-ef0123456789" )
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" rb "example.rb"
// List org group policy suggestions 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"
"github.com/google/uuid"
)
func main () {
ctx := datadog . NewDefaultContext ( context . Background ())
configuration := datadog . NewConfiguration ()
configuration . SetUnstableOperationEnabled ( "v2.ListOrgGroupPolicySuggestions" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewOrgGroupsApi ( apiClient )
resp , r , err := api . ListOrgGroupPolicySuggestions ( ctx , uuid . MustParse ( "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ))
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `OrgGroupsApi.ListOrgGroupPolicySuggestions`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
responseContent , _ := json . MarshalIndent ( resp , "" , " " )
fmt . Fprintf ( os . Stdout , "Response from `OrgGroupsApi.ListOrgGroupPolicySuggestions`:\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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" go run "main.go"
// List org group policy suggestions returns "OK" response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.OrgGroupsApi ;
import com.datadog.api.client.v2.model.OrgGroupPolicySuggestionListResponse ;
import java.util.UUID ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.listOrgGroupPolicySuggestions" , true );
OrgGroupsApi apiInstance = new OrgGroupsApi ( defaultClient );
try {
OrgGroupPolicySuggestionListResponse result =
apiInstance . listOrgGroupPolicySuggestions (
UUID . fromString ( "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ));
System . out . println ( result );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling OrgGroupsApi#listOrgGroupPolicySuggestions" );
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" java "Example.java"
// List org group policy suggestions returns "OK" response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_org_groups ::OrgGroupsAPI ;
use uuid ::Uuid ;
#[tokio::main]
async fn main () {
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.ListOrgGroupPolicySuggestions" , true );
let api = OrgGroupsAPI ::with_config ( configuration );
let resp = api
. list_org_group_policy_suggestions (
Uuid ::parse_str ( "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ). expect ( "invalid UUID" ),
)
. 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" cargo run
/**
* List org group policy suggestions returns "OK" response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.listOrgGroupPolicySuggestions" ] = true ;
const apiInstance = new v2 . OrgGroupsApi ( configuration );
const params : v2.OrgGroupsApiListOrgGroupPolicySuggestionsRequest = {
filterOrgGroupId : "a1b2c3d4-e5f6-7890-abcd-ef0123456789" ,
};
apiInstance
. listOrgGroupPolicySuggestions ( params )
. then (( data : v2.OrgGroupPolicySuggestionListResponse ) => {
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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<API-KEY>" DD_APP_KEY = "<APP-KEY>" tsc "example.ts"