Gestion des routeurs du Fabric Cloud Router

Conditions préalables

Authentifier - Soumettez vos informations d'identification de l'utilisateur, l'ID du client et le secret du client pour l'authentification OAuth2. Reportez-vous à API Authentication pour savoir comment appeler l'API OAuth afin de valider et d'authentifier vos informations d'identification.

Recherche et récupération des routeurs Fabric Cloud Router

Cette demande d'API récupère les instances de Fabric Cloud Router qui correspondent aux critères de recherche fournis. Envoyez une requête POST au point de terminaison /fabric/v4/routers/search, en spécifiant vos critères dans le corps de la requête.

	POST /fabric/v4/routers/search
Method	`POST`
URL or Endpoint	`/fabric/v4/routers/search`
Headers	`Authorization`, `Content-Type`
Path Parameters	Not applicable
Query Parameters	Not applicable
Body Parameters	`filter`, `pagination`, `sort`

Exemple de requête curl :

curl -X POST 'http: //api.equinix.com/fabric/v4/routers/search'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '{  
    "filter": {  
        "and": [  
            {  
                "property": "/name",  
                "operator": "LIKE",  
                "values": [  
                    "%Test%"  
                ]  
            },  
            {  
                "property": "/state",  
                "operator": "=",  
                "values": [  
                    "PROVISIONED"  
                ]  
            },  
            {  
                "property": "/project/projectId",  
                "operator": "=",  
                "values": [  
                    "995072000433550"  
                ]  
            },  
            {  
                "property": "/location/metroCode",  
                "operator": "=",  
                "values": [  
                    "SV"  
                ]  
            }  
        ]  
    },  
    "pagination": {  
        "offset": 0,  
        "limit": 20  
    },  
    "sort": [  
        {  
            "direction": "DESC",  
            "property": "/changeLog/createdDateTime"  
        }  
    ]  
}'

Paramètres corporels remarquables :

filter (obligatoire) object - L'objet qui définit vos conditions de recherche.
and (obligatoire) array[object] - Un objet tableau qui sert d'opérateur logique appliqué aux objets de recherche dans le tableau. Vous pouvez effectuer des recherches sur :
- property (obligatoire) string - Paramètre du 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 toutes catégories "\*".
- operator (obligatoire) string - Opérateur de paramètre de champ de recherche. Valeurs applicables : "=", "!=", ">", ">=", "<", "<=", BETWEEN, LIKE, IN, "NOT BETWEEN", "NOT LIKE", "NOT IN".
- value (obligatoire) array[string] - Valeur du paramètre du champ de recherche.
pagination object - Objet facultatif contenant les paramètres de pagination des résultats de recherche avec offset integer et limit integer.
sort object - Objet facultatif qui définit vos paramètres de tri des résultats de recherche avec direction string et property string. string et property string.

Pour une liste complète des propriétés consultables, des limites de pagination et des propriétés triables, consultez la [référence API] (/api-catalog/fabricv4#operation/searchCloudRouters).

Exemple de réponse :

{  
    "pagination": {  
        "offset": 0,  
        "limit": 20,  
        "total": 1,  
        "next": "/search?offset=4&limit=2",  
        "previous": "/search?offset=0&limit=2"  
    },  
    "data": [  
        {  
            "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",  
            "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",  
            "state": "PROVISIONED",  
            "type": "XF_ROUTER",  
            "name": "My-Fabric-Cloud-Router",  
            "location": {  
                "metroCode": "HH"  
            },  
            "package": {  
                "code": "LAB"  
            },  
            "order": {  
                "purchaseOrderNumber": "1-129105284100"  
            },  
            "project": {  
                "projectId": "12345"  
            },  
            "notifications": [  
                {  
                    "type": "ALL",  
                    "emails": [  
                        "abc@abc.com"  
                    ]  
                }  
            ],  
            "account": {  
                "accountNumber": 123  
            },  
            "bgpIpv4RoutesCount": 0,  
            "bgpIpv6RoutesCount": 0,  
            "connectionsCount": 0,  
            "changeLog": {  
                "createdBy": "abc@xyz.com",  
                "createdByFullName": "abc",  
                "createdByEmail": "abc@xyz.com",  
                "createdDateTime": "2021-09-24T06:59:46Z"  
            }  
        }  
    ]  
}

Obtenir la spécification d'un routeur Fabric Cloud Router

Cette demande d'API récupère les détails d'un routeur Cloud Fabric spécifié, envoyez une demande GET au point de terminaison /fabric/v4/routers/{uuid} avec l'uuuid dans le chemin de la demande.

	GET /fabric/v4/routers/{uuid}
Method	`GET`
URL or Endpoint	`/fabric/v4/routers/{uuid}`
Headers	`Authorization`, `Content-Type`
Path Parameters	`uuid`
Query Parameters	Not applicable
Body Parameters	Not applicable

Exemple de requête curl :

curl -X  
GET 'https://api.equinix.com/fabric/v4/routers/{router_uuid}'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'

Exemple de réponse :

{  
    "href": "https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d",  
    "uuid": "201b7346-a9eb-42fe-ae7a-08148c71928d",  
    "state": "PROVISIONED",  
    "type": "XF_ROUTER",  
    "name": "My-Fabric-Cloud-Router",  
    "location": {  
        "metroCode": "HH"  
    },  
    "package": {  
        "code": "LAB"  
    },  
    "order": {  
        "purchaseOrderNumber": "1-129105284100"  
    },  
    "project": {  
        "projectId": "12345"  
    },  
    "notifications": [  
        {  
            "type": "ALL",  
            "emails": [  
                "abc@abc.com"  
            ]  
        }  
    ],  
    "account": {  
        "accountNumber": 123  
    },  
    "bgpIpv4RoutesCount": 0,  
    "bgpIpv6RoutesCount": 0,  
    "distinctIpv4PrefixesCount": 4,  
    "distinctIpv6PrefixesCount": 4,  
    "connectionsCount": 0,  
    "changeLog": {  
        "createdBy": "abc@xyz.com",  
        "createdByFullName": "abc",  
        "createdByEmail": "abc@xyz.com",  
        "createdDateTime": "2021-09-24T06:59:46Z"  
    }  
}

Mise à jour d'un routeur Fabric Cloud Router

Pour mettre à jour un Fabric Cloud Router, envoyez une requête PATCH au point de terminaison /fabric/v4/routers/{routerId} avec les paramètres que vous mettez à jour dans le corps de la requête. Vous pouvez mettre à jour le nom ou modifier le paquet.

	PATCH /fabric/v4/routers/{uuid}
Method	PATCH
URL or Endpoint	`/fabric/v4/routers/{uuid}`
Headers	`Authorization`, `Content-Type`
Path Parameters	`uuid`
Query Parameters	Not applicable
Body Parameters	`op`, `path`, `value`

Exemple de requête curl :

curl -X  
PATCH 'https: //api.equinix.com/fabric/v4/routers/{router_uuid}'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'  
-d '[  
    {  
        "op": "replace",  
        "path": "/name",  
        "value": "Cloud-Router-2"  
    }  
]'

Paramètres corporels remarquables :

op (required) string - Type de demande de mise à jour. Valeurs applicables : replace, add ou remove.
path (obligatoire) string - Chemin d'accès au paramètre de la valeur que vous mettez à jour. Valeurs applicables : "/name" ou "/package/code".
value (obligatoire) string - La nouvelle valeur du paramètre.

Pour une liste complète des champs actualisables et de leurs valeurs, consultez la [référence API] (/api-catalog/fabricv4#operation/updateCloudRouterByUuid).

Supprimer le Fabric Cloud Router

Pour supprimer un Fabric Cloud Router, envoyez une requête DELETE au point de terminaison /fabric/v4/routers/{uuid}. Spécifiez le routeur que vous voulez supprimer par uuid dans le chemin.

	DELETE /fabric/v4/routers/{uuid}
Method	DELETE
URL or Endpoint	`/fabric/v4/routers/{uuid}`
Headers	`Authorization`, `Content-Type`
Path Parameters	`uuid`
Query Parameters	Not applicable
Body Parameters	Not applicable

Exemple de requête curl :

curl -X  
DELETE 'https://api.equinix.com/fabric/v4/routers/{router_uuid}'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'

Conditions préalables​

Recherche et récupération des routeurs Fabric Cloud Router​

Obtenir la spécification d'un routeur Fabric Cloud Router​

Mise à jour d'un routeur Fabric Cloud Router​

Supprimer le Fabric Cloud Router​

Conditions préalables

Recherche et récupération des routeurs Fabric Cloud Router

Obtenir la spécification d'un routeur Fabric Cloud Router

Mise à jour d'un routeur Fabric Cloud Router

Supprimer le Fabric Cloud Router