D'autres exemples de AWS SDK sont disponibles dans le référentiel [AWS Doc SDK Examples](https://github.com/awsdocs/aws-doc-sdk-examples) GitHub .
Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.
# Utilisation `DescribeAlarms` avec un AWS SDK ou une CLI
Les exemples de code suivants illustrent comment utiliser `DescribeAlarms`.
Les exemples d’actions sont des extraits de code de programmes de plus grande envergure et doivent être exécutés en contexte. Vous pouvez voir cette action en contexte dans les exemples de code suivants :
+ [Principes de base](cloudwatch_example_cloudwatch_GetStartedMetricsDashboardsAlarms_section.md)
+ [Démarrage des alarmes](cloudwatch_example_cloudwatch_Scenario_GettingStarted_section.md)
------
#### [ .NET ]
**SDK pour .NET (v4)**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/dotnetv4/CloudWatch#code-examples).
```
///
/// Describe the current alarms, optionally filtered by state.
///
/// Optional filter for alarm state.
/// The list of alarm data.
public async Task> DescribeAlarms(StateValue? stateValue = null)
{
List alarms = new List();
var paginatedDescribeAlarms = _amazonCloudWatch.Paginators.DescribeAlarms(
new DescribeAlarmsRequest()
{
StateValue = stateValue
});
await foreach (var data in paginatedDescribeAlarms.MetricAlarms)
{
alarms.Add(data);
}
return alarms;
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeAlarms](https://docs.aws.amazon.com/goto/DotNetSDKV4/monitoring-2010-08-01/DescribeAlarms)à la section *Référence des AWS SDK pour .NET API*.
------
#### [ CLI ]
**AWS CLI**
**Pour répertorier les informations relatives à une alarme**
L’exemple suivant fait appel à la commande `describe-alarms` pour fournir les informations sur l’alarme nommée « myalarm » :
```
aws cloudwatch describe-alarms --alarm-names "myalarm"
```
Sortie :
```
{
"MetricAlarms": [
{
"EvaluationPeriods": 2,
"AlarmArn": "arn:aws:cloudwatch:us-east-1:123456789012:alarm:myalarm",
"StateUpdatedTimestamp": "2014-04-09T18:59:06.442Z",
"AlarmConfigurationUpdatedTimestamp": "2012-12-27T00:49:54.032Z",
"ComparisonOperator": "GreaterThanThreshold",
"AlarmActions": [
"arn:aws:sns:us-east-1:123456789012:myHighCpuAlarm"
],
"Namespace": "AWS/EC2",
"AlarmDescription": "CPU usage exceeds 70 percent",
"StateReasonData": "{\"version\":\"1.0\",\"queryDate\":\"2014-04-09T18:59:06.419+0000\",\"startDate\":\"2014-04-09T18:44:00.000+0000\",\"statistic\":\"Average\",\"period\":300,\"recentDatapoints\":[38.958,40.292],\"threshold\":70.0}",
"Period": 300,
"StateValue": "OK",
"Threshold": 70.0,
"AlarmName": "myalarm",
"Dimensions": [
{
"Name": "InstanceId",
"Value": "i-0c986c72"
}
],
"Statistic": "Average",
"StateReason": "Threshold Crossed: 2 datapoints were not greater than the threshold (70.0). The most recent datapoints: [38.958, 40.292].",
"InsufficientDataActions": [],
"OKActions": [],
"ActionsEnabled": true,
"MetricName": "CPUUtilization"
}
]
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeAlarms](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/cloudwatch/describe-alarms.html)à la section *Référence des AWS CLI commandes*.
------
#### [ Java ]
**SDK pour Java 2.x**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/javav2/example_code/cloudwatch#code-examples).
```
/**
* Describes the CloudWatch alarms of the 'METRIC_ALARM' type.
*
* @return a {@link CompletableFuture} that represents the asynchronous operation
* of describing the CloudWatch alarms. The future completes when the
* operation is finished, either successfully or with an error.
*/
public CompletableFuture describeAlarmsAsync() {
List typeList = new ArrayList<>();
typeList.add(AlarmType.METRIC_ALARM);
DescribeAlarmsRequest alarmsRequest = DescribeAlarmsRequest.builder()
.alarmTypes(typeList)
.maxRecords(10)
.build();
return getAsyncClient().describeAlarms(alarmsRequest)
.thenAccept(response -> {
List alarmList = response.metricAlarms();
for (MetricAlarm alarm : alarmList) {
logger.info("Alarm name: {}", alarm.alarmName());
logger.info("Alarm description: {} ", alarm.alarmDescription());
}
})
.whenComplete((response, ex) -> {
if (ex != null) {
logger.info("Failed to describe alarms: {}", ex.getMessage());
} else {
logger.info("Successfully described alarms.");
}
});
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeAlarms](https://docs.aws.amazon.com/goto/SdkForJavaV2/monitoring-2010-08-01/DescribeAlarms)à la section *Référence des AWS SDK for Java 2.x API*.
------
#### [ Kotlin ]
**SDK pour Kotlin**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/kotlin/services/cloudwatch#code-examples).
```
suspend fun describeAlarms() {
val typeList = ArrayList()
typeList.add(AlarmType.MetricAlarm)
val alarmsRequest =
DescribeAlarmsRequest {
alarmTypes = typeList
maxRecords = 10
}
CloudWatchClient.fromEnvironment { region = "us-east-1" }.use { cwClient ->
val response = cwClient.describeAlarms(alarmsRequest)
response.metricAlarms?.forEach { alarm ->
println("Alarm name: ${alarm.alarmName}")
println("Alarm description: ${alarm.alarmDescription}")
}
}
}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeAlarms](https://sdk.amazonaws.com/kotlin/api/latest/index.html)à la section *AWS SDK pour la référence de l'API Kotlin*.
------
#### [ PowerShell ]
**Outils pour PowerShell V4**
**Exemple 1 : renvoie toutes les alarmes, y compris les alarmes composites et métriques de CloudWatch.**
```
Get-CWAlarm -MaxRecords 1
```
**Sortie** :
```
CompositeAlarms MetricAlarms NextToken
--------------- ------------ ---------
{MetricAlarms-01} NextToken-01
{MetricAlarms-02} NextToken-02
{MetricAlarms-03} NextToken-03
```
**Exemple 2 : renvoie uniquement les données d'alarmes composites CloudWatch après avoir défini le AlarmType paramètre - sur CompositeAlarms.**
```
Get-CWAlarm -AlarmType 'CompositeAlarms'
```
**Sortie** :
```
CompositeAlarms MetricAlarms NextToken
--------------- ------------ ---------
{CompositeAlarms-01}
{CompositeAlarms-02}
{CompositeAlarms-03}
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeAlarms](https://docs.aws.amazon.com/powershell/v4/reference)à la section *Référence des Outils AWS pour PowerShell applets de commande (V4)*.
------
#### [ Ruby ]
**Kit SDK pour Ruby**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/ruby/example_code/cloudwatch#code-examples).
```
require 'aws-sdk-cloudwatch'
# Lists the names of available Amazon CloudWatch alarms.
#
# @param cloudwatch_client [Aws::CloudWatch::Client]
# An initialized CloudWatch client.
# @example
# list_alarms(Aws::CloudWatch::Client.new(region: 'us-east-1'))
def list_alarms(cloudwatch_client)
response = cloudwatch_client.describe_alarms
if response.metric_alarms.count.positive?
response.metric_alarms.each do |alarm|
puts alarm.alarm_name
end
else
puts 'No alarms found.'
end
rescue StandardError => e
puts "Error getting information about alarms: #{e.message}"
end
```
+ Pour plus de détails sur l'API, reportez-vous [DescribeAlarms](https://docs.aws.amazon.com/goto/SdkForRubyV3/monitoring-2010-08-01/DescribeAlarms)à la section *Référence des AWS SDK pour Ruby API*.
------
#### [ SAP ABAP ]
**Kit SDK pour SAP ABAP**
Il y en a plus à ce sujet GitHub. Trouvez l’exemple complet et découvrez comment le configurer et l’exécuter dans le [référentiel d’exemples de code AWS](https://github.com/awsdocs/aws-doc-sdk-examples/tree/main/sap-abap/services/cwt#code-examples).
```
TRY.
oo_result = lo_cwt->describealarms( " oo_result is returned for testing purposes. "
it_alarmnames = it_alarm_names ).
MESSAGE 'Alarms retrieved.' TYPE 'I'.
CATCH /aws1/cx_rt_service_generic INTO DATA(lo_exception).
DATA(lv_error) = |"{ lo_exception->av_err_code }" - { lo_exception->av_err_msg }|.
MESSAGE lv_error TYPE 'E'.
ENDTRY.
```
+ Pour plus de détails sur l'API, consultez [DescribeAlarms](https://docs.aws.amazon.com/sdk-for-sap-abap/v1/api/latest/index.html)la section de référence du *AWS SDK pour l'API SAP ABAP*.
------