Gerenciando Assinaturas

Use as APIs de gerenciamento de assinaturas para gerenciar a entrega de dados de telemetria ao seu coletor de dados.

Pré-requisitos

Antes de chamar as APIs de Gerenciamento de Assinaturas, consulte Configuração do Coletor de Dados para configurar um tipo de coletor de sua escolha.
Para criar assinaturas, você precisa ter a função Fabric Stream Subscription Manager (STREAM_SUBSCRIPTION PERMISSION CREATE AND READ). Entre em contato com o administrador da sua empresa ou com o administrador do IAM para gerenciar o acesso e as funções.
Se você estiver usando a API, envie suas credenciais de usuário, ID do cliente e segredo do cliente para autenticação OAuth2. Consulte Autenticação da API para obter mais informações sobre como autenticar suas solicitações à API da Equinix.

Criando uma assinatura

Portal
API

O portal oferece suporte à criação e ao gerenciamento de assinaturas do Splunk, Datadog, Microsoft Teams e PagerDuty.

Faça login no [Portal do Cliente > Painel de Controle do Fabric.
No menu Observabilidade, selecione Fluxos de Dados.
No menu suspenso Ações, selecione Adicionar Assinaturas.
Selecione o coletor de dados para sua Assinatura no menu suspenso. Consulte os exemplos abaixo para ver os coletores de dados suportados.

Para criar uma assinatura, envie uma solicitar POST para o endpoint /fabric/v4/streams/<streamId>/subscriptions. Especifique o ID do fluxo no objeto stream e as configurações do seu coletor de dados e informações de autenticação no objeto sink no corpo da solicitar.

Consulte os exemplos abaixo para criar uma assinatura de fluxo para os coletores de dados suportados.

observação

Os valores de URI/host da API de assinatura suporte apenas HTTPS e não suporte certificados autoassinados.

Datadog

Portal
API

Na página Adicionar Assinatura, insira suas informações do Datadog, incluindo:

um nome de assinatura
URL do seu host Datadog
sua chave de API do Datadog
sua chave de aplicação Datadog
e forneça uma descrição (opcional)

Adding a Datadog Subscription Dialog Screenshot

Use [a tabela de referência do site Datadog para encontrar o parâmetro do seu site para o parâmetro sink.host.

Exemplo de solicitação cURL:

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
  "type": "STREAM_SUBSCRIPTION",
  "name": "<datadog_subscription_name>",
  "description": "<datadog_subscription_desc>",
  "sink": {
    "host": "https://<datadog_site_parameter>",
    "type": "DATADOG",
    "credential": {
      "type": "API_KEY",
      "apiKey": "<datadog_api_key>"
    },
    "settings": {
      "applicationKey": "<datadog_application_key>"
    }
  }
}'

Exemplo de resposta:

{
  "href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/1a39648d-c407-4470-b08b-454965f31bf4",
  "uuid": "1a39648d-c407-4470-b08b-454965f31bf4",
  "type": "STREAM_SUBSCRIPTION",
  "name": "datadog_subscription",
  "description": "datadog_subscription_desc",
  "state": "PROVISIONED",
  "enabled": true,
  "sink": {
    "host": "https://<datadog_site_parameter>",
    "type": "DATADOG",
    "credential": {
      "type": "API_KEY",
      "apiKey": "<encrypted_datadog_api_key>"
    },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5,
    "settings": {
      "metricUri": "https://<datadog_site_parameter>/api/v2/series",
      "eventUri": "https://<datadog_site_parameter>/api/v1/events"
    }
  },
  "changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-10-07T06:48:45.861755Z",
    "updatedDateTime": "2024-10-07T06:48:51.514474Z"
  }
}

Google PubSub

Portal
API

Na página Adicionar Assinatura, insira suas informações do Google Cloud PubSub, incluindo:

Nome da assinatura
Token de acesso do Google Cloud PubSub
URI de assinatura do Google Cloud PubSub
E forneça uma descrição (opcional)

curl -X POST 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
    "type": "STREAM_SUBSCRIPTION",
    "name": "<gcp_pubsub_subscription_name>",
    "description": "<gcp_pubsub_subscription_desc>",
    "sink": {
    "uri": "https://pubsub.googleapis.com/v1/projects/<gcp_project_name>/topics/<gcp_topic_name>:publish",
    "type": "GOOGLE_PUBSUB",
    "credential": {
        "type": "ACCESS_TOKEN",
        "accessToken": "<encoded_base64_service_account_json>"
    }
    }
}'

Exemplo de resposta:

{
"href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/12190e7d-a486-4a77-ba56-fecdab616837",
"uuid": "12190e7d-a486-4a77-ba56-fecdab616837",
"type": "STREAM_SUBSCRIPTION",
"name": "<gcp_pubsub_subscription_name>",
"description": "<gcp_pubsub_subscription_desc>",
"state": "PROVISIONED",
"enabled": true,
"sink": {
    "uri": "https://pubsub.googleapis.com/v1/projects/<gcp_project_name>/topics/<gcp_topic_name>:publish",
    "type": "GOOGLE_PUBSUB",
    "credential": {
    "type": "ACCESS_TOKEN"
    },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5
},
"changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2025-04-28T21:23:02.006057019Z"
}
}

Webhook do Grafana

observação

O Webhook do Grafana suporta apenas o formato Open Telemetry.

Portal
API

Na página Adicionar Assinatura, insira suas informações do Grafana, incluindo:

Nome da assinatura.
O URI de métricas do Grafana.
O URI de eventos do Grafana.
Sua chave de API do Grafana.
Descrição opcional.

Exemplo de solicitação cURL:

curl -X POST 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
"type": "STREAM_SUBSCRIPTION",
"name": "<webhook_subscription_name>",
"description": "<webhook_subscription_desc>",
"enabled": true,
"sink": {
    "type": "WEBHOOK"
    "settings": {
    "eventUri": "https://<grafana_oltp_endpoint>/otlp/v1/logs",
    "metricUri": "https://<grafana_oltp_endpoint>/otlp/v1/metrics",
    "format": "OPENTELEMETRY"
    },
    "credential": {
    "type": "API_KEY",
    "apiKey": "<granfana_instance_id>:<grafana_api_key>",
    }
}
}'

Exemplo de resposta:

{
"href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/1a39648d-c407-4470-b08b-454965f31bf4",
"uuid": "1a39648d-c407-4470-b08b-454965f31bf4",
"type": "STREAM_SUBSCRIPTION",
"name": "datadog_subscription",
"description": "datadog_subscription_desc",
"state": "PROVISIONED",
"enabled": true,
"sink": {
    "host": "https://<datadog_site_parameter>",
    "type": "DATADOG",
    "credential": {
    "type": "API_KEY",
    "apiKey": "<encrypted_datadog_api_key>"
    },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5,
    "settings": {
    "metricUri": "https://<datadog_site_parameter>/api/v2/series",
    "eventUri": "https://<datadog_site_parameter>/api/v1/events"
    }
},
"changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-10-07T06:48:45.861755Z",
    "updatedDateTime": "2024-10-07T06:48:51.514474Z"
}
}

Equipes da Microsoft

Portal
API

Na página Adicionar assinatura, insira suas informações do Microsoft Teams, incluindo:

um nome de assinatura
URI do seu webhook do Microsoft Workflow
e forneça uma descrição (opcional)

Adding a Microsoft Teams Subscription Dialog Screenshot

Exemplo de solicitação cURL:

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
  "type": "STREAM_SUBSCRIPTION",
  "name": "<ms_teams_subscription>",
  "description": "<ms_teams_subscription_desc>",
  "sink": {
    "uri": "<teams_webhook_uri>",
    "type": "TEAMS"
  }
}'

Exemplo de resposta:

{
  "href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/12190e7d-a486-4a77-ba56-fecdab616837",
  "uuid": "12190e7d-a486-4a77-ba56-fecdab616837",
  "type": "STREAM_SUBSCRIPTION",
  "name": "ms_teams_subscription",
  "description": "ms_teams_subscription_desc",
  "state": "PROVISIONED",
  "enabled": true,
  "sink": {
    "uri": "****",
    "type": "TEAMS",
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5
  },
  "changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-10-04T13:20:40.127727Z"
  }
}

PagerDuty

Portal
API

Na página Adicionar Assinatura, insira suas informações do PagerDuty, incluindo:

um nome de assinatura
URL do seu host do PagerDuty
sua chave de integração do PagerDuty
e forneça uma descrição (opcional)

Adding a Pagerduty Subscription Dialog Screenshot

Exemplo de solicitação cURL:

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
  "type": "STREAM_SUBSCRIPTION",
  "name": "<pagerduty_subscription_name>",
  "description": "<pagerduty_subscription_desc>",
  "sink": {
    "host": "https://events.pagerduty.com",
    "type": "PAGERDUTY",
    "credential": {
      "type": "INTEGRATION_KEY",
      "integrationKey": "<pagerduty_integration_key>"
    }
  }
}'

Exemplo de resposta:

{
  "href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/dae0726a-87f0-4c5f-8662-ccbcf44a0de2",
  "uuid": "dae0726a-87f0-4c5f-8662-ccbcf44a0de2",
  "type": "STREAM_SUBSCRIPTION",
  "name": "pagerduty-subscription",
  "description": "pagerduty-subscription-desc",
  "state": "PROVISIONED",
  "enabled": true,
  "sink": {
    "host": "https://events.pagerduty.com",
    "type": "PAGERDUTY",
    "credential": {
      "type": "INTEGRATION_KEY",
      "integrationKey": "<encrypted_integration_key>"
    },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5,
    "settings": {
      "source": "equinix",
      "changeUri": "https://events.pagerduty.com/v2/change/enqueue",
      "alertUri": "https://events.pagerduty.com/v2/enqueue"
    }
  },
  "changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-09-18T22:04:58.664523Z"
  }
}

ServiceNow

Portal
API

Na página Adicionar Assinatura, insira suas informações do ServiceNow, incluindo:

Nome da assinatura.
O URL do host do ServiceNow.
Seu nome de usuário do ServiceNow.
Sua senha do ServiceNow.
Descrição opcional.

Exemplo de solicitação cURL:

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
"type": "STREAM_SUBSCRIPTION",
"name": "<servicenow_subscription_name>",
"description": "<servicenow_subscription_desc>",
"sink": {
    "host": "https://<host>.service-now.com",
    "type": "SERVICENOW",
    "settings": {
    "source": "<source_name>"
    },
    "credential": {
    "type": "USERNAME_PASSWORD",
    "username": "<servicenow-username>",
    "password": "<servicenow-password>"
    }
}
}'

Exemplo de resposta:

{
"href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/9b503760-b30f-4eb8-a681-aab1cfa9db1f",
"uuid": "9b503760-b30f-4eb8-a681-aab1cfa9db1f",
"type": "STREAM_SUBSCRIPTION",
"name": "servnow_subscription",
"description": "servnow_subscription_desc",
"state": "PROVISIONING",
"enabled": true,
"sink": {
    "host": "https://<host>.service-now.com",
    "type": "SERVICENOW",
    "credential": {
    "type": "USERNAME_PASSWORD"
    },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5,
    "settings": {
    "source": "source_name",
    "metricUri": "https://<host>.service-now.com/api/mid/sa/metrics",
    "eventUri": "https://<host>.service-now.com/api/global/em/jsonv2"
    }
},
"changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2025-01-22T18:09:20.894582046Z"
}
}

Slack

Portal
API

Na página Adicionar Assinatura, insira suas informações do Slack, incluindo:

Nome da assinatura
URI de assinatura
Descrição (opcional)

Exemplo de solicitação cURL:

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
"type": "STREAM_SUBSCRIPTION",
"name": "<slack_subscription_name>",
"description": "<slack_subscription_desc>",
"sink": {
    "uri": "<slack_webhook_uri>",
    "type": "SLACK"
}
}'

Exemplo de resposta:

{
"href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/12190e7d-a486-4a77-ba56-fecdab616837",
"uuid": "12190e7d-a486-4a77-ba56-fecdab616837",
"type": "STREAM_SUBSCRIPTION",
"name": "slack_subscription",
"description": "slack_subscription_desc",
"state": "PROVISIONED",
"enabled": true,
"sink": {
    "uri": "****",
    "type": "SLACK",
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5
},
"changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-10-04T13:20:40.127727Z"
}
}

Splunk

Portal
API

Na página Adicionar Assinatura, insira suas informações do Splunk, incluindo:

um nome de assinatura
seu URI do coletor de eventos HTTP do Splunk
seu token de acesso Splunk
seu Índice de Eventos Splunk (obrigatório)
seu Índice de Métricas do Splunk, se você planeja ingerir métricas no Splunk
e forneça uma descrição (opcional)

Adding a Splunk Subscription Dialog Screenshot

Exemplo de solicitação cURL:

curl -X 'POST' 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
  "type": "STREAM_SUBSCRIPTION",
  "name": "<splunk_subscription_name>",
  "description": "<splunk_subscription_desc>",
  "sink": {
    "uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event"
    "type": "SPLUNK_HEC",
    "settings": {
      "eventIndex": "<name_of_eventIndex>",
      "metricIndex": "<name_of_metricIndex>",
      "source": "<name_of_splunk_hec>"
    },
    "credential": {
      "type": "ACCESS_TOKEN",
      "accessToken": "Splunk <Splunk AccessToken>"
    }
  }
}'

Exemplo de resposta:

{
  "href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/958a9854-dc49-4ded-87bd-be4d0099355e",
  "uuid": "958a9854-dc49-4ded-87bd-be4d0099355e",
  "type": "STREAM_SUBSCRIPTION",
  "name": "eq-splunk ",
  "description": "subscription1",
  "state": "PROVISIONING",
  "enabled": true,
  "sink": {
    "uri": "https://http-inputs-<host>.splunkcloud.com:<port>/services/collector/event",
    "type": "SPLUNK_HEC",
    "credential": {
      "type": "ACCESS_TOKEN"
    },
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5,
    "settings": {
      "eventIndex": "<name_of_eventIndex>",
      "metricIndex": "<name_of_metricIndex>",
      "source": "<name_of_splunk_hec>"
    }
  },
  "changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-08-12T21:49:21.761029359Z"
  }
}

Webhook genérico

Crie uma assinatura para qualquer serviço genérico de webhook para eventos e métricas. Especifique o tipo de destino como webhook.

Você deve incluir um URI de evento ou um URI de métrica. Para transmitir eventos e métricas, é necessário fornecer ambos. Se você fornecer apenas um desses campos, somente o tipo de dados correspondente (eventos ou métricas) será enviado para a plataforma de destino.

Portal
API

Na página Adicionar Assinatura, insira suas informações de Webhook, incluindo:

Nome da assinatura
Selecione o formato CloudEvent ou o formato Open Telemetry para seus dados de streaming.
O URI do evento
O URI da métrica
Selecione um tipo de autenticação entre as opções Sem autenticação, Nome de usuário/Senha, Token de acesso ou Chave de API. Insira as informações relevantes nos campos fornecidos.
E forneça uma descrição (opcional).

Exemplo de solicitação cURL:

curl -X POST 'https://api.equinix.com/fabric/v4/streams/<streamId>/subscriptions' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>' \
-d '{
  "type": "STREAM_SUBSCRIPTION",
  "name": "<webhook_subscription_name>",
  "description": "<webhook_subscription_desc>",
  "enabled": true,
  "sink": {
    "type": "WEBHOOK",
    "settings": {
      "eventUri": "<webhook_uri>",
      "metricUri": "<webhook_uri>",
      "format": "<format>"
    }
  }
}'

Exemplo de resposta:

{
"href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/12190e7d-a486-4a77-ba56-fecdab616837",
"uuid": "12190e7d-a486-4a77-ba56-fecdab616837",
"type": "STREAM_SUBSCRIPTION",
"name": "<webhook_subscription_name>",
"description": "<webhook_subscription_desc>",
"state": "PROVISIONED",
"enabled": true,
"sink": {
    "type": "WEBHOOK",
    "batchEnabled": false,
    "batchSizeMax": 50,
    "batchWaitTimeMax": 5,
    "settings": {
    "eventUri": "<webhook_uri>",
    "format": "CLOUDEVENT"
    }
},
"changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2025-04-30T15:31:34.528915714Z"
}
}

Visualizando uma assinatura

Portal
API

No menu Observabilidade, clique em Fluxos de Dados.
Selecione um fluxo de dados no Inventário de Fluxos.
Na página Detalhes da Transmissão, clique em Assinaturas.

Para recuperar os detalhes de uma assinatura, envie uma solicitação GET para o endpoint /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}.

Exemplo de solicitação cURL:

curl -X 'GET' 'https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/557400f8-d360-11e9-bb65-2a2ae2dbcce4' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>'

Exemplo de resposta:

{
  "href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/958a9854-dc49-4ded-87bd-be4d0099355e",
  "uuid": "958a9854-dc49-4ded-87bd-be4d0099355e",
  "type": "STREAM_SUBSCRIPTION",
  "name": "eq-splunk",
  "description": "subscription1",
  "state": "PROVISIONED",
  "enabled": true,
  "sink": {
    "uri": "https://http-inputs-<host>.splunkcloud.com:<port>/<endpoint>",
    "type": "SPLUNK_HEC",
    "credential": {
      "type": "ACCESS_TOKEN"
    },
    "settings": {
      "eventIndex": "<name_of_eventIndex>",
      "metricIndex": "<name_of_metricIndex>",
      "source": "<name_of_splunk_hec>"
    }
  },
  "changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-08-12T21:49:21.761029Z"
  }
}

Excluir uma assinatura

Portal
API

No menu Observabilidade, clique em Fluxos de Dados.
Selecione um fluxo de dados no Inventário de Fluxos.
Na página Detalhes da Transmissão, clique em Assinaturas.
Nos Detalhes da assinatura, clique no menu de opções ..., e Excluir assinatura.

Para excluir uma assinatura, envie uma solicitação DELETE para o endpoint /fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}.

Exemplo de solicitação cURL:

curl -X 'DELETE' 'https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/557400f8-d360-11e9-bb65-2a2ae2dbcce4' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <Bearer Token>'

Exemplo de resposta:

{
"href": "https://api.equinix.com/fabric/v4/streams/241372e9-79c9-4ef8-b77a-8b8176c228b4/subscriptions/958a9854-dc49-4ded-87bd-be4d0099355e",
"uuid": "958a9854-dc49-4ded-87bd-be4d0099355e",
"type": "STREAM_SUBSCRIPTION",
"name": "eq-splunk",
"description": "subscription1",
"state": "DEPROVISIONING",
"enabled": true,
"sink": {
    "uri": "<protocol>://http-inputs-<host>.splunkcloud.com:<port>/<endpoint>",
    "type": "SPLUNK_HEC",
    "credential": {
    "type": "ACCESS_TOKEN"
    },
    "settings": {
    "eventIndex": "<name_of_eventIndex>",
    "metricIndex": "<name_of_metricIndex>",
    "source": "<name_of_splunk_hec>"
    }
},
"changeLog": {
    "createdBy": "user1",
    "createdDateTime": "2024-08-12T21:49:21.761029Z"
}
}

Pré-requisitos​

Criando uma assinatura​

Datadog​

Google PubSub​

Webhook do Grafana​

Equipes da Microsoft​

PagerDuty​

ServiceNow​

Slack​

Splunk​

Webhook genérico​

Visualizando uma assinatura​

Excluir uma assinatura​

Pré-requisitos

Criando uma assinatura

Datadog

Google PubSub

Webhook do Grafana

Equipes da Microsoft

PagerDuty

ServiceNow

Slack

Splunk

Webhook genérico

Visualizando uma assinatura

Excluir uma assinatura