Alibaba Cloud CLI を使用した Cloud Firewall の管理 - Cloud Firewall

Alibaba Cloud CLI (Alibaba Cloud コマンドラインインターフェイス) は、OpenAPI 上に構築された汎用コマンドラインツールです。Alibaba Cloud CLI を使用して、Cloud Firewall の管理とメンテナンスを自動化できます。このトピックでは、DescribeNatFirewallList API オペレーションを例として、Alibaba Cloud CLI を使用して Cloud Firewall の API オペレーションを呼び出し、NAT ファイアウォールの詳細をクエリする方法について説明します。

事前準備

Alibaba Cloud CLI について理解しておいてください。詳細については、「Alibaba Cloud CLI とは」をご参照ください。

Alibaba Cloud CLI のインストール

Alibaba Cloud CLI を使用するには、まずインストールする必要があります。Alibaba Cloud CLI は、Windows、Linux、macOS をサポートしています。ご利用のオペレーティングシステムに基づいてインストール方法を選択してください。

Windows： Windows への Alibaba Cloud CLI のインストール
Linux： Alibaba Cloud CLI のインストールまたは更新
macOS： macOS への Alibaba Cloud CLI のインストール

また、Cloud Shell を使用して Alibaba Cloud CLI コマンドを実行し、デバッグすることもできます。Cloud Shell の詳細については、「Cloud Shell とは」をご参照ください。

Alibaba Cloud CLI の設定

重要

Alibaba Cloud アカウント (root ユーザー) は、すべての Alibaba Cloud サービスの API を管理およびアクセスするための完全な権限を持っているため、高いセキュリティリスクがあります。RAM ID を作成し、最小権限の原則に基づいて RAM ID に権限を付与してから、その RAM ID を使用して API オペレーションを呼び出すことを推奨します。Cloud Firewall でサポートされている権限ポリシーの詳細については、「Cloud Firewall のシステム権限ポリシーリファレンス」および「Cloud Firewall のカスタム権限ポリシーリファレンス」をご参照ください。

認証情報とリージョン ID を設定する必要があります。Alibaba Cloud CLI は、複数の種類の認証情報をサポートしています。詳細については、「認証情報の設定と管理」をご参照ください。このトピックでは、AccessKey ベースの認証情報を例として説明します。次の手順に従ってください。

RAM ユーザーを作成し、そのユーザーの AccessKey ペアを作成します。この AccessKey ペアを使用して認証情報を設定します。詳細については、「RAM ユーザーの作成」および「AccessKey ペアの作成」をご参照ください。
RAM ユーザーに権限を付与します。この例では、AliyunYundunCloudFirewallReadOnlyAccess 権限ポリシーをアタッチして、RAM ユーザーに Cloud Firewall への読み取り専用アクセス権を付与する必要があります。詳細については、「RAM ユーザーへの権限付与」をご参照ください。
利用可能なリージョン ID を取得します。CLI は、指定したリージョンに API リクエストを送信します。Cloud Firewall が利用可能なリージョンの詳細については、「エンドポイント」をご参照ください。

説明
Alibaba Cloud CLI を使用する場合、コマンドに --region オプションを追加して、リクエストのリージョンを指定できます。このオプションは、デフォルトの認証情報と環境変数で設定されたリージョンをオーバーライドします。詳細については、「OpenAPI のコマンドラインオプション」をご参照ください。
RAM ユーザーの AccessKey ペアを使用して認証情報を設定します。設定プロファイルに AkProfile という名前を付けます。詳細については、「認証情報の設定と管理」をご参照ください。

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

OpenAPI Explorer で、DescribeNatFirewallList API オペレーションを開きます。
[パラメーター] タブでリクエストパラメーターの値を入力し、[CLI の例] タブをクリックしてサンプルコマンドを表示します。
コマンドサンプルをコピーするか、Cloud Shell で直接実行します。
- [コマンドの実行] ボタンをクリックして Cloud Shell を開き、コマンドをすばやくデバッグします。
- [コピー] ボタンをクリックして、サンプルコマンドをクリップボードにコピーします。その後、ローカルシェルに貼り付けて実行できます。
  説明
  - CLI の例をローカルシェルにコピーしてデバッグする場合は、パラメーターが必須の形式に従っていることを確認してください。詳細については、「パラメーター形式」をご参照ください。
  - デフォルトでは、OpenAPI Explorer によって生成されたコマンドサンプルには --region オプションが含まれています。コマンドをローカルで実行すると、Alibaba Cloud CLI はこのオプションで指定されたリージョンを使用し、デフォルトの認証情報と環境変数で設定されたリージョンを無視します。このオプションを削除して、デフォルトの認証情報で設定されたリージョンを使用できます。

呼び出し Cloud Firewall API

例 1：Cloud Firewall API の一覧表示

次の例では、--help オプションを使用して、サポートされている Cloud Firewall API オペレーションを一覧表示する方法を示します。サポートされているすべての API オペレーションは、「API 概要」でも確認できます。

コマンドを実行します。
```
aliyun cloudfw --help
```

出力例：

Product: Cloudfw (Cloud Firewall)
Version: 2017-12-07
Available Api List:
  AddAddressBook                          Adds an address book, including an IP address book, an ECS tag address book, a port address book, and a domain name address book.
  AddControlPolicy                        Adds an access control policy.
  AddInstanceMembers                      Adds member accounts to Cloud Firewall.
  BatchCopyVpcFirewallControlPolicy       Copies all policies from a source VPC firewall policy group to a destination VPC firewall policy group.
  BatchDeleteVpcFirewallControlPolicy
  CreateDownloadTask
  CreateNatFirewallControlPolicy          Adds an access control policy for a nat firewall.
  CreateSecurityProxy
  CreateSlsLogDispatch
  CreateTrFirewallV2                      Creates a transit router (TR) firewall.

例 2：NAT ファイアウォールの詳細のクエリ

次の例では、Alibaba Cloud CLI を使用して Cloud Firewall の DescribeNatFirewallList API オペレーションを呼び出し、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": "nat-firewall-test",
      "ProxyStatus": "normal",
      "RegionId": "cn-hangzhou",
      "NatGatewayId": "ngw-uf6tnblxip4qcxg******",
      "NatGatewayName": "NAT-gateway-test",
      "VpcId": "vpc-2ze26ya******",
      "VpcName": "vpc-test-instance",
      "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 呼び出しでエラーが返された場合は、返されたエラーコードを使用して、リクエストパラメーターとその値が有効か検証してください。

また、応答または SDK エラーメッセージから RequestId を記録し、Alibaba Cloud OpenAPI 診断を使用して問題を診断することもできます。