Alibaba Cloud CLI を使用した Security Center API の呼び出し - Security Center

このトピックでは、Alibaba Cloud CLI を使用して Security Center API を呼び出す方法を説明します。例として、DescribeCloudCenterInstances API を使用してアセット情報を照会します。

背景

Alibaba Cloud CLI (Alibaba Cloud Command Line Interface) は、OpenAPI に基づく汎用的なコマンドラインツールです。Alibaba Cloud CLI を使用して、Security Center の管理と保守を自動化できます。詳細については、「What is Alibaba Cloud CLI」をご参照ください。
Alibaba Cloud CLI は、Security Center (Threat Analysis) および Security Center (SOAR) の呼び出しをサポートしていません。このサポートをリクエストするには、チケットを送信してください。

手順 1：Alibaba Cloud CLI のインストール

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

Windows：Install Alibaba Cloud CLI on Windows。
Linux：Install, update, and uninstall Alibaba Cloud CLI。
macOS：Install Alibaba Cloud CLI on macOS。

Cloud Shell で Alibaba Cloud CLI コマンドをデバッグすることもできます。Cloud Shell には Alibaba Cloud CLI がプリインストールされており、ソフトウェアバージョンが定期的に更新されます。詳細については、「What is Cloud Shell」をご参照ください。

手順 2：Alibaba Cloud CLI の設定

重要

Alibaba Cloud アカウント (ルートアカウント) は、すべての OpenAPI 操作に対する完全な管理権限とアクセス権限を持つため、セキュリティリスクが高くなります。RAM ユーザーを作成し、最小権限の原則に基づいて権限を付与し、RAM ユーザーを使用して OpenAPI にアクセスすることを推奨します。Security Center でサポートされる権限ポリシーについては、「Security Center system access policy reference」および「Custom policies for Security Center」をご参照ください。

Alibaba Cloud CLI を使用する前に、認証情報とリージョン ID を設定してください。Alibaba Cloud CLI は複数の認証情報をサポートしています。詳細については、「Configure and manage credentials」をご参照ください。RAM ユーザーの AccessKey を使用して、AK タイプの認証情報を設定できます。次の手順を実行してください。

RAM ユーザーを作成し、認証情報の設定に使用する AccessKey を作成します。詳細については、「Create a RAM user」および「Create an AccessKey」をご参照ください。
RAM ユーザーに権限を付与します。この例では、Security Center に対する読み取り専用のアクセス権限 (AliyunYundunSASReadOnlyAccess) が必要です。詳細については、「Manage RAM user permissions」をご参照ください。
認証情報の設定に使用する利用可能なリージョン ID を取得します。Alibaba Cloud CLI は、指定されたリージョンを使用して OpenAPI 呼び出しを行います。Security Center の利用可能なリージョンについては、「Endpoints」をご参照ください。
説明
コマンド実行時に --region オプションを使用してリージョンを指定できます。このオプションは、デフォルトの認証情報および環境変数に含まれるリージョン情報を上書きします。詳細については、「Command-line options」をご参照ください。
RAM ユーザーの AccessKey を使用して AK タイプの認証情報を設定します。設定ファイル名は AkProfile とします。詳細については、「Configure and manage credentials」をご参照ください。

手順 3：CLI コマンド例の生成

OpenAPI ポータルで、DescribeCloudCenterInstances debugging page に移動します。
[Parameters] でリクエストパラメーターを指定します。[CLI Sample] タブをクリックして、生成された CLI の例を確認します。
CLI の例をコピーするか、Cloud Shell で実行します：
- [Run Command] をクリックして Cloud Shell を開き、コマンドをデバッグします。
- [Copy] をクリックして、CLI の例をクリップボードにコピーします。その後、ローカルのシェルツールに貼り付けて実行するか、コマンドラインスクリプトを作成できます。
説明
デバッグのために CLI の例をローカルのシェルツールにコピーする場合は、パラメーター形式に注意してください。CLI コマンドのパラメーター形式の詳細については、「Understand command parameters」をご参照ください。
OpenAPI ポータルは、生成された例にデフォルトで --region オプションを追加します。コマンドをローカルで実行するためにコピーすると、Alibaba Cloud CLI はデフォルトの認証情報および環境変数に含まれるリージョン情報を無視し、代わりに指定されたリージョンを使用します。必要に応じて、このオプションを削除するか保持してください。

手順 4： Security Center OpenAPI の呼び出し

例 1：Alibaba Cloud CLI でサポートされる Security Center OpenAPI 操作の一覧表示

次の例は、--help オプションを使用して、Alibaba Cloud CLI でサポートされる Security Center OpenAPI 操作を一覧表示する方法を示します。詳細については、「API overview」をご参照ください。

次のコマンドを実行します。
```
aliyun sas --help
```

サンプルレスポンス。

Product: Sas (Security Center)
Version: 2018-12-03
Available Api List:
    AddAssetSelectionCriteria          Adds assets to an asset selection operation.
    AddBaselineCheckWhiteRecord
    AddCheckInstanceResultWhiteList    Adds instances to the allowlist for a check item.
    AddCheckResultWhiteList            Adds a check item to the allowlist.
    AddClientUserDefineRule            Creates a user-defined defense rule.
    AddCloudVendorAccountAK
    AddContainerDefenseRule            Creates a non-image program defense rule.
    AddContainerPluginRule             Adds a container escape prevention rule.
    AddIdcProbe
    AddImageEventOperation             Adds an image alert handling rule.
    AddImageVulWhiteList               Adds an image vulnerability to the allowlist.
    AddInstallCode                     Creates an agent installation command.

例 2：アセット情報の照会

次の例は、Alibaba Cloud CLI を使用して Security Center の DescribeCloudCenterInstances API を呼び出し、リスクがある Elastic Compute Service (ECS) のアセット情報を照会する方法を示します。

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

aliyun sas DescribeCloudCenterInstances --Criteria '[{"name":"riskStatus","value":"YES"}]' --MachineTypes ecs

サンプルレスポンス。

{
  "Success": true,
  "PageInfo": {
    "Count": 10,
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 10,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "RequestId": "7D6FD965-745C-5580-A3E8-83FEC3BE1FE8",
  "Instances": [
    {
      "AlarmStatus": "NO",
      "AssetType": "0",
      "AssetTypeName": "ECS Instance",
      "AuthVersionName": "Basic Edition",
      "Bind": false,
      "ClientStatus": "online",
      "Cores": 4,
      "CpuInfo": "Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz",
      "ExposedStatus": 0,
      "Flag": 0,
      "FlagName": "ALIYUN",
      "GroupId": 1355****,
      "GroupTrace": "Ungrouped",
      "HcStatus": "YES",
      "HealthCheckCount": 0,
      "Importance": 1,
      "InstanceId": "i-bp1b84nxki0g2cyg****",
      "InstanceName": "example",
      "InternetIp": "",
      "IntranetIp": "172.16.****",
      "Ip": "172.16.****",
      "IpListString": "172.16.****",
      "Kernel": "5.10.134-16.3.al8.x86_64",
      "LastLoginTimestamp": 1729840886000,
      "MacListString": "00:16:3e:**:**:**",
      "Mem": 16384,
      "Os": "linux",
      "OsName": "Alibaba Cloud Linux 3.2104 LTS 64-bit",
      "Region": "cn-hangzhou-dg-a01",
      "RegionId": "cn-hangzhou",
      "RegionName": "China (Hangzhou)",
      "RiskCount": "{\"account\":0,\"agentlessAll\":0,\"agentlessBaseline\":0,\"agentlessMalicious\":0,\"agentlessSensitiveFile\":0,\"agentlessVulCve\":0,\"agentlessVulSca\":0,\"agentlessVulSys\":0,\"appNum\":0,\"asapVulCount\":0,\"baselineHigh\":0,\"baselineLow\":0,\"baselineMedium\":0,\"baselineNum\":1,\"cmsNum\":0,\"containerAsap\":0,\"containerLater\":0,\"containerNntf\":0,\"containerRemind\":0,\"containerSerious\":0,\"containerSuspicious\":0,\"cveNum\":4,\"emgNum\":0,\"health\":0,\"imageBaselineHigh\":0,\"imageBaselineLow\":0,\"imageBaselineMedium\":0,\"imageBaselineNum\":0,\"imageMaliciousFileRemind\":0,\"imageMaliciousFileSerious\":0,\"imageMaliciousFileSuspicious\":0,\"imageVulAsap\":0,\"imageVulLater\":0,\"imageVulNntf\":0,\"laterVulCount\":1,\"newSuspicious\":0,\"nntfVulCount\":3,\"remindNum\":0,\"seriousNum\":0,\"suspNum\":0,\"suspicious\":0,\"sysNum\":0,\"trojan\":0,\"uuid\":\"11c50347-4745-4a7a-b8dd-405f276201ff\",\"vul\":4,\"weakPWNum\":0}",
      "RiskStatus": "YES",
      "SafeEventCount": 0,
      "Status": "Running",
      "Uuid": "11c50347-4745-4a7a-b8dd-405f****",
      "Vendor": 0,
      "VendorName": "ALIYUN",
      "VpcInstanceId": "vpc-bp132a80775r3d7kz****",
      "VulCount": 4,
      "VulStatus": "YES"
    }
  ]
}

説明

Security Center OpenAPI の呼び出しでエラーが返された場合は、エラーコードに基づいてリクエストパラメーターとその値を確認してください。

また、レスポンスから RequestID または SDK エラーメッセージを記録し、Alibaba Cloud OpenAPI Diagnostics を使用して、セルフサービスのトラブルシューティングを実行することもできます。