APIを使用してStyleBookから構成を作成する
StyleBookを構築したら、NetScaler Console GUIを使用するか、NetScaler Console APIを使用してインポートする必要があります。インポート時にNetScaler ConsoleがStyleBookを検証します。検証が成功すると、StyleBookはNetScaler ConsoleのStyleBookカタログに表示され、構成の作成に使用できるようになります。
このStyleBookに基づいて構成を作成するために、StyleBook APIを使用できるようになりました。cURLコマンドラインツールやPostman Chromeブラウザ拡張機能など、任意のツールを使用してNetScaler ConsoleにHTTPリクエストを送信できます。
注：
StyleBook APIは、開発者ポータルでOpenAPI仕様を使用して完全に文書化されています。
例1
ロードバランシング仮想サーバーを作成するためのStyleBookで作成された
lb-vserver StyleBookを検討してください。このStyleBookから構成パックを作成するには、次のREST APIを使用します。
HTTPメソッド: POST
URL:
https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
コンテンツタイプ: application/json
アクセプト: application/json
リクエストボディペイロード:
{
"configpack":
{
"parameters": {
"name": "lb1",
"vip-ipaddress": "10.102.117.31"
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
}
],
"stylebook": {
"name": "lb-vserver",
"namespace": "com.example.stylebooks",
"version": "1.0"
}
}
}
このHTTPリクエストでは、ID deecee30-f478-4446-9741-a85041903410 は、IPアドレス10.102.117.31を持つロードバランシング仮想サーバーlb1が作成されるNetScalerインスタンスのインスタンスIDです。NetScalerインスタンスのインスタンスIDはNetScaler Consoleから取得されます。
NetScaler Consoleによって管理されているインスタンスのIDを取得するには、NetScaler Console APIを使用できます。たとえば、IPアドレスが192.168.153.160であるNetScalerインスタンスのインスタンスIDを取得するには、次のAPIを使用できます。
HTTPメソッド: GET
URL:
https://<IP>/nitro/v2/config/ns?filter=ip_address:192.168.153.160
リクエストヘッダー:
受け入れ: application/json
応答にはJSONペイロードにIDが含まれています:
予期される応答ヘッダー (成功時):
200 OK
コンテンツタイプ: application/json
予期される応答本文 (成功時):
{
"errorcode": 0,
"message": "Done",
"operation": "get",
"resourceType": "ns",
"username": "nsroot",
"tenant_name": "Owner",
"resourceName": "",
"ns":
[
{
"is_grace": "false",
"hostname": "",
"std_bw_config": "0",
"gateway_deployment": "false",
"id": "deecee30-f478-4446-9741-a85041903410",
}
]
}
構成（構成パック）が正常に作成されると、次のHTTP応答が返されます:
予期される応答ヘッダー (成功時):
202 OK
コンテンツタイプ: application/json
予期される応答本文 (成功時):
{
"job":
{
"job_id": "1460806080"
}
}
ID 1460806080 を使用して一意に識別される最初のジョブが作成されました。このIDを使用して、構成のクエリ、更新、または削除を行うことができます。
ジョブステータスを照会するには、次のURLを使用できます。
https://<IP>/stylebook/nitro/v2/config/jobs/<jobid>
例2
同じStyleBookを使用して、別の構成または構成パックを作成し、同じまたは異なるNetScalerインスタンスで実行できます。この例では、別の構成を作成し、仮想サーバーに異なる名前とIPアドレスを指定します。負荷分散方法としてLEASTCONNECTIONを指定します。この構成を2つのNetScalerインスタンスに展開します。
HTTPリクエストは次のとおりです。
HTTPメソッド: POST
URL:
https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
コンテンツタイプ: application/json
アクセプト: application/json
リクエストボディペイロード:
{
"configpack":
{
"parameters": {
"name": "lb1",
"vip-ipaddress": "10.102.117.31",
"lb-alg": "LEASTCONNECTION"
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
},
{
"instance_id": "abcdee30-f478-4446-9741-a85041903410"
}
],
"stylebook": {
"name": "lb-vserver",
"namespace": "com.example.stylebooks",
"version": "1.0"
}
}
}
このHTTPリクエストでは、IPアドレス10.102.117.31を持つ負荷分散仮想サーバーlb1が、ID「deecee30-f478-4446-9741-a85041903410」と「abcdee30-f478-4446-9741-a85041903410」を持つ2つのNetScalerインスタンス上に作成されます。
構成パックが正常に作成されると、次のHTTP応答が受信されます。
予期される応答ヘッダー (成功時):
202 OK
コンテンツタイプ: application/json
予期される応答ボディ（成功時）：
{
"job": {
"job_id": "165769629"
}
}
この新しい構成パックには、165769629という異なるIDがあります。このIDを使用して、この構成を更新または削除できます。
例 3
StyleBook to Create a Basic Load balancing Configuration で作成した「basic-lb-config」StyleBookを検討してください。REST APIを使用して、このStyleBookから次のように構成パックを作成します。
HTTPメソッド： POST
URL：
https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー：
コンテンツタイプ: application/json
アクセプト: application/json
リクエストボディペイロード：
{
"configpack":
{
"parameters":
{
"name": "myapp",
"ip": "10.70.122.25",
"svc-servers": ["192.168.100.11","192.168.100.12"],
"svc-port": 8080
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
},
{
"instance_id": "abcdefgi-d589-4557-8632-a74032802412"
}
],
"stylebook": {
"name": "basic-lb-config",
"namespace": "com.example.stylebooks",
"version": "0.1"
}
}
}
予期される応答ヘッダー（成功時）：
202 OK
コンテンツタイプ: application/json
予期される応答ボディ（成功時）：
{
"job": {
"job_id": "3628681382"
}
}
このHTTPリクエストでは、負荷分散構成が2つのNetScalerインスタンスで実行されます。これらのNetScalerインスタンスにログオンして、仮想サーバーと2つのサービスがバインドされたサービスグループが作成されているかどうかを確認できます。
例 4
複合StyleBookの作成で作成した複合StyleBook composite-example を検討してください。このStyleBookからREST APIを使用して構成パックを作成するには、次のようにします。
HTTPメソッド: POST
URL:
https://<IP>/stylebook/nitro/v2/config/configpacks
リクエストヘッダー:
コンテンツタイプ: application/json
受諾: application/json
リクエストボディペイロード:
{
"configpack":
{
"parameters": {
"name": "myapp",
"ip": "2.2.2.2",
"svc-servers": ["10.102.29.52","10.102.29.53"]
},
"targets":
[
{
"id": "deecee30-f478-4446-9741-a85041903410"
},
{
"id": "abcdefgg-d589-4557-8632-a74032802412"
}
],
"stylebook": {
"name": "composite-example",
"namespace": "com.example.stylebooks",
"version": "0.1"
}
}
このHTTPリクエストでは、構成はIDで表される2つのNetScalerインスタンス上に作成されます。NetScalerインスタンスにログオンすると、「composite-example」StyleBookにインポートされた「basic-lb-config」StyleBookによって作成された構成オブジェクトを表示できます。また、「composite-example」StyleBookの一部であった
myapp-monという新しいHTTPモニターも確認できます。
構成パックが正常に作成されると、次のHTTP応答が受信されます。
予期される応答ヘッダー (成功時):
202 OK
コンテンツタイプ: application/json
予期される応答ボディ (成功時):
{
"job": {
"job_id": "3628681382"
}
}
構成の更新
構成を更新するには、次のAPIを使用できます。ここでは、IPアドレス10.102.29.54を持つバックエンドサーバーが、ロードバランシング仮想サーバー`myapp:に追加されます。
HTTPメソッド: PUT
URL:
https://<IP>/stylebook/nitro/v2/config/configpacks/<configpackid>
リクエストヘッダー:
コンテンツタイプ: application/json
受け入れ: application/json
リクエストボディペイロード:
{
"configpack": {
"parameters": {
"name": "myapp",
"ip": "2.2.2.2",
"svc-servers": ["10.102.29.52","10.102.29.53","10.102.29.54"]
},
"targets":
[
{
"instance_id": "deecee30-f478-4446-9741-a85041903410"
},
{
"instance_id": "abdcedff-d589-4557-8632-a74032802412"
}
]
}
}
構成パックの更新が成功すると、次のHTTP応答が受信されます。
予期される応答ヘッダー (成功時):
202 OK
コンテンツタイプ: application/json
予期される応答ボディ (成功時):
{
"job": {
"job_id": "3628681382"
}
}
構成の削除
この構成 (すべてのNetScalerインスタンスから) を削除するには、次のように構成パックを削除するためのAPIを使用できます。
設定パックの削除が成功すると、次のHTTP応答が受信されます。
HTTPメソッド: DELETE
URL:
https://<DNS-or-IP>//stylebook/nitro/v2/config/configpacks/<configpackid>
リクエストヘッダー:
受諾: application/json
予期される応答ヘッダー (成功時):
202 OK
コンテンツタイプ: application/json
予期される応答ペイロード (成功時):
{
"job": {
"job_id": "3628681382"
}
}
NetScalerインスタンスにログオンし、この設定パックの一部であるすべての構成オブジェクトが削除されていることを確認します。
すべてのインスタンスからではなく、特定のNetScalerインスタンスから構成を削除するには、構成の更新で構成パックの更新操作を使用します。JSONペイロードの
targets属性を変更して、特定のNetScalerインスタンスIDを削除します。