Gerenciando Fabric Cloud Routers
Pré-requisitos
Autenticar - Envie suas credenciais de usuário, ID do cliente e segredo do cliente para autenticação OAuth2. Consulte Autenticação API para obter instruções sobre como chamar o OAuth API para validar e autenticar suas credenciais.
Pesquisar e recuperar roteadores Fabric Cloud
Esta solicitação API recupera instâncias do Fabric Cloud Router que correspondem aos critérios de pesquisa fornecidos. Envie uma POST solicitação para o /fabric/v4/routers/search terminal, especificando seus critérios no corpo da solicitação.
| POST /Fabric/v4/roteadores/search | |
|---|---|
| Método | POST |
| URL ou ponto final | /fabric/v4/routers/search |
| Cabeçalhos | Authorization, Content-Type |
| Parâmetros do caminho | Não aplicável |
| Parâmetros de consulta | Não aplicável |
| Parâmetros Corporais | filter``pagination, , sort |
Exemplo de requisição 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 corporais notáveis:
-
filter(Obrigatório) objeto - O objeto que define suas condições de pesquisa. -
and(Obrigatório) array[object] - Um objeto array que serve como operador lógico aplicado nos objetos de pesquisa no array. Você pode pesquisar em:property(Obrigatório) string - parâmetro do campo de pesquisa. Observe que o valor da propriedade determina a lista de operadores e valores aplicáveis. Valores aplicáveis:"/name"``"/uuid", ,"/state","/location/metroCode","/location/metroName", ,"/package/code"e uma pesquisa em todas as categorias"\*".operator(Obrigatório) string - Operador do parâmetro do campo de pesquisa. Valores aplicáveis:"="``"!=", ,">",">=","<", ,"<="``BETWEEN, ,LIKE,IN,"NOT BETWEEN", ,"NOT LIKE","NOT IN".value(Obrigatório) array[string] - Valor do parâmetro do campo de pesquisa.
-
paginationObjeto - Objeto opcional que contém configurações de paginação de resultados de pesquisa comoffsetcampos inteiro elimitinteiro. -
sortObjeto - Objeto opcional que define as configurações de classificação dos resultados da pesquisa comdirectioncampos string epropertystring.
Para obter uma lista completa de propriedades pesquisáveis, limites de paginação e propriedades classificáveis, consulte a referência do API .
Exemplo de resposta:
{
"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"
}
}
]
}
Obtenha o Fabric Cloud Router especificado
A solicitação API recupera detalhes de um Fabric Cloud Router especificado, envia uma GET solicitação ao /fabric/v4/routers/{uuid}terminal com o uuid no caminho da solicitação.
| OBTENHA /Fabric/v4/roteadores/(uuid) | |
|---|---|
| Método | GET |
| URL ou ponto final | /fabric/v4/routers/{uuid} |
| Cabeçalhos | Authorization, Content-Type |
| Parâmetros do caminho | uuid |
| Parâmetros de consulta | Não aplicável |
| Parâmetros Corporais | Não aplicável |
Exemplo de requisição curl:
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/{router_uuid}'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
Exemplo de resposta:
{
"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"
}
}
Atualizar um Fabric Cloud Router
Para atualizar um Fabric Cloud Router, envie uma PATCH solicitação ao /fabric/v4/routers/{routerId} terminal com os parâmetros que você está atualizando no corpo da solicitação. Você pode atualizar o nome ou alterar o pacote.
| PATCH /Fabric/v4/roteadores/(uuid) | |
|---|---|
| Método | PATCH |
| URL ou ponto final | /fabric/v4/routers/{uuid} |
| Cabeçalhos | Authorization, Content-Type |
| Parâmetros do caminho | uuid |
| Parâmetros de consulta | Não aplicável |
| Parâmetros Corporais | op``path, , value |
Exemplo de requisição 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 corporais notáveis:
op(Obrigatório) string - tipo de solicitação de atualização. Valores aplicáveis:replace,addouremove.path(Obrigatório) string - caminho do parâmetro do valor que você está atualizando. Valores aplicáveis:"/name"ou"/package/code".value(Obrigatório) string - o novo valor do parâmetro.
Para obter uma lista completa de campos atualizáveis e seus valores, consulte a referência API .
Excluir Fabric Cloud Router
Para excluir um Fabric Cloud Router, envie uma DELETE solicitação para o /fabric/v4/routers/{uuid} terminal. No caminho, especifique o roteador que você deseja excluiruuid.
| EXCLUA /Fabric/v4/roteadores/(uuid) | |
|---|---|
| Método | DELETE |
| URL ou ponto final | /fabric/v4/routers/{uuid} |
| Cabeçalhos | Authorization, Content-Type |
| Parâmetros do caminho | uuid |
| Parâmetros de consulta | Não aplicável |
| Parâmetros Corporais | Não aplicável |
Exemplo de requisição curl:
curl -X
DELETE 'https://api.equinix.com/fabric/v4/routers/{router_uuid}'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'