Gérer les tables de routage
Conditions préalables
Authentifier - envoyez vos identifiants utilisateur, votre identifiant client et votre secret client pour l'authentification OAuth2. Pour obtenir des instructions sur la façon d'appeler l'API OAuth pour valider et authentifier vos identifiants, reportez-vous à authentification API.
Mise à jour des tables de routage
Pour déclencher une mise à jour des tables de routage de votre Fabric Cloud Router, envoyez POSTune demande au /fabric/v4/routers/{uuid}/actionspoint final.
POST /fabric/v4/routers/{uuid}/actions | |
|---|---|
| Méthode | POST |
| URL ou point final | /fabric/v4/routers/{uuid}/actions |
| En-têtes | Authorization Content-Type |
| Paramètres du chemin d'accès | uuid |
| Paramètres d'interrogation | Non applicable |
| Paramètres du corps | type |
Exemple de requête curl :
curl -X
POST 'https://api.equinix.com/fabric/v4/routers/{router_uuid}/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"type": "ROUTE_TABLE_ENTRY_UPDATE"
}'
Paramètres du corps :
-
typeChaîne (obligatoire) - l'action de gestion de la table de routage. Pour mettre à jour vos tables de routage, utilisezROUTE_TABLE_ENTRY_UPDATE. Pour voir tous les préfixes appris via BGP, utilisezRECEIVED_ROUTE_ENTRY_UPDATE. Pour voir les préfixes que FCR envoie via BGP, utilisezADVERTISED_ROUTE_ENTRY_UPDATE. -
connection(Facultatif) objet : objet contenant unuuidchamp permettant de spécifier une connexion. Obligatoire uniquement pourRECEIVED_ROUTE_ENTRY_UPDATEles types etADVERTISED_ROUTE_ENTRY_UPDATE.
Pour obtenir des informations complètes sur les paramètres et des exemples, reportez-vous à la référence API .
Exemple de réponse :
{
"type": "ROUTE_TABLE_ENTRY_UPDATE",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"state": "PENDING",
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z",
"updatedDateTime": "2021-08-15T19:30:29.526Z"
}
}
Demandes de gestion des tables de routage
Pour obtenir une liste des demandes de gestion des tables de routage, envoyez une GET demande au /fabric/v4/routers/{uuid}/actionsnoeud final. Utilisez le stateparamètre de requête pour filtrer la réponse en fonction de l'état de la demande.
GET /fabric/v4/routers/{uuid}/actions | |
|---|---|
| Méthode | GET |
| URL ou point final | /fabric/v4/routers/{uuid}/actions |
| En-têtes | Authorization |
| Paramètres du chemin d'accès | uuid |
| Paramètres d'interrogation | state |
| Paramètres du corps | Non applicable |
Cette API récupère les demandes d'actions de gestion des tables de routage.
Exemple de demande de curl
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/{router_uuid}/actions?state=<state>'
-H 'authorization: Bearer <token>'
Paramètre d'interrogation :
state(Facultatif) chaîne - état d'exécution de l'action. Valeurs applicables :PENDING,SUCCEEDEDouFAILED.
Exemple de réponse :
{
"type": "ROUTE_TABLE_ENTRY_UPDATE",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"state": "PENDING",
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z",
"updatedDateTime": "2021-08-15T19:30:29.526Z"
}
}
Recherche dans les tables de routage Demandes de gestion
Pour rechercher des demandes de gestion des tables de routage, envoyez une POST demande au /fabric/v4/routers/{routerId}/actions/searchnoeud final, en spécifiant les critères de recherche dans le corps de la demande.
POST /fabric/v4/routers/{routerId}/actions/search | |
|---|---|
| Méthode | POST |
| URL ou point final | /fabric/v4/routers/{routerId}/actions/search |
| En-têtes | Authorization Content-Type |
| Paramètres du chemin d'accès | routerId |
| Paramètres d'interrogation | Non applicable |
| Paramètres du corps | filter, pagination, sort |
Exemple de requête curl :
curl -X POST 'http: //api.equinix.com/fabric/v4/routers/{router_uuid}/actions/search'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "IN",
"values": [
"ROUTE_TABLE_ENTRY_UPDATE",
"RECEIVED_ROUTE_ENTRY_UPDATE"
]
},
{
"property": "/state",
"operator": "=",
"values": [
"SUCCEEDED"
]
},
{
"property": "/connection/uuid",
"operator": "IN",
"values": [
"3066ab1d-af87-49d7-8a14-c9bdb57ac809"
]
}
]
},
"pagination": {
"offset": 0,
"limit": 1
},
"sort": [
{
"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
]
}'
Paramètres corporels notables :
-
filterObjet (obligatoire) - objet qui définit vos conditions de recherche. -
and(Obligatoire) array[object] - un objet de tableau qui sert d'opérateur logique appliqué aux objets de recherche dans le tableau. Vous pouvez effectuer une recherche sur :propertyChaîne (obligatoire) - paramètre de champ de recherche. Notez que la valeur de la propriété détermine la liste des opérateurs et des valeurs applicables. Valeurs applicables :"/name","/uuid","/state","/location/metroCode", ,"/location/metroName"``"/package/code"et une recherche dans toutes les catégories"\*".operatorChaîne (obligatoire) - opérateur de paramètre de champ de recherche. Valeurs applicables :"=","!=",">",">=", ,"<"``"<=",BETWEEN,LIKE,IN, ,"NOT BETWEEN"``"NOT LIKE","NOT IN".value(Obligatoire) array[chaîne] - valeur du paramètre du champ de recherche.
-
paginationObjet - objet facultatif contenant les paramètres de pagination des résultats de la recherche avecoffsetdes champs entiers etlimitentiers. -
sortObjet - objet facultatif qui définit vos paramètres de tri des résultats de recherche avec desdirectionchamps de chaîne etpropertyde chaîne.
Pour obtenir la liste complète des propriétés consultables, des limites de pagination et des propriétés triables, reportez-vous à la référence API .
Exemple de réponse :
{
"pagination": {
"offset": 0,
"limit": 1,
"total": 2,
"prev": null,
"next": null
},
"data": [
{
"href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"type": "RECEIVED_ROUTE_ENTRY_UPDATE",
"state": "SUCCEEDED",
"connection": {
"uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809"
},
"operation": {
"bgpIpv4RoutesCount": 6,
"bgpIpv6RoutesCount": 6
},
"changeLog": {
"createdDateTime": "2024-01-01T01:00:00.000Z",
"updatedDateTime": "2024-01-01T01:01:00.000Z"
}
}
]
}