Alibaba Cloud CLIを使用したCloud Firewallリソースの管理 - Cloud Firewall

Alibaba Cloud CLIは、OpenAPI仕様に基づいて開発された汎用のコマンドラインツールです。 Alibaba Cloud CLIを使用して、Cloud Firewallリソースの自動管理とメンテナンスを実装できます。このトピックでは、DescribeNatFirewallList操作を例として使用し、Alibaba Cloud CLIを使用してCloud FirewallのAPI操作を呼び出す方法を説明します。 DescribeNatFirewallList操作は、NATファイアウォールの詳細を照会するために使用されます。

始める前に

Alibaba Cloud CLIに慣れてください。詳細については、「Alibaba Cloud CLI とは何か」をご参照ください。

Alibaba Cloud CLIのインストール

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIをインストールする必要があります。 Alibaba Cloud CLIは、Windows、Linux、およびmacOSオペレーティングシステムにインストールできます。デバイスのオペレーティングシステムに基づいて、Alibaba Cloud CLIのインストールパッケージを選択する必要があります。詳細については、以下のトピックをご参照ください。

Windowsオペレーティングシステム: Windows
Linuxオペレーティングシステム: Linux
macOSオペレーティングシステム: macOS

Alibaba Cloudが提供するCloud Shellを使用して、Alibaba Cloud CLIで実行するコマンドをデバッグすることもできます。 Cloud Shellの詳細については、Cloud Shellとは

Alibaba Cloud CLI の設定

重要

Alibaba Cloudアカウントには、すべてのAlibaba CloudサービスのAPIを管理およびアクセスする権限があります。 Alibaba Cloudアカウントを使用してAPI操作を呼び出すと、セキュリティリスクが発生する可能性があります。 RAM (Resource Access Management) IDを作成し、最小権限の原則に基づいてRAM IDに必要な権限を付与し、RAM IDを使用してAPI操作を呼び出すことをお勧めします。 Cloud Firewallでサポートされているポリシーの詳細については、「システムポリシー」および「カスタムポリシー」をご参照ください。

Alibaba Cloud CLIを使用する前に、Alibaba Cloud CLIでID資格情報やリージョンIDなどの情報を設定する必要があります。 Alibaba Cloud CLIは、さまざまなタイプのID資格情報をサポートしています。詳細については、「資格情報の種類」をご参照ください。この例では、AccessKeyペアがID資格情報として使用されます。

RAMユーザーを作成し、RAMユーザーがID資格情報を設定するためのAccessKeyペアを作成します。詳細については、「RAM ユーザーの作成」および「AccessKeyペアの作成」をご参照ください。
RAM ユーザーに必要な権限を付与します。この例では、AliyunYundunCloudFirewallReadOnlyAccessポリシーがRAMユーザーにアタッチされています。ポリシーは、Cloud Firewallに対する読み取り専用権限を付与します。詳細については、「RAM ユーザーへの権限の付与」をご参照ください。
使用するリージョンのIDを取得します。 Alibaba Cloud CLIは、指定したリージョンIDを使用してAPI呼び出しを開始します。 Cloud Firewallでサポートされているリージョンの詳細については、「エンドポイント」をご参照ください。
説明
Alibaba Cloud CLIを使用する場合、-- regionオプションを使用して、呼び出しを開始するリージョンを指定できます。このオプションを使用してリージョンを指定すると、Alibaba Cloud CLIはデフォルトの資格情報設定と環境変数のリージョン情報を無視します。詳細については、「API呼び出しのコマンドラインオプション」をご参照ください。
RAMユーザーのAccessKeyペアを使用して、AkProfile設定ファイルでID資格情報を設定します。詳細については、「構成例」をご参照ください。

サンプルCLIコマンドの生成

OpenAPI Explorerで、 DescribeNatFirewallList操作。
[パラメーター] タブで、パラメーターを設定します。次に、[CLIの例] タブをクリックして、生成されたサンプルCLIコマンドを表示します。
CLIコマンドをコピーするか、Cloud ShellでCLIコマンドをデバッグします。
- アイコンをクリックしてCloud Shellを起動し、Cloud ShellでCLIコマンドをデバッグします。
- アイコンをクリックして、CLIコマンドをクリップボードにコピーします。 CLIコマンドをオンプレミスシェルに貼り付けて、コマンドを実行することもできます。
  説明
  - CLIコマンドをオンプレミスのシェルに貼り付けてデバッグするときは、パラメーターの形式に注意してください。 Alibaba Cloud CLIで必要なパラメーター形式の詳細については、「パラメーター形式」をご参照ください。
  - デフォルトでは、OpenAPI Explorerは、生成されたCLIコマンドに -- regionオプションを追加します。コマンドをオンプレミスシェルにコピーすると、Alibaba Cloud CLIはデフォルトのID資格情報設定と環境変数のリージョン情報を無視し、オプションで指定されたリージョンでコマンドを実行します。ビジネス要件に基づいてオプションを削除または保持できます。

Cloud FirewallのAPI操作の呼び出し

例1: Alibaba Cloud CLIを使用したCloud FirewallのサポートされているAPI操作の照会

次のサンプルコードでは、-- helpオプションを使用してCloud FirewallのサポートされているAPI操作を照会する方法の例を示します。サポートされているAPI操作を表示できます。詳細については、「関数別の操作の一覧」をご参照ください。

以下のコマンドを実行します。
```
aliyun cloudfw --help
```
出力を表示します。

例2: NATファイアウォールの詳細の照会

次のサンプルコードは、Alibaba Cloud CLIを使用してCloud FirewallのDescribeNatFirewallList操作を呼び出す方法の例を示しています。この操作は、NATファイアウォールの詳細を照会するために使用されます。

以下のコマンドを実行します。

aliyun cloudfw DescribeNatFirewallList \
  --region cn-hangzhou \
  --Lang zh \
  --PageNo 1 \
  --PageSize 10 \
  --ProxyId 'proxy-nat97a******' \
  --RegionNo 'cn-hangzhou'

出力を表示します。

{
  "TotalCount": 10,
  "RequestId": "15FCCC52-1E23-57AE-B5EF-3E00A3******",
  "NatFirewallList": [
    {
      "MemberUid": 0,
      "AliUid": 0,
      "ProxyId": "proxy-nat97a******",
      "ProxyName": "Test NAT firewall",
      "ProxyStatus": "normal",
      "RegionId": "cn-hangzhou",
      "NatGatewayId": "ngw-uf6tnblxip4qcxg******",
      "NatGatewayName": "Test NAT gateway",
      "VpcId": "vpc-2ze26ya******",
      "VpcName": "Test VPC",
      "ErrorDetail": "Failed to create the firewall",
      "StrictMode": 0,
      "NatRouteEntryList": [
        {
          "RouteTableId": "vtb-bp18o0gb******",
          "NextHopId": "ngw-2ze0s284r9atg5******",
          "NextHopType": "NatGateway",
          "DestinationCidr": "0.0.0.0/0"
        }
      ]
    }
  ]
}

説明

Cloud FirewallのAPIを呼び出した後にエラーが返された場合は、エラーコードに基づいて入力パラメーターと値が有効かどうかを確認してください。

を使用することもできます。 Alibaba Cloud OpenAPI Diagnosticsは、返されたリクエストIDまたはSDKエラー情報に基づいてセルフサービス診断を実行します。