ルーティングテーブルの管理
前提条件
認証-ユーザー認証情報、クライアントID、クライアントシークレットを送信してOauth2認証を行います。認証情報を検証および認証するためにOAuth APIを呼び出す方法については、「API認証」を参照してください。
ルーティングテーブルの更新
Fabric Cloud Routerのルーティングテーブルの更新をトリガーするには、エンドポイントにリクエストを/fabric/v4/routers/{uuid}/actions送信します。POST
POST /fabric/v4/routers/{uuid}/actions | |
|---|---|
| 方法 | POST |
| URLまたはエンドポイント | /fabric/v4/routers/{uuid}/actions |
| ヘッダー | Authorization、Content-Type |
| パスパラメータ | uuid |
| クエリーパラメータ | 該当なし |
| ボディパラメータ | type |
サンプル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"
}'
ボディパラメータ:
-
type(必須) string -ルーティングテーブル管理アクション。ルーティングテーブルを更新するには、を使用します。ROUTE_TABLE_ENTRY_UPDATEBGPで学習したすべてのプレフィックスを表示するには、を使用します。RECEIVED_ROUTE_ENTRY_UPDATEFCRがBGP経由で送信しているプレフィックスを確認するには、を使用します。ADVERTISED_ROUTE_ENTRY_UPDATE -
connection(オプション) object -接続を指定するフィールドを含むオブジェクト。uuidおよびADVERTISED_ROUTE_ENTRY_UPDATEタイプにのみ必要です。RECEIVED_ROUTE_ENTRY_UPDATE
パラメータの詳細と例については、APIリファレンスを参照してください。
回答例
{
"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"
}
}
ルーティングテーブル管理リクエストの取得
ルーティングテーブル管理リクエストのリストを取得するには、エンドポイントにリクエストを/fabric/v4/routers/{uuid}/actions送信します。GETクエリパラメータを使用して、stateリクエストの状態で応答をフィルタリングします。
GET /fabric/v4/routers/{uuid}/actions | |
|---|---|
| 方法 | GET |
| URLまたはエンドポイント | /fabric/v4/routers/{uuid}/actions |
| ヘッダー | Authorization |
| パスパラメータ | uuid |
| クエリーパラメータ | state |
| ボディパラメータ | 該当なし |
この API は、ルーティングテーブル管理アクションリクエストを取得します。
カールリクエストの例
curl -X
GET 'https://api.equinix.com/fabric/v4/routers/{router_uuid}/actions?state=<state>'
-H 'authorization: Bearer <token>'
クエリパラメータ:
state(任意) string -アクションの実行ステータス。適用可能な値:PENDING、SUCCEEDED、、または。FAILED
回答例
{
"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"
}
}
検索ルーティングテーブル 管理リクエスト
ルーティングテーブル管理リクエストを検索するには、リクエストの本文に検索条件を指定して、エンドポイントにリクエストを/fabric/v4/routers/{routerId}/actions/search送信します。POST
POST /fabric/v4/routers/{routerId}/actions/search | |
|---|---|
| 方法 | POST |
| URLまたはエンドポイント | /fabric/v4/routers/{routerId}/actions/search |
| ヘッダー | Authorization、Content-Type |
| パスパラメータ | routerId |
| クエリーパラメータ | 該当なし |
| ボディパラメータ | filter、pagination、sort |
サンプル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"
}
]
}'
注目すべきボディパラメータ:
-
filter(必須) object -検索条件を定義するオブジェクト。 -
and(必須) array[object]-配列内の検索オブジェクトに適用される論理演算子として機能する配列オブジェクト。以下で検索できます。property(必須) string -検索フィールドパラメータ。プロパティ値によって、適用可能な演算子と値のリストが決定されることに注意してください。適用可能な値:"/name"``"/uuid"、、"/state"、、"/location/metroCode"、"/location/metroName"``"/package/code"すべてのカテゴリで検索できます。"\*"operator(必須) string -検索フィールドのパラメータ演算子。適用可能な値:"="``"!="、、">"、、">="、"<"``"<="``BETWEEN、、LIKE、、IN、"NOT BETWEEN"``"NOT LIKE"、。"NOT IN"value(必須) array[string]-検索フィールドのパラメータ値。
-
paginationobject - __ _整数_フィールドとlimit_整数_フィールドを持つ検索結果のページネーション設定を含むオプションオブジェクト。offset -
sortobject -文字列 __ フィールドとproperty_文字列_フィールドを使用して検索結果のソート設定を定義するオプションのオブジェクト。direction
検索可能なプロパティ、ページ番号の制限、ソート可能なプロパティの完全なリストについては、APIリファレンスを参照してください。
回答例
{
"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"
}
}
]
}