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.
# Référence d'API Amazon Managed Service pour Prometheus
Amazon Managed Service for Prometheus propose deux types de : APIs
1. **Amazon Managed Service for APIs Prometheus** : ils vous APIs permettent de créer et de gérer vos espaces de travail Amazon Managed Service for Prometheus, y compris les opérations relatives aux espaces de travail, aux scrapers, aux définitions du gestionnaire d'alertes, aux espaces de noms des groupes de règles et à la journalisation. Vous utilisez le AWS SDKs, disponible pour différents langages de programmation, pour interagir avec ceux-ci APIs.
1. **Compatible avec Prometheus APIs** — Amazon Managed Service for Prometheus prend en charge les protocoles HTTP compatibles avec Prometheus. APIs Ils APIs permettent de créer des applications personnalisées, d'automatiser les flux de travail, de s'intégrer à d'autres services ou outils, et d'interroger et d'interagir avec vos données de surveillance à l'aide du langage de requête Prometheus (ProMQL).
Cette section répertorie les opérations et structures de données des API prises en charge par Amazon Managed Service for Prometheus.
Pour plus d'informations sur les quotas pour les séries, les étiquettes et les demandes d'API, consultez les quotas de service [Amazon Managed Service for Prometheus dans le guide de l'utilisateur](https://docs.aws.amazon.com/prometheus/latest/userguide/AMP_quotas.html) d'*Amazon Managed Service for Prometheus*.
**Topics**
+ [Amazon Managed Service pour Prometheus APIs](AMP-APIReference-AMPApis.md)
+ [Compatible avec Prometheus APIs](AMP-APIReference-Prometheus-Compatible-Apis.md)
# Amazon Managed Service pour Prometheus APIs
Amazon Managed Service for Prometheus fournit des opérations d'API permettant de créer et de gérer vos espaces de travail Amazon Managed Service for Prometheus. Cela inclut APIs les espaces de travail, les scrapers, les définitions du gestionnaire d'alertes, les groupes de règles, les espaces de noms et la journalisation.
Pour obtenir des informations détaillées sur l'Amazon Managed Service for APIs Prometheus, consultez le manuel [Amazon Managed Service for Prometheus](https://docs.aws.amazon.com/prometheus/latest/APIReference/Welcome.html) API Reference.
## Utilisation d'Amazon Managed Service pour Prometheus avec un SDK AWS
AWS des kits de développement logiciel (SDKs) sont disponibles pour de nombreux langages de programmation courants. Chaque SDK fournit une API, des exemples de code et une documentation qui permettent aux développeurs de créer plus facilement AWS des applications dans leur langue préférée. Pour une liste des outils par langue SDKs et des outils, consultez la section [Outils sur lesquels vous pouvez vous appuyer AWS](https://aws.amazon.com/developer/tools/) dans le AWS *Developer Center*.
**Versions du SDK**
Nous vous recommandons d'utiliser la version la plus récente du AWS SDK, ainsi que toute autre SDKs version que vous utilisez dans vos projets, et de la maintenir SDKs à jour. Le AWS SDK vous fournit les fonctionnalités les plus récentes, ainsi que des mises à jour de sécurité.
# Compatible avec Prometheus APIs
Amazon Managed Service for Prometheus prend en charge les versions compatibles Prometheus suivantes. APIs
Pour plus d'informations sur l'utilisation de la compatibilité avec Prometheus, consultez. APIs [Requête utilisant Prometheus-compatible APIs](AMP-onboard-query-APIs.md)
**Topics**
+ [CreateAlertManagerAlerts](AMP-APIReference-CreateAlertManagerAlerts.md)
+ [DeleteAlertManagerSilence](AMP-APIReference-DeleteSilence.md)
+ [GetAlertManagerStatus](AMP-APIReference-GetAlertManagerStatus.md)
+ [GetAlertManagerSilence](AMP-APIReference-GetAlertManagerSilence.md)
+ [GetLabels](AMP-APIReference-GetLabels.md)
+ [GetMetricMetadata](AMP-APIReference-GetMetricMetadata.md)
+ [GetSeries](AMP-APIReference-GetSeries.md)
+ [ListAlerts](AMP-APIReference-ListAlerts.md)
+ [ListAlertManagerAlerts](AMP-APIReference-ListAlertManagerAlerts.md)
+ [ListAlertManagerAlertGroups](AMP-APIReference-ListAlertManagerAlertGroups.md)
+ [ListAlertManagerReceivers](AMP-APIReference-ListAlertManagerReceivers.md)
+ [ListAlertManagerSilences](AMP-APIReference-ListAlertManagerSilences.md)
+ [ListRules](AMP-APIReference-ListRules.md)
+ [PutAlertManagerSilences](AMP-APIReference-PutAlertManagerSilences.md)
+ [QueryMetrics](AMP-APIReference-QueryMetrics.md)
+ [RemoteWrite](AMP-APIReference-RemoteWrite.md)
# CreateAlertManagerAlerts
L’opération `CreateAlertManagerAlerts` crée une alerte dans l’espace de travail.
Verbes HTTP valides :
`POST`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/alerts`
Paramètres de requête d’URL :
`alerts` Tableau d’objets, dans lequel chaque objet représente une alerte. Voici un exemple d’objet d’alerte :
```
[
{
"startsAt": "2021-09-24T17:14:04.995Z",
"endsAt": "2021-09-24T17:14:04.995Z",
"annotations": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"labels": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"generatorURL": "string"
}
]
```
**Exemple de demande**
```
POST /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/alerts HTTP/1.1
Content-Length: 203,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
[
{
"labels": {
"alertname": "test-alert"
},
"annotations": {
"summary": "this is a test alert used for demo purposes"
},
"generatorURL": "https://www.amazon.com/"
}
]
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 0
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
```
# DeleteAlertManagerSilence
`DeleteSilence` supprime un silence d’alerte.
Verbes HTTP valides :
`DELETE`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/silence/silenceID`
Paramètres de requête d’URL : aucun
**Exemple de demande**
```
DELETE /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/silence/d29d9df3-9125-4441-912c-70b05f86f973 HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 0
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
```
# GetAlertManagerStatus
`GetAlertManagerStatus` récupère des informations sur le statut du gestionnaire d’alertes.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/status`
Paramètres de requête d’URL : aucun
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/status HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 941
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"cluster": null,
"config": {
"original": "global:\n resolve_timeout: 5m\n http_config:\n follow_redirects: true\n smtp_hello: localhost\n smtp_require_tls: true\nroute:\n receiver: sns-0\n group_by:\n - label\n continue: false\nreceivers:\n- name: sns-0\n sns_configs:\n - send_resolved: false\n http_config:\n follow_redirects: true\n sigv4: {}\n topic_arn: arn:aws:sns:us-west-2:123456789012:test\n subject: '{{ template \"sns.default.subject\" . }}'\n message: '{{ template \"sns.default.message\" . }}'\n workspace_arn: arn:aws:aps:us-west-2:123456789012:workspace/ws-58a6a446-5ec4-415b-9052-a449073bbd0a\ntemplates: []\n"
},
"uptime": null,
"versionInfo": null
}
```
# GetAlertManagerSilence
`GetAlertManagerSilence` récupère des informations sur un silence d’alerte.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/silence/silenceID`
Paramètres de requête d’URL : aucun
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/silence/d29d9df3-9125-4441-912c-70b05f86f973 HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 310
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"id": "d29d9df3-9125-4441-912c-70b05f86f973",
"status": {
"state": "active"
},
"updatedAt": "2021-10-22T19:32:11.763Z",
"comment": "hello-world",
"createdBy": "test-person",
"endsAt": "2023-07-24T01:05:36.000Z",
"matchers": [
{
"isEqual": true,
"isRegex": true,
"name": "job",
"value": "hello"
}
],
"startsAt": "2021-10-22T19:32:11.763Z"
}
```
# GetLabels
L’opération `GetLabels` récupère les étiquettes associées à une série temporelle.
Verbes HTTP valides :
`GET`, `POST`
Valide URIs :
`/workspaces/workspaceId/api/v1/labels`
`/workspaces/workspaceId/api/v1/label/label-name/values` Cette URI ne prend en charge que les requêtes GET.
Paramètres de requête d’URL :
`match[]=` Argument de sélecteur de série répété qui sélectionne la série à partir de laquelle lire les noms d’étiquette. Facultatif.
`start=` Horodatage de départ. Facultatif.
`end=` Horodatage de fin. Facultatif.
**Exemple de requête pour `/workspaces/workspaceId/api/v1/labels`**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/labels HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse pour `/workspaces/workspaceId/api/v1/labels`**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 1435
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"status": "success",
"data": [
"__name__",
"access_mode",
"address",
"alertname",
"alertstate",
"apiservice",
"app",
"app_kubernetes_io_instance",
"app_kubernetes_io_managed_by",
"app_kubernetes_io_name",
"area",
"beta_kubernetes_io_arch",
"beta_kubernetes_io_instance_type",
"beta_kubernetes_io_os",
"boot_id",
"branch",
"broadcast",
"buildDate",
...
]
}
```
**Exemple de requête pour `/workspaces/workspaceId/api/v1/label/label-name/values`**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/label/access_mode/values HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse pour `/workspaces/workspaceId/api/v1/label/label-name/values`**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 74
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"status": "success",
"data": [
"ReadWriteOnce"
]
}
```
# GetMetricMetadata
L’opération `GetMetricMetadata` récupère des métadonnées sur les métriques actuellement extraites des cibles. Elle ne fournit aucune information cible.
La section des données du résultat de la requête se compose d’un objet dans lequel chaque clé est un nom de métrique et chaque valeur est une liste d’objets de métadonnées uniques, telles qu’exposées pour ce nom de métrique sur toutes les cibles.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/api/v1/metadata`
Paramètres de requête d’URL :
`limit=` Nombre maximal de métriques à renvoyer.
`metric=` Nom de la métrique pour laquelle filtrer les métadonnées. Si vous laissez ce champ vide, toutes les métadonnées de métriques sont récupérées.
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/metadata HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
Transfer-Encoding: chunked
{
"status": "success",
"data": {
"aggregator_openapi_v2_regeneration_count": [
{
"type": "counter",
"help": "[ALPHA] Counter of OpenAPI v2 spec regeneration count broken down by causing APIService name and reason.",
"unit": ""
}
],
...
}
}
```
# GetSeries
L’opération `GetSeries` récupère la liste des séries temporelles qui correspondent à un ensemble d’étiquettes donné.
Verbes HTTP valides :
`GET`, `POST`
Valide URIs :
`/workspaces/workspaceId/api/v1/series`
Paramètres de requête d’URL :
`match[]=` Argument de sélecteur de série répété qui sélectionne la série à renvoyer. Vous devez fournir au moins un argument `match[]`.
`start=` Horodatage de départ. Facultatif
`end=` Horodatage de fin. Facultatif
**Exemple de demande**
```
POST /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/series --data-urlencode 'match[]=node_cpu_seconds_total{app="prometheus"}' --data-urlencode 'start=1634936400' --data-urlencode 'end=1634939100' HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
content-encoding: gzip
{
"status": "success",
"data": [
{
"__name__": "node_cpu_seconds_total",
"app": "prometheus",
"app_kubernetes_io_managed_by": "Helm",
"chart": "prometheus-11.12.1",
"cluster": "cluster-1",
"component": "node-exporter",
"cpu": "0",
"heritage": "Helm",
"instance": "10.0.100.36:9100",
"job": "kubernetes-service-endpoints",
"kubernetes_name": "servicesstackprometheuscf14a6d7-node-exporter",
"kubernetes_namespace": "default",
"kubernetes_node": "ip-10-0-100-36.us-west-2.compute.internal",
"mode": "idle",
"release": "servicesstackprometheuscf14a6d7"
},
{
"__name__": "node_cpu_seconds_total",
"app": "prometheus",
"app_kubernetes_io_managed_by": "Helm",
"chart": "prometheus-11.12.1",
"cluster": "cluster-1",
"component": "node-exporter",
"cpu": "0",
"heritage": "Helm",
"instance": "10.0.100.36:9100",
"job": "kubernetes-service-endpoints",
"kubernetes_name": "servicesstackprometheuscf14a6d7-node-exporter",
"kubernetes_namespace": "default",
"kubernetes_node": "ip-10-0-100-36.us-west-2.compute.internal",
"mode": "iowait",
"release": "servicesstackprometheuscf14a6d7"
},
...
]
}
```
# ListAlerts
L’opération `ListAlerts` récupère les alertes actuellement actives dans l’espace de travail.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/api/v1/alerts`
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/alerts HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 386
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"status": "success",
"data": {
"alerts": [
{
"labels": {
"alertname": "test-1.alert",
"severity": "none"
},
"annotations": {
"message": "message"
},
"state": "firing",
"activeAt": "2020-12-01T19:37:25.429565909Z",
"value": "1e+00"
}
]
},
"errorType": "",
"error": ""
}
```
# ListAlertManagerAlerts
`ListAlertManagerAlerts` récupère des informations sur les alertes en cours dans le gestionnaire d’alertes de l’espace de travail.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/alerts`
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/alerts HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 354
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
[
{
"annotations": {
"summary": "this is a test alert used for demo purposes"
},
"endsAt": "2021-10-21T22:07:31.501Z",
"fingerprint": "375eab7b59892505",
"receivers": [
{
"name": "sns-0"
}
],
"startsAt": "2021-10-21T22:02:31.501Z",
"status": {
"inhibitedBy": [],
"silencedBy": [],
"state": "active"
},
"updatedAt": "2021-10-21T22:02:31.501Z",
"labels": {
"alertname": "test-alert"
}
}
]
```
# ListAlertManagerAlertGroups
L’opération `ListAlertManagerAlertGroups` récupère la liste des groupes d’alertes configurés dans le gestionnaire d’alertes de l’espace de travail.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/alerts/groups`
Paramètres de requête d’URL :
Booléen `active`. Si la valeur est true, la liste renvoyée inclut les alertes actives. Par défaut, la valeur est true. Facultatif
Booléen `silenced`. Si la valeur est true, la liste renvoyée inclut les alertes silencieuses. Par défaut, la valeur est true. Facultatif
Booléen `inhibited`. Si la valeur est true, la liste renvoyée inclut les alertes bloquées. Par défaut, la valeur est true. Facultatif
`filter` Tableau de chaînes. Liste d’analyseurs permettant de filtrer les alertes. Facultatif
`receiver` Chaîne. Expression régulière correspondant aux récepteurs pour filtrer les alertes. Facultatif
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/alerts/groups HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 443
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
[
{
"alerts": [
{
"annotations": {
"summary": "this is a test alert used for demo purposes"
},
"endsAt": "2021-10-21T22:07:31.501Z",
"fingerprint": "375eab7b59892505",
"receivers": [
{
"name": "sns-0"
}
],
"startsAt": "2021-10-21T22:02:31.501Z",
"status": {
"inhibitedBy": [],
"silencedBy": [],
"state": "unprocessed"
},
"updatedAt": "2021-10-21T22:02:31.501Z",
"generatorURL": "https://www.amazon.com/",
"labels": {
"alertname": "test-alert"
}
}
],
"labels": {},
"receiver": {
"name": "sns-0"
}
}
]
```
# ListAlertManagerReceivers
L’opération `ListAlertManagerReceivers` récupère des informations sur les récepteurs configurés dans le gestionnaire d’alertes.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/receivers`
Paramètres de requête d’URL : aucun
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/receivers HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 19
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
[
{
"name": "sns-0"
}
]
```
# ListAlertManagerSilences
L’opération `ListAlertManagerSilences` récupère des informations sur les silences d’alerte configurés dans l’espace de travail.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/silences`
**Exemple de demande**
```
GET /workspaces/ws-58a6a446-5ec4-415b-9052-a449073bbd0a/alertmanager/api/v2/silences HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 312
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
[
{
"id": "d29d9df3-9125-4441-912c-70b05f86f973",
"status": {
"state": "active"
},
"updatedAt": "2021-10-22T19:32:11.763Z",
"comment": "hello-world",
"createdBy": "test-person",
"endsAt": "2023-07-24T01:05:36.000Z",
"matchers": [
{
"isEqual": true,
"isRegex": true,
"name": "job",
"value": "hello"
}
],
"startsAt": "2021-10-22T19:32:11.763Z"
}
]
```
# ListRules
`ListRules` récupère des informations sur les règles configurées dans l’espace de travail.
Verbes HTTP valides :
`GET`
Valide URIs :
`/workspaces/workspaceId/api/v1/rules`
**Exemple de demande**
```
GET /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/rules HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 423
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"status": "success",
"data": {
"groups": [
{
"name": "test-1.rules",
"file": "test-rules",
"rules": [
{
"name": "record:1",
"query": "sum(rate(node_cpu_seconds_total[10m:1m]))",
"labels": {},
"health": "ok",
"lastError": "",
"type": "recording",
"lastEvaluation": "2021-10-21T21:22:34.429565909Z",
"evaluationTime": 0.001005399
}
],
"interval": 60,
"lastEvaluation": "2021-10-21T21:22:34.429563992Z",
"evaluationTime": 0.001010504
}
]
},
"errorType": "",
"error": ""
}
```
# PutAlertManagerSilences
L’opération `PutAlertManagerSilences` crée un nouveau silence d’alerte ou met à jour un silence existant.
Verbes HTTP valides :
`POST`
Valide URIs :
`/workspaces/workspaceId/alertmanager/api/v2/silences`
Paramètres de requête d’URL :
`silence` Objet qui représente le silence. En voici le format :
```
{
"id": "string",
"matchers": [
{
"name": "string",
"value": "string",
"isRegex": Boolean,
"isEqual": Boolean
}
],
"startsAt": "timestamp",
"endsAt": "timestamp",
"createdBy": "string",
"comment": "string"
}
```
**Exemple de demande**
```
POST /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/alertmanager/api/v2/silences HTTP/1.1
Content-Length: 281,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
{
"matchers":[
{
"name":"job",
"value":"up",
"isRegex":false,
"isEqual":true
}
],
"startsAt":"2020-07-23T01:05:36+00:00",
"endsAt":"2023-07-24T01:05:36+00:00",
"createdBy":"test-person",
"comment":"test silence"
}
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 53
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
{
"silenceID": "512860da-74f3-43c9-8833-cec026542b32"
}
```
# QueryMetrics
L’opération `QueryMetrics` évalue une requête instantanée à un moment donné ou sur une période donnée.
Verbes HTTP valides :
`GET`, `POST`
Valide URIs :
`/workspaces/workspaceId/api/v1/query` Cet URI évalue une requête instantanée à un moment donné.
`/workspaces/workspaceId/api/v1/query_range` Cet URI évalue une requête instantanée sur une période donnée.
Paramètres de requête d’URL :
`query=` Chaîne de requête d’expression Prometheus. Utilisée à la fois dans `query` et `query_range`.
`time=` (Facultatif) Horodatage d’évaluation si vous utilisez `query` pour une requête instantanée à un moment donné.
`timeout=` (Facultatif) Délai d’évaluation. La valeur par défaut est définie et plafonnée par la valeur de l’indicateur `-query.timeout`. Utilisée à la fois dans `query` et `query_range`.
`start=` Démarrez l’horodatage si vous utilisez `query_range` pour effectuer des requêtes sur un intervalle de temps.
`end=` Arrêtez l’horodatage si vous utilisez `query_range` pour effectuer des requêtes sur un intervalle de temps.
`step=` Interrogez la durée de l’étape de résolution sous forme de `duration` ou sous forme d’un nombre `float` de secondes. À utiliser uniquement si vous utilisez `query_range` pour effectuer des requêtes sur un intervalle de temps, et nécessaire pour ce type de requêtes.
`max_samples_processed_warning_threshold=`(Facultatif) Définit le seuil d'avertissement pour les échantillons de requêtes traités (QSP). Lorsque les requêtes atteignent ce seuil, un message d'avertissement est renvoyé dans la réponse de l'API.
`max_samples_processed_error_threshold=>`(Facultatif) Définit le seuil d'erreur pour les échantillons de requêtes traités (QSP). Les requêtes dépassant ce seuil seront rejetées avec une erreur et ne seront pas facturées. Utilisé pour éviter des coûts de requête excessifs.
**Durée**
Une `duration` dans une API compatible avec Prometheus est un nombre, suivi immédiatement de l’une des unités suivantes :
+ `ms` millisecondes
+ `s` secondes
+ `m` minutes
+ `h` heures
+ `d` jours, en supposant qu’un jour compte toujours 24 heures
+ `w` semaines, en supposant qu’une semaine compte toujours 7 jours
+ `y` années, en supposant qu’une année compte toujours 365 jours
**Exemple de demande**
```
POST /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/query?query=sum(node_cpu_seconds_total) HTTP/1.1
Content-Length: 0,
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Grafana/8.1.0
```
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length: 132
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
content-encoding: gzip
{
"status": "success",
"data": {
"resultType": "vector",
"result": [
{
"metric": {},
"value": [
1634937046.322,
"252590622.81000024"
]
}
]
}
}
```
# RemoteWrite
L’opération `RemoteWrite` écrit les métriques d’un serveur Prometheus sur une URL distante dans un format normalisé. Généralement, vous utilisez un client existant tel qu’un serveur Prometheus pour appeler cette opération.
Verbes HTTP valides :
`POST`
Valide URIs :
`/workspaces/workspaceId/api/v1/remote_write`
Paramètres de requête d’URL :
Aucune
`RemoteWrite` a un taux d’ingestion de 70 000 échantillons par seconde et une taille de rafale d’ingestion de 1 000 000 échantillons.
**Exemple de demande**
```
POST /workspaces/ws-b226cc2a-a446-46a9-933a-ac50479a5568/api/v1/remote_write --data-binary "@real-dataset.sz" HTTP/1.1
Authorization: AUTHPARAMS
X-Amz-Date: 20201201T193725Z
User-Agent: Prometheus/2.20.1
Content-Type: application/x-protobuf
Content-Encoding: snappy
X-Prometheus-Remote-Write-Version: 0.1.0
body
```
**Note**
Pour la syntaxe du corps de la requête, reportez-vous à la définition de la mémoire tampon du protocole à l'adresse [ https://github.com/prometheus/prometheus/blob/1c624c58ca934f618be737b4995e22051f5724c1/prompb/remote.pb.go \$1L64.](https://github.com/prometheus/prometheus/blob/1c624c58ca934f618be737b4995e22051f5724c1/prompb/remote.pb.go#L64)
**Exemple de réponse**
```
HTTP/1.1 200 OK
x-amzn-RequestId: 12345678-abcd-4442-b8c5-262b45e9b535
Content-Length:0
Connection: keep-alive
Date: Tue, 01 Dec 2020 19:37:25 GMT
Content-Type: application/json
Server: amazon
vary: Origin
```