Gerenciar tabelas de roteamento
Pré-requisitos
Autenticar - Envie suas credenciais de usuário, ID do Cliente e Segredo do Cliente para autenticação OAuth2. Consulte Autenticação de API para obter instruções sobre como chamar a API OAuth para validar e autenticar suas credenciais.
Atualizar tabelas de roteamento
Para acionar uma atualização das tabelas de roteamento do seu Fabric Cloud Router, envie uma solicitação POST para o endpoint /fabric/v4/routers/{uuid}/actions.
POST /fabric/v4/routers/{uuid}/actions | |
|---|---|
| Method | POST |
| URL or Endpoint | /fabric/v4/routers/{uuid}/actions |
| Headers | Authorization, Content-Type |
| Path Parameters | uuid |
| Query Parameters | Not applicable |
| Body Parameters | type |
Exemplo de solicitar de curl:
curl -X
POST 'https://api.equinix.com/fabric/v4/routers/{router_uuid}/actions'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"type": "ROUTE_TABLE_ENTRY_UPDATE"
}'
Parâmetros corporais:
-
type(obrigatório) string - A ação de gerenciamento da tabela de roteamento. Para atualizar suas tabelas de roteamento, useROUTE_TABLE_ENTRY_UPDATE. Para ver todos os prefixos aprendidos via BGP, useRECEIVED_ROUTE_ENTRY_UPDATE. Para ver os prefixos que o FCR está enviando via BGP, useADVERTISED_ROUTE_ENTRY_UPDATE. -
connection(opcional) objeto - Um objeto que contém um campouuidpara especificar uma conexão. Necessário apenas para os tiposRECEIVED_ROUTE_ENTRY_UPDATEeADVERTISED_ROUTE_ENTRY_UPDATE.
Para obter informações completas sobre os parâmetros e exemplos, consulte a Referência da API.
Exemplo de resposta:
{
"type": "ROUTE_TABLE_ENTRY_UPDATE",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"state": "PENDING",
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z",
"updatedDateTime": "2021-08-15T19:30:29.526Z"
}
}
Obter solicitações de gerenciamento de tabelas de roteamento
Para obter uma lista de solicitações de gerenciamento de tabelas de roteamento, envie uma solicitação GET para o endpoint /fabric/v4/routers/{uuid}/actions. Use o parâmetro de consulta state para filtrar a resposta pelo estado da solicitação.
GET /fabric/v4/routers/{uuid}/actions | |
|---|---|
| Method | GET |
| URL or Endpoint | /fabric/v4/routers/{uuid}/actions |
| Headers | Authorization |
| Path Parameters | uuid |
| Query Parameters | state |
| Body Parameters | Not applicable |
Esta API recupera solicitações de ações de gerenciamento de tabelas de roteamento.
Exemplo de solicitação curl
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/{router_uuid}/actions?state=<state>'
-H 'authorization: Bearer <token>'
Parâmetro de consulta:
state(opcional) string - Status de execução da ação. Valores aplicáveis:PENDING,SUCCEEDEDouFAILED.
Exemplo de resposta:
{
"type": "ROUTE_TABLE_ENTRY_UPDATE",
"uuid": "37c10edc-ba2e-4240-a850-8a48f9c47d00",
"state": "PENDING",
"changeLog": {
"createdDateTime": "2021-07-15T19:30:29.526Z",
"updatedDateTime": "2021-08-15T19:30:29.526Z"
}
}
Pesquisar Solicitações de Gerenciamento de Tabelas de Roteamento
Para pesquisar solicitações de gerenciamento de tabelas de roteamento, envie uma solicitação POST para o endpoint /fabric/v4/routers/{routerId}/actions/search, especificando os critérios de pesquisa no corpo da solicitação.
POST /fabric/v4/routers/{routerId}/actions/search | |
|---|---|
| Method | POST |
| URL or Endpoint | /fabric/v4/routers/{routerId}/actions/search |
| Headers | Authorization, Content-Type |
| Path Parameters | routerId |
| Query Parameters | Not applicable |
| Body Parameters | filter, pagination, sort |
Exemplo de solicitar de curl:
curl -X POST 'http: //api.equinix.com/fabric/v4/routers/{router_uuid}/actions/search'
-H 'content-type: application/json'
-H 'authorization: Bearer <token>'
-d '{
"filter": {
"and": [
{
"property": "/type",
"operator": "IN",
"values": [
"ROUTE_TABLE_ENTRY_UPDATE",
"RECEIVED_ROUTE_ENTRY_UPDATE"
]
},
{
"property": "/state",
"operator": "=",
"values": [
"SUCCEEDED"
]
},
{
"property": "/connection/uuid",
"operator": "IN",
"values": [
"3066ab1d-af87-49d7-8a14-c9bdb57ac809"
]
}
]
},
"pagination": {
"offset": 0,
"limit": 1
},
"sort": [
{
"property": "/changeLog/createdDateTime",
"direction": "DESC"
}
]
}'
Parâmetros corporais notáveis:
-
filter(obrigatório) objeto - O objeto que define suas condições de busca . -
and(obrigatório) array[objeto] - Um objeto de matriz que serve como operador lógico aplicado aos objetos de busca na matriz. Você pode busca por: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 busca em todas as categorias"\*".operator(obrigatório) string - Operador de parâmetro de 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 contendo configurações de paginação de resultados de busca com camposoffsetinteiro elimitinteiro. -
sortobjeto - Objeto opcional que define suas configurações de classificação de resultados de busca com camposdirectionstring epropertystring.
Para obter uma lista completa das propriedades pesquisáveis, limites de paginação e propriedades classificáveis, consulte a referência da API.
Exemplo de resposta:
{
"pagination": {
"offset": 0,
"limit": 1,
"total": 2,
"prev": null,
"next": null
},
"data": [
{
"href": "https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"uuid": "1e9414f1-763e-4c0a-86c6-0bc8336048d9",
"type": "RECEIVED_ROUTE_ENTRY_UPDATE",
"state": "SUCCEEDED",
"connection": {
"uuid": "3066ab1d-af87-49d7-8a14-c9bdb57ac809"
},
"operation": {
"bgpIpv4RoutesCount": 6,
"bgpIpv6RoutesCount": 6
},
"changeLog": {
"createdDateTime": "2024-01-01T01:00:00.000Z",
"updatedDateTime": "2024-01-01T01:01:00.000Z"
}
}
]
}