CloudHub 専用ロードバランサーの CLI
|
可能な場合は、Equality の会社の値に一致するように、含めない用語を変更しました。顧客の実装に対する影響を回避するために、一部の用語は変更されていません。 |
| コマンド | 説明 |
|---|---|
組織内のすべてのロードバランサーをリストする |
|
ロードバランサーの詳細を表示する |
|
未加工の JSON 応答でロードバランサーの詳細を表示する |
|
ロードバランサーを作成する |
|
ロードバランサーを開始する |
|
ロードバランサーを停止する |
|
ロードバランサーを削除する |
|
証明書を既存のロードバランサーに追加する |
|
ロードバランサーから証明書を削除する |
|
ロードバランサーが提供するデフォルトの証明書を設定する |
|
特定の証明書のロードバランサー設定を表示する |
|
IP または IP の範囲をロードバランサーの許可リストに追加する |
|
IP または IP の範囲をロードバランサーの許可リストから削除する |
|
IP または IP の範囲をロードバランサーの許可リストに追加する |
|
IP または IP の範囲をロードバランサーの許可リストから削除する |
|
ロードバランサーのプロキシマッピングルールをリストする。 |
|
指定されたインデックスでプロキシマッピングルールを追加する。 |
|
プロキシマッピングルールを削除します。 |
|
動的 IP を有効にする |
|
動的 IP を無効にする |
|
サポートされているすべてのリージョンをリストする |
|
使用可能なすべてのランタイムをリストする |
cloudhub load-balancer list
> cloudhub load-balancer list [options]
このコマンドは、Anypoint Platform のすべてのロードバランサーをリストします。ロードバランサーの名前、ドメイン、その状態、およびロードバランサーがバインドされている Anypoint VPC ID を表示します。
このコマンドはデフォルトのオプション --help、-f/--fields、-o/--output のみを受け入れます。
cloudhub load-balancer describe
> cloudhub load-balancer describe [options] <name>
このコマンドは、<name> で指定されるロードバランサーに関する情報を表示します。
ロードバランサーの名前の入力を開始して tab キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、tab キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
ロードバランサーの名前、ドメイン、その状態、およびロードバランサーがバインドされている Anypoint VPC ID を表示します。
このコマンドはデフォルトのオプション --help、-f/--fields、-o/--output のみを受け入れます。
cloudhub load-balancer describe-json
> cloudhub load-balancer describe [options] <name>
このコマンドでは、<name> で指定されるロードバランサーの未加工の JSON 応答を表示します。
ロードバランサーの名前の入力を開始して tab キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、tab キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドはデフォルトのオプション --help、-f/--fields、-o/--output のみを受け入れます。
cloudhub load-balancer create
> cloudhub load-balancer create [options] <vpc> <name> <certificate> <privateKey>
このコマンドは、環境変数で指定される値を使用してロードバランサーを作成します。
| オプション | 説明 | 例 |
|---|---|---|
|
このロードバランサーがバインドされる Anypoint VPC の名前。 |
|
|
ロードバランサーの名前。 |
|
|
ローカルハードドライブのサーバー証明書の |
|
|
ローカルハードドライブのサーバー証明書の非公開キーの |
|
|
|
このコマンドでは、デフォルトの --help、-f/--fields、-o/--output オプション以外に次のオプションも使用できます。
| オプション | 説明 |
|---|---|
|
ロードバランサーの HTTP 動作を指定する。これは |
|
クライアント証明書ファイル |
|
クライアント検証モードを指定する。 |
|
証明書失効リストファイル |
|
TLSv1、TLSv1.1、TLSv1.2 をサポートする |
|
再起動後は保持されない動的 IP を使用する。 |
| CloudHub は、オンライン証明書状況プロトコル (OCSP) を実装しません。証明書失効リストを最新の状態に保つには、 CloudHub API を使用してプログラムで証明書を更新することをお勧めします。 |
設定に関する詳細は、「SSL エンドポイントと証明書の設定」を参照してください。
cloudhub load-balancer start
> cloudhub load-balancer start [options] <name>
このコマンドは、<name> で指定されるロードバランサーを開始します。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer stop
> cloudhub load-balancer stop [options] <name>
このコマンドは、<name> で指定されるロードバランサーを停止します。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer delete
> cloudhub load-balancer delete [options] <name>
このコマンドは、<name> で指定されるロードバランサーを削除します。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer ssl-endpoint add
> cloudhub load-balancer ssl-endpoint add [options] <name> <certificate> <privateKey>
このコマンドは、渡される証明書と非公開キーを使用して、SSL エンドポイントを <name> で指定されるロードバランサーに追加します。
| オプション | 説明 | 例 |
|---|---|---|
|
ロードバランサーの名前。 |
|
|
ローカルハードドライブの証明書の |
|
|
ローカルハードドライブの非公開キーの |
|
| CloudHub は、オンライン証明書状況プロトコル (OCSP) を実装しません。証明書失効リストを最新の状態に保つには、 CloudHub API を使用してプログラムで証明書を更新することをお勧めします。 |
このコマンドでは、デフォルトの --help、-f/--fields、-o/--output オプション以外に次のオプションも使用できます。
| オプション | 説明 |
|---|---|
clientCertificate |
クライアント証明書ファイル |
verificationMode |
クライアント検証モードを指定する。 |
crl |
証明書失効リストファイル |
tlsv1 |
TLSv1、TLSv1.1、TLSv1.2 をサポートする |
設定に関する詳細は、「SSL エンドポイントと証明書の設定」を参照してください。
cloudhub load-balancer ssl-endpoint remove
> cloudhub load-balancer ssl-endpoint remove [options] <name> <certificateName>
このコマンドは、<name> で指定されるロードバランサーから <certificateName> で指定される SSL 証明書を削除します。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer ssl-endpoint set-default
> cloudhub load-balancer ssl-endpoint set-default [options] <name> <certificateName>
このコマンドは、<name> で渡されるロードバランサーのデフォルトの証明書として <certificateName> で指定される証明書を設定します。
ロードバランサーの名前の入力を開始して tab キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、tab キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドでは、デフォルトの --help、-f/--fields、-o/--output オプション以外に次のオプションも使用できます。
| オプション | 説明 |
|---|---|
|
ロードバランサーの HTTP 動作を指定する |
cloudhub load-balancer ssl-endpoint describe
> cloudhub load-balancer ssl-endpoint describe [options] <name> <certificateName>
このコマンドは、<certificateName> で指定される証明書の <name> で渡されるロードバランサーの設定に関する情報を表示します。
ロードバランサーの名前の入力を開始して tab キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、tab キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer whitelist add
> cloudhub load-balancer whitelist add [options] <name> <cidrBlock>
このコマンドでは、<cidrBlock> で指定される IP アドレスの範囲を <name> で指定されるロードバランサーの許可リストに追加します。
| 許可リストは、CN 証明書レベルではなく、ロードバランサーレベルで動作します。 CIDR 表記の形式の IP アドレスのみを渡してください。 |
ロードバランサーの名前の入力を開始して tab キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、tab キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer whitelist remove
> cloudhub load-balancer whitelist remove <name> <cidrBlock>
このコマンドでは、<cidrBlock> で指定される IP または IP アドレスの範囲を <name> で指定されるロードバランサーの許可リストから削除します。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer allowlist add
> cloudhub load-balancer allowlist add [options] <name> <cidrBlock>
このコマンドでは、<cidrBlock> で指定される IP アドレスの範囲を <name> で指定されるロードバランサーの許可リストに追加します。
| 許可リストは、CN 証明書レベルではなく、ロードバランサーレベルで動作します。 CIDR 表記の形式の IP アドレスのみを渡してください。 |
ロードバランサーの名前の入力を開始して tab キーを押すと、Anypoint Platform CLI によって名前がオートコンプリートされます。また、tab キーをダブルタップすると、渡すことができるすべての値の完全なリストが表示されます。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
| 包括的な製品表現プログラムに準拠して、「許可リスト」という用語を使用しています。 |
cloudhub load-balancer allowlist remove
> cloudhub load-balancer allowlist remove <name> <cidrBlock>
このコマンドでは、<cidrBlock> で指定される IP または IP アドレスの範囲を <name> で指定されるロードバランサーの許可リストから削除します。
| このコマンドは、削除する前に 2 回入力を促しません。削除命令を送信する場合、確認を求められることはありません。 |
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
| 包括的な製品表現プログラムに準拠して、「許可リスト」という用語を使用しています。 |
cloudhub load-balancer mappings describe
> cloudhub load-balancer mappings describe <name> [certificateName]
このコマンドは、<name> で指定されるロードバランサーのマッピングルールをリストします。
certificateName が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを返します。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer mappings add
> cloudhub load-balancer mappings add [options] <name> <inputUri> <appName> <appUri> [certificateName]
このコマンドは、certificateName オプションで渡される CN の <name> で指定されるロードバランサーにプロキシマッピングルールを追加します。
certificateName が渡されない場合、Anypoint Platform CLI はマッピングをデフォルトの SSL エンドポイントに追加します。
| オプション | 説明 | 例 |
|---|---|---|
|
ルールが適用されるロードバランサーの名前。 |
|
|
入力 URL の URI の名前 |
example.com |
|
要求が転送される出力 URL のアプリケーションの名前 |
|
|
要求が転送される出力 URL のアプリケーションの URI |
/ |
上の例の値の場合、my-superapp.api.example.com/status?limit=10 への入力コールでアプリケーションのエンドポイント my-superapp-example: /status?limit=10 がコールされます。
このコマンドでは、--upstreamProtocol オプションも使用できます。
--upstreamProtocol オプションは、内部的にロードバランサーと通信するためにアプリケーションで使用されるプロトコルを設定します。アップストリームプロトコルが設定されていない場合、HTTP がデフォルトとして使用されます。
| オプション | 説明 |
|---|---|
|
HTTP ポート 8091 または HTTPS ポート 8092 でアップストリームアプリケーションを確認する。
サポートされている値: |
|
省略可能なパラメーター |
cloudhub load-balancer mappings remove
> cloudhub load-balancer mappings remove [options] <name> <index> [certificateName]
このコマンドは、<index> で指定される優先度インデックスおよび certificateName オプションとして指定される CN で、<name> で指定されるロードバランサーからプロキシマッピングルールを削除します。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
certificateName が渡されない場合、Anypoint Platform CLI はデフォルトの SSL エンドポイントのマッピングを削除します。
cloudhub load-balancer dynamic-ips enable
> cloudhub load-balancer dynamic-ips enable [options] <name>
このコマンドは、<name> で指定されるロードバランサーの動的 IP を有効にします。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。
cloudhub load-balancer dynamic-ips disable
> cloudhub load-balancer dynamic-ips disable [options] <name>
このコマンドは、<name> で指定されるロードバランサーの動的 IP を無効にします。
このコマンドでは、デフォルトのオプション (--help、-f/--fields、-o/--output) 以外のオプションは使用できません。