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 Autenticación de API para obtener instrucciones sobre cómo llamar al API de OAuth para validar y autenticar sus credenciales.
Buscar y recuperar Fabric Cloud Router
Esta solicitud de API recupera instancias de Fabric Cloud Router que coinciden con los criterios de búsqueda proporcionados. Envíe una POST solicitud al /fabric/v4/routers/search punto final, especificando sus criterios en el cuerpo de la solicitud.
| PUBLICAR /fabric/v4/routers/buscar | |
|---|---|
| Método | POST |
| URL o punto final | /fabric/v4/routers/search |
| Encabezados | Authorization, Content-Type |
| Parámetros de la ruta | No aplicable |
| Parámetros de consulta | No aplicable |
| Parámetros corporales | filter, 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:
-
filterObjeto (obligatorio): El objeto que define sus condiciones de búsqueda. -
and(Obligatorio) Array[Object] - Un objeto de array que sirve como operador lógico aplicado a los objetos de búsqueda en el array. Puede buscar en:property(Obligatorio) string - Parámetro del campo de búsqueda. Tenga en cuenta que el valor de la propiedad determina la lista de operadores y valores aplicables. Valores aplicables:"/name","/uuid","/state""/location/metroCode", , ,"/location/metroName"``"/package/code"y una búsqueda de todas las categorías"\*".operator(Obligatorio) string - Operador de parámetros de campo de búsqueda. Valores aplicables:"=","!=",">"">=", , ,"<"``"<=",BETWEEN,LIKEIN, , ,"NOT BETWEEN"``"NOT LIKE","NOT IN".value(Requerido) Array[string] - Valor del parámetro del campo de búsqueda.
-
paginationObjeto - Objeto opcional que contiene la configuración de paginación de los resultados de búsqueda conoffsetcampos entero elimitentero. -
sortObjeto - Objeto opcional que define la configuración de clasificación de los resultados de búsqueda condirectioncampos de cadena ypropertycadena.
Para obtener una lista completa de las propiedades que se pueden buscar, los límites de paginación y las propiedades clasificables, consulte la referencia de 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 los detalles de un Fabric Cloud Router especificado, envíe una GET solicitud al /fabric/v4/routers/{uuid}punto final con el uuid In the path de la solicitud.
| OBTENER /fabric/v4/routers/{uuid} | |
|---|---|
| Método | GET |
| URL o punto final | /fabric/v4/routers/{uuid} |
| Encabezados | Authorization, Content-Type |
| Parámetros de la ruta | uuid |
| Parámetros de consulta | No aplicable |
| Parámetros corporales | No aplicable |
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 PATCH solicitud al /fabric/v4/routers/{routerId} punto final con los parámetros que está actualizando en el cuerpo de la solicitud. Puede actualizar el nombre o cambiar el paquete.
| PARCHE /fabric/v4/routers/{uuid} | |
|---|---|
| Método | PARCHE |
| URL o punto final | /fabric/v4/routers/{uuid} |
| Encabezados | Authorization, Content-Type |
| Parámetros de la ruta | uuid |
| Parámetros de consulta | No aplicable |
| Parámetros corporales | op, 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(Obligatorio) string - Tipo de solicitud de actualización. Valores aplicables:replace,add, oremove.path(Obligatorio) string - Ruta del parámetro del valor que está actualizando. Valores aplicables:"/name"o"/package/code".value(Obligatorio) string - El nuevo valor del parámetro.
Para obtener una lista completa de los campos actualizables y sus valores, consulte la referencia de API .
Borrar Fabric Cloud Router
Para eliminar un Fabric Cloud Router, envíe una DELETE solicitud al /fabric/v4/routers/{uuid} punto final. Especifique el router por el que desea eliminar uuiden la ruta.
| ELIMINAR /fabric/v4/routers/{uuid} | |
|---|---|
| Método | BORRAR |
| URL o punto final | /fabric/v4/routers/{uuid} |
| Encabezados | Authorization, Content-Type |
| Parámetros de la ruta | uuid |
| Parámetros de consulta | No aplicable |
| Parámetros corporales | No aplicable |
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>'