Passer au contenu principal

Gestion des routeurs Fabric Cloud

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.

Rechercher et récupérer des routeurs Fabric Cloud​

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

POST /fabric/v4/routers/search
MéthodePOST
URL ou point de terminaison/fabric/v4/routers/search
En-têtesAuthorization, Content-Type
Paramètres du cheminNon applicable
Paramètres de requêteNon applicable
Paramètres corporelsfilter, 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 notables:

  • filter Objet (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 :

    • property Chaî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 "\*".
    • operator Chaî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.
  • pagination Objet - objet facultatif contenant les paramètres de pagination des résultats de la recherche avec offset des champs entiers et limitentiers.

  • sort Objet - objet facultatif qui définit vos paramètres de tri des résultats de recherche avec des direction champs de chaîne et propertyde 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": 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 un routeur cloud Fabric spécifié​

Cette demande API récupère les détails d'un Fabric Cloud Router spécifié, envoie une GET demande au /fabric/v4/routers/{uuid}point final avec le uuiddans le chemin de la demande.

OBTENEZ /fabric/v4/routers/{uuid}
MéthodeGET
URL ou point de terminaison/fabric/v4/routers/{uuid}
En-têtesAuthorization, Content-Type
Paramètres du cheminuuid
Paramètres de requêteNon applicable
Paramètres corporelsNon 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"
    }
}

Mettre à jour un Fabric Cloud Router​

Pour mettre à jour un Fabric Cloud Router, envoyez une PATCH demande au /fabric/v4/routers/{routerId}noeud final avec les paramètres que vous mettez à jour dans le corps de la demande. Vous pouvez mettre à jour le nom ou modifier le package.

PATCH /fabric/v4/routers/{uuid}
MéthodePATCH
URL ou point de terminaison/fabric/v4/routers/{uuid}
En-têtesAuthorization, Content-Type
Paramètres du cheminuuid
Paramètres de requêteNon applicable
Paramètres corporelsop, 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 notables:

  • op Chaîne (obligatoire) - type de demande de mise à jour. Valeurs applicables : replace, addou remove.
  • path (Obligatoire) String - chemin du paramètre de la valeur que vous mettez à jour. Valeurs applicables : "/name" ou "/package/code".
  • value Chaîne (obligatoire) - la nouvelle valeur du paramètre.

Pour obtenir la liste complète des champs pouvant être mis à jour et leurs valeurs, reportez-vous à la référence API .

Supprimer Fabric Cloud Router​

Pour supprimer un Fabric Cloud Router, envoyez DELETEune demande au /fabric/v4/routers/{uuid}point final. Dans le chemin, spécifiez le routeur que vous souhaitez supprimeruuid.

SUPPRIMER /fabric/v4/routers/{uuid}
MéthodeSUPPRIMER
URL ou point de terminaison/fabric/v4/routers/{uuid}
En-têtesAuthorization, Content-Type
Paramètres du cheminuuid
Paramètres de requêteNon applicable
Paramètres corporelsNon 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>'
Cette page vous a-t-elle été utile ?