Crear una alerta de métrica
curl --request POST \
--url https://telemetry.{region}.basaltic.sh/v1/alerts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"topic": "<string>",
"expression": {
"metric": "<string>",
"scale": 500000000000,
"match": [
"<string>"
],
"by": [
"<string>"
],
"unit": "<string>"
},
"threshold": 123,
"window_seconds": 1830,
"for_seconds": 43200,
"enabled": true,
"silenced_until": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://telemetry.{region}.basaltic.sh/v1/alerts"
payload = {
"name": "<string>",
"topic": "<string>",
"expression": {
"metric": "<string>",
"scale": 500000000000,
"match": ["<string>"],
"by": ["<string>"],
"unit": "<string>"
},
"threshold": 123,
"window_seconds": 1830,
"for_seconds": 43200,
"enabled": True,
"silenced_until": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
topic: '<string>',
expression: {
metric: '<string>',
scale: 500000000000,
match: ['<string>'],
by: ['<string>'],
unit: '<string>'
},
threshold: 123,
window_seconds: 1830,
for_seconds: 43200,
enabled: true,
silenced_until: '2023-11-07T05:31:56Z'
})
};
fetch('https://telemetry.{region}.basaltic.sh/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://telemetry.{region}.basaltic.sh/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'topic' => '<string>',
'expression' => [
'metric' => '<string>',
'scale' => 500000000000,
'match' => [
'<string>'
],
'by' => [
'<string>'
],
'unit' => '<string>'
],
'threshold' => 123,
'window_seconds' => 1830,
'for_seconds' => 43200,
'enabled' => true,
'silenced_until' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://telemetry.{region}.basaltic.sh/v1/alerts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"topic\": \"<string>\",\n \"expression\": {\n \"metric\": \"<string>\",\n \"scale\": 500000000000,\n \"match\": [\n \"<string>\"\n ],\n \"by\": [\n \"<string>\"\n ],\n \"unit\": \"<string>\"\n },\n \"threshold\": 123,\n \"window_seconds\": 1830,\n \"for_seconds\": 43200,\n \"enabled\": true,\n \"silenced_until\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://telemetry.{region}.basaltic.sh/v1/alerts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"topic\": \"<string>\",\n \"expression\": {\n \"metric\": \"<string>\",\n \"scale\": 500000000000,\n \"match\": [\n \"<string>\"\n ],\n \"by\": [\n \"<string>\"\n ],\n \"unit\": \"<string>\"\n },\n \"threshold\": 123,\n \"window_seconds\": 1830,\n \"for_seconds\": 43200,\n \"enabled\": true,\n \"silenced_until\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://telemetry.{region}.basaltic.sh/v1/alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"topic\": \"<string>\",\n \"expression\": {\n \"metric\": \"<string>\",\n \"scale\": 500000000000,\n \"match\": [\n \"<string>\"\n ],\n \"by\": [\n \"<string>\"\n ],\n \"unit\": \"<string>\"\n },\n \"threshold\": 123,\n \"window_seconds\": 1830,\n \"for_seconds\": 43200,\n \"enabled\": true,\n \"silenced_until\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"alert": {
"expression": {
"metric": "<string>",
"agg": "avg",
"scale": 500000000000,
"match": [
"<string>"
],
"by": [
"<string>"
],
"denominator": {
"metric": "<string>",
"agg": "avg",
"match": [
"<string>"
],
"by": [
"<string>"
]
},
"unit": "<string>"
},
"operator": "gt",
"threshold": 123,
"window_seconds": 1830,
"for_seconds": 43200,
"enabled": true,
"silenced_until": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:telemetry:sa-saopaulo-1:my-account:alert/high-cpu",
"name": "<string>",
"topic": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"state": "ok",
"last_value": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"evaluated_at": "2023-11-07T05:31:56Z",
"state_changed_at": "2023-11-07T05:31:56Z",
"pending_since": "2023-11-07T05:31:56Z",
"evaluation_error": "<string>",
"delivery_error": "<string>"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Alertas
Crear una alerta de métrica
Crea una delegación persistente para leer métricas y publicar notificaciones. Requiere telemetry:CreateAlert en la alerta nombrada, telemetry:ReadMetrics en la cuenta y notifications:Publish en el tema seleccionado. Las transiciones de disparo y resolución usan las suscripciones confirmadas de correo, webhook y cola del tema. Los eventos se almacenan atómicamente con los cambios de estado y se reintentan con IDs de mensaje estables. Los datos ausentes y los errores de evaluación son estados visibles, no notificaciones de recuperación.
POST
/
v1
/
alerts
Crear una alerta de métrica
curl --request POST \
--url https://telemetry.{region}.basaltic.sh/v1/alerts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"topic": "<string>",
"expression": {
"metric": "<string>",
"scale": 500000000000,
"match": [
"<string>"
],
"by": [
"<string>"
],
"unit": "<string>"
},
"threshold": 123,
"window_seconds": 1830,
"for_seconds": 43200,
"enabled": true,
"silenced_until": "2023-11-07T05:31:56Z"
}
'import requests
url = "https://telemetry.{region}.basaltic.sh/v1/alerts"
payload = {
"name": "<string>",
"topic": "<string>",
"expression": {
"metric": "<string>",
"scale": 500000000000,
"match": ["<string>"],
"by": ["<string>"],
"unit": "<string>"
},
"threshold": 123,
"window_seconds": 1830,
"for_seconds": 43200,
"enabled": True,
"silenced_until": "2023-11-07T05:31:56Z"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
topic: '<string>',
expression: {
metric: '<string>',
scale: 500000000000,
match: ['<string>'],
by: ['<string>'],
unit: '<string>'
},
threshold: 123,
window_seconds: 1830,
for_seconds: 43200,
enabled: true,
silenced_until: '2023-11-07T05:31:56Z'
})
};
fetch('https://telemetry.{region}.basaltic.sh/v1/alerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://telemetry.{region}.basaltic.sh/v1/alerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'topic' => '<string>',
'expression' => [
'metric' => '<string>',
'scale' => 500000000000,
'match' => [
'<string>'
],
'by' => [
'<string>'
],
'unit' => '<string>'
],
'threshold' => 123,
'window_seconds' => 1830,
'for_seconds' => 43200,
'enabled' => true,
'silenced_until' => '2023-11-07T05:31:56Z'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://telemetry.{region}.basaltic.sh/v1/alerts"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"topic\": \"<string>\",\n \"expression\": {\n \"metric\": \"<string>\",\n \"scale\": 500000000000,\n \"match\": [\n \"<string>\"\n ],\n \"by\": [\n \"<string>\"\n ],\n \"unit\": \"<string>\"\n },\n \"threshold\": 123,\n \"window_seconds\": 1830,\n \"for_seconds\": 43200,\n \"enabled\": true,\n \"silenced_until\": \"2023-11-07T05:31:56Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://telemetry.{region}.basaltic.sh/v1/alerts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"topic\": \"<string>\",\n \"expression\": {\n \"metric\": \"<string>\",\n \"scale\": 500000000000,\n \"match\": [\n \"<string>\"\n ],\n \"by\": [\n \"<string>\"\n ],\n \"unit\": \"<string>\"\n },\n \"threshold\": 123,\n \"window_seconds\": 1830,\n \"for_seconds\": 43200,\n \"enabled\": true,\n \"silenced_until\": \"2023-11-07T05:31:56Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://telemetry.{region}.basaltic.sh/v1/alerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"topic\": \"<string>\",\n \"expression\": {\n \"metric\": \"<string>\",\n \"scale\": 500000000000,\n \"match\": [\n \"<string>\"\n ],\n \"by\": [\n \"<string>\"\n ],\n \"unit\": \"<string>\"\n },\n \"threshold\": 123,\n \"window_seconds\": 1830,\n \"for_seconds\": 43200,\n \"enabled\": true,\n \"silenced_until\": \"2023-11-07T05:31:56Z\"\n}"
response = http.request(request)
puts response.read_body{
"alert": {
"expression": {
"metric": "<string>",
"agg": "avg",
"scale": 500000000000,
"match": [
"<string>"
],
"by": [
"<string>"
],
"denominator": {
"metric": "<string>",
"agg": "avg",
"match": [
"<string>"
],
"by": [
"<string>"
]
},
"unit": "<string>"
},
"operator": "gt",
"threshold": 123,
"window_seconds": 1830,
"for_seconds": 43200,
"enabled": true,
"silenced_until": "2023-11-07T05:31:56Z",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"crn": "crn:telemetry:sa-saopaulo-1:my-account:alert/high-cpu",
"name": "<string>",
"topic": {
"id": "288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"crn": "crn:catalog::platform:country/288aa1e9-bbf5-5584-bce9-6a688f06d8a1",
"name": "Brazil"
},
"state": "ok",
"last_value": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"evaluated_at": "2023-11-07T05:31:56Z",
"state_changed_at": "2023-11-07T05:31:56Z",
"pending_since": "2023-11-07T05:31:56Z",
"evaluation_error": "<string>",
"delivery_error": "<string>"
}
}{
"error": {
"code": "INVALID_INPUT",
"message": "Invalid request parameters",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication required",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "ACCESS_DENIED",
"message": "You don't have permission to perform this action",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Resource not found",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "CONFLICT",
"message": "Resource with this name already exists",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "An internal error occurred",
"request_id": "550e8400-e29b-41d4-a716-446655440000"
}
}Autorizaciones
Un token bearer de OAuth 2.0, enviado como Authorization: Bearer <token>. Esta es la forma recomendada de autenticación.
Obtén el token intercambiando el par de claves de acceso de una cuenta de servicio en POST /v1/oauth/token con grant_type=client_credentials. Es el flujo estándar de credenciales de cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar el token por ti.
curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
https://iam.basaltic.sh/v1/oauth/token
Los tokens duran una hora por defecto. El mismo par de claves de acceso también sirve como credencial AWS SigV4 para el endpoint de objetos compatible con S3, que solo acepta ese método de autenticación.
Encabezados
Clave opcional generada por el cliente que hace que una creación sea segura para la reproducción. Al volver a intentar una solicitud con la misma clave, se devuelve el resultado original literalmente en lugar de crear un recurso duplicado. Se rechaza la reutilización de una clave con un cuerpo de solicitud diferente (422); una solicitud cuya clave todavía se está procesando devuelve 409. Los registros se mantienen durante 24 horas. Usa un UUID o un token único similar.
Maximum string length:
255Cuerpo
application/json
Nombre inmutable y único en la cuenta. Los nombres UUID y el prefijo crn: están reservados.
Required string length:
1 - 128Pattern:
^[a-zA-Z0-9][a-zA-Z0-9._-]{0,127}$Referencia obligatoria a un tema de notificación de la misma cuenta y región: UUID, CRN canónico o nombre exacto, clasificado por sintaxis. Varias alertas pueden compartir un tema. La vinculación requiere notifications:Publish y respeta las denegaciones explícitas de la política del tema.
Show child attributes
Show child attributes
Opciones disponibles:
gt, gte, lt, lte Ventana de minutos enteros. Se evalúa cada minuto usando la última ventana completa alineada con UTC.
Rango requerido:
60 <= x <= 3600Debe ser un múltiplo de 60Duración continua del incumplimiento antes del disparo; 0 dispara inmediatamente. Los datos ausentes, los fallos de consulta y los intervalos sin evaluación reinician la duración pendiente.
Rango requerido:
0 <= x <= 86400Debe ser un múltiplo de 60Silencia las notificaciones hasta este instante (como máximo 30 días en el futuro). La evaluación continúa; null elimina el silencio. Una alerta activa notifica en la siguiente evaluación después de que expire el silencio.
Respuesta
Crear una alerta de métrica
Show child attributes
Show child attributes