View a markdown version of this page

GetLabels - Amazon CloudWatch

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.

GetLabels

L'GetLabelsopération renvoie les noms d'étiquette présents dans le magasin de mesures ou renvoie les valeurs d'un nom d'étiquette spécifique.

Verbes HTTP valides

GET, POST pour/api/v1/labels.

GET pour /api/v1/label/label_name/values.

URI valides

/api/v1/labels— renvoie la liste des noms d'étiquettes.

/api/v1/label/label_name/values— renvoie la liste des valeurs pour l'étiquette spécifiée.

L'URL de demande complète combine l'hôte CloudWatch de surveillance de la AWS région avec le chemin de l'opération, par exemplehttps://monitoring.AWS Region.amazonaws.com/api/v1/labels. Pour plus d'informations sur les points de terminaison, la signature et les autorisations IAM requises, consultez. Requête ProMAL

Paramètres de requête d'URL

Les paramètres suivants sont transmis dans la chaîne de requête URL pour les GET demandes, ou sous forme de champs de corps codés par formulaire pour POST les demandes.

Paramètre S’applique à Description

match[]

les deux

Facultatif. Un sélecteur de séries qui limite les séries à prendre en compte lors du calcul du résultat. Les sélecteurs prennent en charge la correspondance exacte (=), la correspondance non égale (!=), la correspondance regex (=~) et la correspondance regex négative (). !~ Spécifiez match[] une ou plusieurs fois pour combiner les sélecteurs. Pour plus d'informations sur la syntaxe du sélecteur, consultezRequête ProMAL.

start

les deux

Facultatif. Début de la plage horaire à prendre en compte, sous forme d'horodatage RFC 3339 ou d'horodatage Unix.

end

les deux

Facultatif. Fin de la plage de temps à prendre en compte, sous forme d'horodatage RFC 3339 ou d'horodatage Unix.

limit

les deux

Facultatif. Nombre maximum d'étiquettes uniques à renvoyer, de 1 à10000. Si vous ne le spécifiez paslimit, CloudWatch renvoie le maximum (10 000). Consultez Limite de résultats.

Autorisations IAM requises

Pour appeler GetLabels sur l'un ou l'autre chemin, l'identité appelante doit avoir l'action IAM suivante :

  • cloudwatch:ListMetrics

Pour le mappage complet des actions IAM pour toutes les opérations ProMQL, voir. Autorisations IAM pour ProMQL

Limite de résultats

Une seule étiquette /api/v1/labels ou une /api/v1/label/label_name/values réponse peut renvoyer jusqu'à 10 000 étiquettes. Pour demander moins de résultats, transmettez le limit paramètre avec une valeur comprise entre 1 et10000. Si vous ne le spécifiez paslimit, CloudWatch renvoie le maximum.

Lorsque les étiquettes correspondantes dépassent le plafond, la réponse est tronquée et un message est inclus dans le champ Prometheus warnings standard. Le code d'état HTTP est conservé200.

Pour la liste complète des limites ProMQL, y compris le TPS, la simultanéité et les fenêtres de numérisation de 24 heures, voir. Limites et restrictions de ProMQL

Exemple de demandes

Répertoriez tous les noms d'étiquettes avec une POST requête et un corps vide :

POST /api/v1/labels HTTP/1.1 Host: monitoring.us-east-1.amazonaws.com Content-Type: application/x-www-form-urlencoded Content-Length: 0 Authorization: AUTHPARAMS X-Amz-Date: 20260605T193725Z User-Agent: awscurl/0.36

Le même appel avec awscurl :

awscurl --service monitoring --region us-east-1 \ -X POST 'https://monitoring.us-east-1.amazonaws.com/api/v1/labels' \ -H 'Content-Type: application/x-www-form-urlencoded'

Répertoriez les noms d'étiquettes correspondant à un sélecteur. Le sélecteur et la plage de temps sont transmis sous forme de champs codés sous forme de formulaire dans le corps de la demande :

awscurl --service monitoring --region us-east-1 \ -X POST 'https://monitoring.us-east-1.amazonaws.com/api/v1/labels' \ -H 'Content-Type: application/x-www-form-urlencoded' \ -d 'match[]={"http.server.active_requests","@aws.region"=~"us-.*"}&start=1780662000&end=1780665600'

Répertoriez les valeurs de l'@resource.service.nameétiquette. Le nom de l'étiquette fait partie du chemin de l'URL et est codé en pourcentage (→)@. %40 Ce chemin prend uniquement en charge GET :

GET /api/v1/label/%40resource.service.name/values HTTP/1.1 Host: monitoring.us-east-1.amazonaws.com Authorization: AUTHPARAMS X-Amz-Date: 20260605T193725Z User-Agent: awscurl/0.36

Le même appel avec awscurl :

awscurl --service monitoring --region us-east-1 \ 'https://monitoring.us-east-1.amazonaws.com/api/v1/label/@resource.service.name/values'

Exemples de réponses

Une réponse réussie utilise l'enveloppe JSON Prometheus standard. Le data champ est un tableau de chaînes.

Réponse pour /api/v1/labels :

HTTP/1.1 200 OK Content-Type: application/json { "status": "success", "data": [ "__name__", "@aws.account", "@aws.region", "@resource.service.name", "@resource.cloud.region", "InstanceId" ] }

Réponse pour /api/v1/label/label_name/values :

HTTP/1.1 200 OK Content-Type: application/json { "status": "success", "data": [ "myservice", "checkout-api", "billing-worker" ] }