Créer un abonnement
Une fois que vous avez mis en place et configuré votre collecteur de données, créez un abonnement pour lui transmettre vos données de colocation.
Vous ne pouvez utiliser qu'un seul type de canal de communication dans votre organisation. Par exemple, si vous créez un abonnement avec le canal AWS IoT Core, vous ne pourrez pas créer un autre abonnement avec un autre type de canal.
Un seul canal est autorisé par abonnement.
Conditions préalables
-
Avant d'appeler les API de gestion des abonnements, reportez-vous à [Integrating with a Collector] (integrating-with-collector.md) pour mettre en place et configurer la destination de vos données.
-
Soumettez vos informations d'identification, votre ID client et votre secret client pour l'authentification OAuth2. Reportez-vous à API Authentication pour plus d'informations sur l'authentification de vos demandes à l'API Equinix.
AWS IoT Core
Pour créer un abonnement afin d'envoyer des données à Amazon IoT Core, envoyez une requête POST au point de terminaison /smartview/v2/streaming/subscriptions. Dans le corps de la requête, spécifiez le channelType comme étant AWS_IOT_CORE et son URL dans awsIotCoreChannelConfiguration. Spécifiez les données qu'il doit recevoir dans l'objet messageType.
Exemple de requête cURL :
curl -X
POST 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"messageType": {
"asset": [],
"environmental": [
{
"accountNumber": "116710",
"ibx": [
"LD9"
],
"level": [
"CAGE"
]
}
],
"power": [],
"meteredPower": [],
"systemAlert": [],
"customAlert": []
},
"channel": {
"channelType": "AWS_IOT_CORE",
"awsIotCoreChannelConfiguration": {
"url": "https://<awsIotCoreuri>.amazonaws.com"
}
}
}'
Pour une liste complète des options disponibles pour messageType, voir la Référence API.
Azure Event Hub
Pour créer un abonnement au canal Azure, veuillez [contacter le support] (/docs/customer-support/index.md).
Webhook
Pour créer un abonnement afin d'envoyer des données à un webhook, envoyez une requête POST au point de terminaison /smartview/v2/streaming/subscriptions. Dans le corps de la requête, spécifiez le channelType comme étant WEBHOOK et sa configuration dans webhookChannelConfiguration. Spécifiez les données qu'il doit recevoir dans l'objet messageType.
Exemple de requête cURL :
curl -X
POST 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"messageType": {
"asset": [],
"environmental": [
{
"accountNumber": "116710",
"ibx": [
"LD9"
],
"level": [
"CAGE"
]
}
],
"power": [],
"meteredPower": [],
"systemAlert": [],
"customAlert": []
},
"channel": {
"channelType": "WEBHOOK",
"webhookChannelConfiguration": {
"sslCertificate": "ZkFzZLY1IGRpY31kZXI=...",
"url": "https://<webhook-uri>.com",
"numberOfRetries": 1,
"numberOfConcurrentCalls": 20,
"batchSize": 5
},
}
}'
Pour une liste des options de configuration du webhook et des options disponibles pour messageType, voir la Référence API.
Equinix Rest API
Pour créer un abonnement afin de rendre vos données disponibles à partir de l'API Equinix, envoyez une requête POST au point de terminaison /smartview/v2/streaming/subscriptions. Dans le corps de la requête, spécifiez que le channelType est REST. Spécifiez les données qu'il doit recevoir dans l'objet messageType.
Exemple de requête cURL :
curl -X
POST 'https://api.equinix.com/smartview/v2/streaming/subscriptions'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"messageType": {
"asset": [],
"environmental": [
{
"accountNumber": "116710",
"ibx": [
"LD9"
],
"level": [
"CAGE"
]
}
],
"power": [],
"meteredPower": [],
"systemAlert": [],
"customAlert": []
},
channel": {
"channelType": "REST",
"restChannelConfiguration": {
}
}
}'
Pour une liste complète des options disponibles pour messageType, voir la Référence API.
Exemple de réponse :
HTTP/1.1 201 Created
Location: /smartview/v2/streaming/subscriptions/0f6bdb36-e130-4924-b038-ee1785fad999
L'en-tête Location de la réponse contient l'identifiant de l'abonnement requis pour consommer le flux en temps réel.