Ir al contenido principal

Gestión de Fabric Cloud Router

Requisitos previos​

Autenticar - Envíe sus credenciales de usuario, ID de cliente y secreto de cliente para la autenticación OAuth2. Consulte API Authentication para obtener instrucciones sobre cómo llamar a la API OAuth para validar y autenticar sus credenciales.

Buscar y recuperar Fabric Cloud Router​

Esta solicitud API recupera las instancias de Fabric Cloud Router que coinciden con los criterios de búsqueda proporcionados. Envíe una solicitud POST al punto final /fabric/v4/routers/search, especificando sus criterios en el cuerpo de la solicitud.

POST /fabric/v4/routers/search
MethodPOST
URL or Endpoint/fabric/v4/routers/search
HeadersAuthorization, Content-Type
Path ParametersNot applicable
Query ParametersNot applicable
Body Parametersfilter, pagination, sort

Ejemplo de solicitud 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"  
        }  
    ]  
}'

Parámetros corporales notables:

  • filter (required) object - The object that defines your search conditions.

  • and (required) array[object] - An array object that serves as the logical operator applied on the search objects in the array. You can search on:

    • property (required) string - Search field parameter. Note that the property value determines the list of applicable operators and values. Applicable values: "/name", "/uuid", "/state", "/location/metroCode", "/location/metroName", "/package/code" and an all-category search "\*".
    • operator (required) string - Search field parameter operator. Applicable values: "=", "!=", ">", ">=", "<", "<=", BETWEEN, LIKE, IN, "NOT BETWEEN", "NOT LIKE", "NOT IN".
    • value (required) array[string] - Search field parameter value.

  • pagination object - Optional object containing search results pagination settings with offset integer and limit integer fields.

  • sort object - Optional object that defines your search result sorting settings with direction string and property string fields.

Para obtener una lista completa de las propiedades buscables, los límites de paginación y las propiedades ordenables, consulte la referencia API.

Respuesta de muestra:

{  
    "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"  
            }  
        }  
    ]  
}

Obtener Fabric Cloud Router especificado​

Esta solicitud de API recupera detalles de un Fabric Cloud Router especificado, envíe una solicitud GET al punto final /fabric/v4/routers/{uuid} con el uuid en la ruta de la solicitud.

GET /fabric/v4/routers/{uuid}
MethodGET
URL or Endpoint/fabric/v4/routers/{uuid}
HeadersAuthorization, Content-Type
Path Parametersuuid
Query ParametersNot applicable
Body ParametersNot applicable

Ejemplo de solicitud curl:

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

Respuesta de muestra:

{  
    "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"  
    }  
}

Actualizar un Fabric Cloud Router​

Para actualizar un Fabric Cloud Router, envíe una solicitud PATCH al punto final /fabric/v4/routers/{routerId} con los parámetros que está actualizando en el cuerpo de la solicitud. Puede actualizar el nombre o cambiar el paquete.

PATCH /fabric/v4/routers/{uuid}
MethodPATCH
URL or Endpoint/fabric/v4/routers/{uuid}
HeadersAuthorization, Content-Type
Path Parametersuuid
Query ParametersNot applicable
Body Parametersop, path, value

Ejemplo de solicitud 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"  
    }  
]'

Parámetros corporales notables:

  • op (required) string - Update request type. Applicable values: replace, add, or remove.
  • path (required) string - Parameter path of the value you are updating. Applicable values: "/name" or "/package/code".
  • value (required) string - The new parameter value.

Para obtener una lista completa de los campos actualizables y sus valores, consulte la referencia API.

Borrar Fabric Cloud Router​

Para eliminar un Fabric Cloud Router, envíe una solicitud DELETE al punto final /fabric/v4/routers/{uuid}. Especifique el enrutador que desea eliminar por uuid en la ruta.

DELETE /fabric/v4/routers/{uuid}
MethodDELETE
URL or Endpoint/fabric/v4/routers/{uuid}
HeadersAuthorization, Content-Type
Path Parametersuuid
Query ParametersNot applicable
Body ParametersNot applicable

Ejemplo de solicitud curl:

curl -X  
DELETE 'https://api.equinix.com/fabric/v4/routers/{router_uuid}'  
-H 'content-type: application/json'  
-H 'authorization: Bearer <token>'
¿Fue útil esta página?