デバイスの作成
前提条件
認証-ユーザー認証情報、クライアントID、クライアントシークレットを送信してOauth2認証を行います。認証情報を検証および認証するためにOAuth APIを呼び出す方法については、「API認証」を参照してください。
ステップ2: デバイスの詳細を取得
-
Get Device Typesを呼び出して、NEプラットフォームで起動するセルフ設定デバイス（ルータやファイアウォールなど）を検索します。仮想デバイスが利用可能な都市圏の地域、デバイスのベンダー、利用可能なコア数、ソフトウェアパッケージとそのバージョンについて学びます。
deviceTypeCode、metroCode、core、、、を選択します。packageCode``version -
Get Allowed Interfacesを呼び出して、選択したコアで許可されているインターフェースの数を確認します。として、使用可能な任意のデバイスインターフェースを選択できます。
sshInterfaceIdそうでない場合、Equinixは最初に使用可能なインターフェースを選択します。 -
Get Accounts{metro}に電話して、
accountReferenceId仮想デバイスを使用する都市圏のアカウント番号（または）とステータスを確認します。請求上の理由から、仮想デバイスを使用する都市圏のアカウントが、アクティブまたは保留中の状態である必要があります。アカウントをお持ちでない場合は、アカウントを作成してください。
リセラーがお客様用のデバイスを作成しようとしている場合は、お客様のアカウントと（リセラーの）アカウントの両方が「アクティブ」または「保留中」のステータスになっていることを確認する必要があります。アカウントには請求が発生しますが、お客様用のデバイスを作成するには、お客様のアカウント番号をAPIに送信する必要があります。
ステップ3: ライセンスオプション
ほとんどのデバイスのライセンスオプションとして、BYOL（ライセンス持ち込み）を提供しています。ベンダーの提供内容に応じて、ライセンスファイルまたはコード/トークン/IDをアップロードします。Cisco 8000Vには、サブスクリプションライセンスオプションがあります。
-
アリスタ：アリスタデバイスのライセンスのアップロードはサポートされていません。ただし、作成後にデバイスにログインしてライセンスをアップロードし、スループットを向上させることができます。
-
シスコとパロアルトはライセンストークンを提供しています。フィールドにライセンストークンを入力します。
licenseToken -
ジュニパーはライセンスファイルを提供しています。ジュニパーデバイスのライセンス(BYOL)を持ち込むには、ライセンスファイルの送信を使用してライセンスファイルをアップロードします。仮想デバイスの作成に使用できるファイルIDが表示されます。冗長Juniperデバイスがある場合は、プライマリデバイスとセカンダリデバイスの両方に同じファイルIDを使用できます。
-
フォーティネット：デバイス作成時にFortinetデバイスにはライセンスは必須ではありません。トークンがある場合は、フィールドに入力します。
licenseTokenFortinetデバイスのライセンスファイルを設定するには、次の手順を実行する必要があります。- Fortinetポータルでライセンスファイルを生成します。
- ライセンスファイルの発行後を呼び出して、Equinixポータルにライセンスファイルをアップロードします。仮想デバイスの作成に使用できるを入手します。
fileId
- ライセンスステータスを確認するには、デバイスにログインしてください。
ステップ4: セルフ設定デバイスの作成
| POST/NE/v1/デバイス | |
|---|---|
| 方法 | POST |
| URLまたはエンドポイント | /ne/v1/devices |
| ヘッダー | Authorizationトークン、Content-Type |
| クエリーパラメータ | draft、draftUuid |
プライマリデバイスとセカンダリデバイスを持つ冗長デバイスを作成する：
- セカンダリーオブジェクトのパラメータを設定する
- リセラーがお客様用に冗長デバイスを作成しようとしている場合は、プライマリとセカンダリの両方の都市圏が同じ国にあることを確認してください。プライマリアカウント番号とセカンダリアカウント番号は同じである必要があります。リセラーのアカウントには請求が発生しますが、このAPIはお客様のアカウント番号を承認して、お客様用のデバイスを作成します。各顧客はリセラーの請求アカウントに関連付けられているため、上記の制限が必要です。
- Cisco FTDデバイスの場合、プライマリデバイスとセカンダリデバイスの管理タイプは同じでなければなりません。
仮想デバイスを作成することで、オーダー条件に同意したものとみなされます。オーダー条件の取得に電話して、詳細を確認してください。
デバイスの下書きを保存するには、deviceTypeCode、accountNumberまたはaccountReferenceId、を指定する必要があります。metroCode
リクエスト例
単一のデバイスを作成するためのcurlリクエストのサンプル。
curl -X
POST "https://api.equinix.com/ne/v1/devices?draft=false"
-H "content-type: application/json"
-H "Authorization: Bearer <token>"
-d '
{
"metroCode": "SV",
"deviceTypeCode": "VSRX",
"agreeOrderTerms": true,
"termLength": "1",
"licenseMode": "BYOL",
"packageCode": "STD",
"virtualDeviceName": "Test-device-001-SROY",
"notifications": [
"test@equinix.com"
],
"hostNamePrefix": "TC12",
"aclDetails": [
{
"uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",
"interfaceType": "WAN"
}
],
"accountNumber": "200541",
"version": "23.2R1.13",
"interfaceCount": 8,
"deviceManagementType": "SELF-CONFIGURED",
"core": 2,
"userPublicKey": {
"username": "userName",
"keyName": "keyName"
},
"additionalBandwidth": "100"
}
'
冗長デバイスを作成するためのcurlリクエストのサンプル。
curl -X
POST "https://api.equinix.com/ne/v1/devices?draft=false"
-H "content-type: application/json"
-H "Authorization: Bearer <token>"
-d '
{
"metroCode": "DC",
"deviceTypeCode": "C8000V",
"agreeOrderTerms": true,
"termLength": "1",
"licenseMode": "BYOL",
"packageCode": "network-advantage",
"virtualDeviceName": "Test-device-001-SROY - primary",
"notifications": [
"test@equinix.com"
],
"hostNamePrefix": "TC01",
"aclDetails": [
{
"uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",
"interfaceType": "WAN"
}
],
"accountNumber": "201148",
"version": "17.06.06a",
"interfaceCount": 10,
"deviceManagementType": "SELF-CONFIGURED",
"core": 2,
"userPublicKey": {
"username": "sroy",
"keyName": "keyWIQzB"
},
"sshInterfaceId": "3",
"channelPartner": "SDCI",
"secondary": {
"metroCode": "DC",
"hostNamePrefix": "TC02",
"notifications": [
"test@equinix.com"
],
"virtualDeviceName": "Test-device-002-SROY - secondary",
"additionalBandwidth": "100",
"aclDetails": [
{
"uuid": "fb2e69bb-cbd7-40c4-bc01-8bcc5fa741c2",
"interfaceType": "WAN"
}
],
"accountNumber": "201148",
"sshInterfaceId": "4"
}
}
'
インターネットにアクセスできない Cisco FTD セカンダリデバイスを作成するためのサンプル curl リクエスト。
curl -X
POST "https://api.equinix.com/ne/v1/devices?draft=false"
-H "content-type: application/json"
-H "Authorization: Bearer <token>"
-d '
{
"deviceTypeCode": "Cisco_NGFW",
"licenseMode": "BYOL",
"packageCode": "FTDv5",
"virtualDeviceName": "NEAut-",
"metroCode": "DC",
"notifications": [
"t@t.com"
],
"hostNamePrefix": "test",
"interfaceCount": 10,
"deviceManagementType": "SELF-CONFIGURED",
"core": 4,
"version": "7.0.4-55",
"vendorConfig": {
"managementType": "FDM"
},
"connectivity": "PRIVATE",
"secondary": {
"hostNamePrefix": "test-123",
"metroCode": "DC",
"notifications": [
"t@t.com"
],
"virtualDeviceName": "test-secondary",
"vendorConfig": {
"managementType": "FDM"
}
}
}
'
パラメータとオプションの完全なリストについては、『APIリファレンス』を参照してください。
回答例
単一デバイスの応答例。202年：リクエストが承認されました。
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec"
}
冗長デバイスの応答例。202年：リクエストが承認されました。
{
"uuid": "74d8c6b6-3153-4271-9f0e-45bdc7094dec",
"secondaryUuid": "de5cf79b-3d16-4ccd-841b-3b68ecda2142"
}
デバイスのステータス
Get Virtual Device {uuid}を呼び出して、デバイスのステータスを監視します。クラウドサービスプロバイダに接続する前に、デバイスをプロビジョニングし、ライセンスを登録する必要があります。
| 仮想デバイスの「ステータス」 | 説明 |
|---|---|
INITIALIZING | エクイニクスは現在、リソースの予約とデバイスの作成を進めています。 |
PROVISIONING | デバイスが起動している。 |
PENDING_ORDER | シーベルから命令が届きましたお客様は、NEポータルにログインしてオーダーを送信する必要があります。 |
PENDING_SIGNATURE | 顧客はNE規約のオフライン承諾にサインアップしたが、まだ規約を承諾していない。 |
CANCEL_ORDER | シーベルからNEへの注文はキャンセルされる。 |
WAITING_FOR_PRIMARY | セカンダリデバイスは準備ができていますが、プライマリデバイスは準備ができていません。この状態は、冗長性のためにセカンダリデバイスを作成した場合にのみ表示される場合があります。 |
WAITING_FOR_SECONDARY | プライマリデバイスは準備ができていますが、セカンダリデバイスは準備ができていません。この状態は、冗長性のためにセカンダリデバイスを作成した場合にのみ表示される場合があります。 |
FAILED | デバイスの作成に失敗しました。 |
PROVISIONED | デバイスは準備できている。 |
エンドユーザーが仮想デバイスの削除APIを使用して仮想デバイスを削除すると、仮想デバイスはEquinix インフラストラクチャ内で次の状態に移行します。
| ne/v1/devices/{uuid}配下の仮想デバイス "status" | 説明 |
|---|---|
| プロビジョニング解除 | エクイニクスはお客様からの仮想デバイス削除リクエストを受け入れました。 |
| プロビジョニング解除 | デバイスはプロビジョニング解除/削除される。 |