This endpoint is in Preview and may introduce breaking changes.
If you have any feedback, contact Datadog support .
POST https://api.ap1.datadoghq.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.ap2.datadoghq.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.datadoghq.eu/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.ddog-gov.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.us2.ddog-gov.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.uk1.datadoghq.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.datadoghq.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.us3.datadoghq.com/api/unstable/fleet/deployments/{deployment_id}/cancel https://api.us5.datadoghq.com/api/unstable/fleet/deployments/{deployment_id}/cancel
Présentation
Annuler un déploiement actif et arrêter toutes les opérations en attente.
Lorsque vous annulez un déploiement :
Toutes les opérations en attente sur les hosts qui n’ont pas encore démarré sont arrêtées Les opérations en cours sur les hosts peuvent se terminer ou être interrompues, selon leur état actuel Les modifications de configuration ou les mises à niveau de packages déjà appliquées aux hosts ne sont pas annulées Après l’annulation, vous pouvez consulter l’état final du déploiement via l’endpoint GET pour voir quels hosts ont été mis à jour avec succès avant l’annulation.
This endpoint requires
all
of the following permissions:
agent_upgrade_writefleet_policies_writeArguments Paramètres du chemin The unique identifier of the deployment to cancel.
Réponse Deployment successfully canceled.
Bad Request
{
"errors" : [
"Bad Request"
]
} Unauthorized
{
"errors" : [
"Bad Request"
]
} Forbidden
{
"errors" : [
"Bad Request"
]
} Not Found
{
"errors" : [
"Bad Request"
]
} Too many requests
{
"errors" : [
"Bad Request"
]
} Exemple de code Copier
# Path parameters export deployment_id = "abc-def-ghi" # Curl command curl -X POST "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/unstable/fleet/deployments/${deployment_id}/cancel " \
-H "DD-API-KEY: ${DD_API_KEY} " \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY} "
"""
Cancel a deployment returns "Deployment successfully canceled." response
"""
from datadog_api_client import ApiClient , Configuration
from datadog_api_client.v2.api.fleet_automation_api import FleetAutomationApi
configuration = Configuration ()
configuration . unstable_operations [ "cancel_fleet_deployment" ] = True
with ApiClient ( configuration ) as api_client :
api_instance = FleetAutomationApi ( api_client )
api_instance . cancel_fleet_deployment (
deployment_id = "deployment_id" ,
)
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 = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" python3 "example.py"
# Cancel a deployment returns "Deployment successfully canceled." response
require "datadog_api_client"
DatadogAPIClient . configure do | config |
config . unstable_operations [ "v2.cancel_fleet_deployment" . to_sym ] = true
end
api_instance = DatadogAPIClient :: V2 :: FleetAutomationAPI . new
api_instance . cancel_fleet_deployment ( "deployment_id" )
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 = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" rb "example.rb"
// Cancel a deployment returns "Deployment successfully canceled." response
package main
import (
"context"
"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 ()
configuration . SetUnstableOperationEnabled ( "v2.CancelFleetDeployment" , true )
apiClient := datadog . NewAPIClient ( configuration )
api := datadogV2 . NewFleetAutomationApi ( apiClient )
r , err := api . CancelFleetDeployment ( ctx , "deployment_id" )
if err != nil {
fmt . Fprintf ( os . Stderr , "Error when calling `FleetAutomationApi.CancelFleetDeployment`: %v\n" , err )
fmt . Fprintf ( os . Stderr , "Full HTTP response: %v\n" , r )
}
}
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 = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" go run "main.go"
// Cancel a deployment returns "Deployment successfully canceled." response
import com.datadog.api.client.ApiClient ;
import com.datadog.api.client.ApiException ;
import com.datadog.api.client.v2.api.FleetAutomationApi ;
public class Example {
public static void main ( String [] args ) {
ApiClient defaultClient = ApiClient . getDefaultApiClient ();
defaultClient . setUnstableOperationEnabled ( "v2.cancelFleetDeployment" , true );
FleetAutomationApi apiInstance = new FleetAutomationApi ( defaultClient );
try {
apiInstance . cancelFleetDeployment ( "abc-def-ghi" );
} catch ( ApiException e ) {
System . err . println ( "Exception when calling FleetAutomationApi#cancelFleetDeployment" );
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 = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" java "Example.java"
// Cancel a deployment returns "Deployment successfully canceled." response
use datadog_api_client ::datadog ;
use datadog_api_client ::datadogV2 ::api_fleet_automation ::FleetAutomationAPI ;
#[tokio::main]
async fn main () {
let mut configuration = datadog ::Configuration ::new ();
configuration . set_unstable_operation_enabled ( "v2.CancelFleetDeployment" , true );
let api = FleetAutomationAPI ::with_config ( configuration );
let resp = api
. cancel_fleet_deployment ( "deployment_id" . 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 uk1.datadoghq.com ddog-gov.com us2.ddog-gov.com " DD_API_KEY = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" cargo run
/**
* Cancel a deployment returns "Deployment successfully canceled." response
*/
import { client , v2 } from "@datadog/datadog-api-client" ;
const configuration = client . createConfiguration ();
configuration . unstableOperations [ "v2.cancelFleetDeployment" ] = true ;
const apiInstance = new v2 . FleetAutomationApi ( configuration );
const params : v2.FleetAutomationApiCancelFleetDeploymentRequest = {
deploymentId : "deployment_id" ,
};
apiInstance
. cancelFleetDeployment ( params )
. then (( data : any ) => {
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 = "<DD_API_KEY>" DD_APP_KEY = "<DD_APP_KEY>" tsc "example.ts"