SOAP APIからの移行
廃止予定のSOAP APIを使用するコードを移行し、Deep Security 11.1で導入されたAPIを使用して、新機能と継続的なサポートを利用できるようにします。SOAP APIはDeep Security 11.1で廃止されました。SOAP APIの機能は変更されていませんが、SOAP APIを介して新しいWorkload Security機能にアクセスすることはできません。
Workload Security APIは、SOAP APIのすべての機能を提供するわけではありません。ただし、これらの機能の一部にREST APIを使用できます。詳細については、 Capabilities のセクションを参照してください。
移行を準備するには、API間の用語の違い、必要なタスク、クラスの構造、および機能の違いを理解しておく必要があります。この情報を確認したら、Workload Security AutomationガイドをDeep Security APIの概要として使用することをお勧めします。
用語集
SOAP APIのリリース以降に一部の製品用語が変更されています。APIを比較する際は、次の点に注意してください。
SOAP API用語 | Deep Security API用語 |
---|---|
ホスト | コンピュータ |
セキュリティプロファイル | ポリシー |
Deep パケットインスペクション (DPI) | 侵入防御 |
特定のタスク
SOAP APIから移行する際に、必要なタスクの一部が別の方法で実行されているか、必要なくなったことがわかります。
タスク | SOAP API | Deep Security API |
---|---|---|
認証 | Webサービスエンドポイントへのアクセスが許可されているWebサービス管理者アカウントとユーザの役割を作成します。アカウントのアカウント情報を使用して、通話を認証します。 | APIキーを作成し、機能のアクセスを決定するユーザの役割に関連付けます。コールを認証するには、APIキーの秘密鍵を使用します。Workload Security自動化ガイドに向けた最初のステップのAuthenticate with Workload Securityを参照してください。 |
エンドポイントを有効にする | Workload SecurityでWebサービスAPIを有効にします。 | Deep Security APIエンドポイントは常に有効です。処理は必要ありません。 |
クライアントライブラリを取得する | WSDLファイルからクライアントスタブを生成します。 | SDKをダウンロードしてください。 |
Javaクラス構造
WSDLファイルから生成されるJavaスタブとDeep Security APIのJava SDKは、同様の種類のJavaクラスを提供します。ただし、クラスは構造が異なります。
Javaスタブクラスの種類 | Deep Security API(Java SDK) |
---|---|
トランスポートクラス | com.trendmicro.deepsecurity.model パッケージ内のクラスは、ポリシー、コンピュータ、ルールなど、Workload Security環境内の項目を表します。値を格納およびアクセスするには、これらのクラスを使用します。 |
Enumクラス | Enumクラスは、モデルパッケージのクラスにネストされます。 |
Webメソッド(Managerエンドポイントの操作) | com.trendmicro.deepsecurity.api パッケージに含まれるクラスは、多くのモデルクラスで動作する作成、読み取り、更新、削除、リスト、検索の各機能を提供します。 |
機能
Deep Security WebサービスSDKのPDFには、SOAP APIの機能がリストされています。次の表は、機能を提供するJava SDKのクラス、またはDeep Security APIが機能をサポートしていないことを示しています。一部のサポート対象外の機能については、以前リリースされたREST APIを使用できます。(タスク Workload Security APIを使用してタスクを自動化するを参照してください。)
エンドポイントが Workload Security APIに継続して追加されています。定期的にこのテーブルの変更を確認してください。
カテゴリ | 能力 | Java SDK / Deep Security APIの可用性 |
---|---|---|
セキュリティプロファイル(ポリシー) | ポリシーの取得、追加、更新、編集、および削除 | com.trendmicro.deepsecurity.api.PoliciesApi
APIリファレンスの Policies エンドポイントを参照してください。 |
セキュリティモジュール(ファイアウォール, 不正プログラム対策など)の実行状態をポリシーレベルで設定する | com.trendmicro.deepsecurity.api.PoliciesApi
APIリファレンスの Policies エンドポイントを参照してください。 |
|
ポリシーレベルでの ファイアウォール、侵入検知、 変更監視、および セキュリティログ監視 ルールの割り当てと割り当て解除 | com.trendmicro.deepsecurity.api.PoliciesApi
APIリファレンスの Policies エンドポイントを参照してください。 |
|
ポリシーレベルでのシステム設定の取得、設定、およびクリア | com.trendmicro.deepsecurity.api.PoliciesApi
APIリファレンスの Policies エンドポイントを参照してください。 |
|
不正プログラム対策 | 不正プログラム検索設定の取得、追加、アップデート、および削除 | com.trendmicro.deepsecurity.api.AntiMalwareConfigurationsApi
APIリファレンスの 不正プログラム対策 の設定 エンドポイントを参照してください。 |
ディレクトリリストの追加、更新、および削除 | com.trendmicro.deepsecurity.api.DirectoryListsApi
APIリファレンスの ディレクトリリスト エンドポイントを参照してください。 |
|
ファイルリストの追加、更新、および削除 | com.trendmicro.deepsecurity.api.FileListsApi
APIリファレンスの ファイルリスト エンドポイントを参照してください。 |
|
ファイル拡張子リストの追加、更新、および削除 | com.trendmicro.deepsecurity.api.FileExtensionListsApi
APIリファレンスの ファイル拡張子リスト エンドポイントを参照してください。 |
|
不正プログラム対策 イベントの取得 | 利用できません。
REST APIの 不正プログラム対策 イベントエンドポイントを使用します。 |
|
Webレピュテーション | Webレピュテーション 設定の取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.PoliciesAPI andcom.trendmicro.deepsecurity.model.PolicySettings
APIリファレンスの Policies エンドポイントを参照してください。 |
Webレピュテーション イベントの取得 | 利用できません。 REST APIの Webレピュテーション イベントエンドポイントを使用します。 | |
ファイアウォール | ファイアウォール ルールの取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.FirewallRulesApi
APIリファレンスの ファイアウォール Rules エンドポイントを参照してください。 |
ステートフルな設定の取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.StatefulConfigurationsApi
APIリファレンスの ステートフルコンフィグレーション エンドポイントを参照してください。 |
|
ファイアウォール イベントの取得 | 利用できません。 | |
Deep パケットインスペクション (侵入防御) | Deep パケットインスペクション ルールの取得、追加、アップデート、および削除 | com.trendmicro.deepsecurity.api.IntrusionPreventionRulesApi
「APIリファレンス」の 侵入防御 ルール エンドポイントを参照してください。 |
アプリケーションの種類の取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.ApplicationTypesApi
APIリファレンスの アプリケーションタイプ エンドポイントを参照してください。 |
|
アプリケーションタイプのオーバーライドの取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.ComputerIntrusionPreventionApplicationTypeDetailsApi
com.trendmicro.deepsecurity.api.PolicyIntrusionPreventionApplicationTypeDetailsApi
APIリファレンスのコンピュータ侵入防御アプリケーションの種類の詳細およびポリシー侵入防御アプリケーションの種類の詳細の操作を参照してください。 |
|
Deep Package Inspectionイベントの取得 | 使用不可 | |
変更監視とアプリケーションコントロール | 変更監視 ルールの取得、追加、更新、削除 | com.trendmicro.deepsecurity.api.IntegrityMonitoringRulesApi
APIリファレンスの 変更監視 ルール エンドポイントを参照してください。 |
コンピュータで[整合性変更の検索]を開始する | 使用不可 | |
コンピュータでベースラインの再構築を開始する | 使用不可 | |
変更監視 イベントの取得 | 使用不可
REST APIの 変更監視 イベントエンドポイントを参照してください。 |
|
セキュリティログ監視 | セキュリティログ監視 ルールの取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.LogInspectionRulesApi
「APIリファレンス」の セキュリティログ監視 ルール エンドポイントを参照してください。 |
セキュリティログ監視 デコーダの取得、追加、更新、および削除 | 使用不可 | |
セキュリティログ監視 イベントの取得 | 使用不可
REST APIの セキュリティログ監視 イベントエンドポイントを参照してください。 |
|
リスト | IPリスト、MACリスト、およびポートリストの取得、追加、アップデート、および削除 | com.trendmicro.deepsecurity.api.IpListsApi com.trendmicro.deepsecurity.api.MacListsApi com.trendmicro.deepsecurity.api.PortListsApi APIリストのIPリスト、MACリスト、および ポートリスト のエンドポイントを参照してください。 |
Schedules | スケジュールの取得、追加、更新、および削除 | com.trendmicro.deepsecurity.api.SchedulesApi
API レファレンス/参照情報の Schedules エンドポイントを参照してください。 |
ホスト(コンピュータ) | コンピュータの取得、追加、アップデート、削除 | com.trendmicro.deepsecurity.api.ComputersApi
APIリファレンスの Computers エンドポイントを参照してください。 |
ポリシーの割り当てまたは割り当て解除 | com.trendmicro.deepsecurity.api.ComputersApi
APIリファレンスの Computers エンドポイントを参照してください。 |
|
コンピュータレベルでのシステム設定の取得または設定 | com.trendmicro.deepsecurity.api.ComputersApi
APIリファレンスの Computers エンドポイントを参照してください。 |
|
コンピュータのアクティベート、無効化、ロック、アンロック | 使用不可 | |
コンピュータのステータスを取得する | com.trendmicro.deepsecurity.model.ComputersApi::computerStatus
APIリファレンスの Computers エンドポイントを参照してください。 |
|
コンピュータイベントの取得 | 使用不可 | |
セキュリティ更新プログラムまたはエージェントのバージョンアップを開始する | 使用不可 | |
グループ(コンピュータグループ) | コンピュータグループの取得、追加、更新、削除、および移動 | com.trendmicro.deepsecurity.api.ComputerGroupsApi
API レファレンス/参照情報の Computer Groups エンドポイントを参照してください。 |
システム | グローバルシステム設定の取得および設定 | com.trendmicro.deepsecurity.api.SystemSettingsApi
APIリファレンスの System Settings エンドポイントを参照してください。 |
システム情報の取得 | 使用不可 | |
システムイベントの取得 | 使用不可 | |
License | ライセンスの取得とアップデート | 使用不可
REST APIのLicensesエンドポイントを参照してください。 |
アップデート | セキュリティセンターの顧客アカウントに対する操作 | 使用不可 |
セキュリティ更新プログラムの操作 | 使用不可 | |
エージェントまたはアプライアンスソフトウェアに対する操作 | 使用不可 | |
ダッシュボード | ダッシュボードウィジェットのカウンタの取得 | 使用不可 |
システムの機能概要の取得 | 使用不可 | |
システム全体のコンピュータおよびアラートのステータスを取得する | 使用不可 |
システムイベントとセキュリティイベントを外部のSyslogサーバまたはセキュリティ情報およびイベント管理(SIEM)サーバに転送することをお勧めします。システム監視およびレポートのイベントの処理を参照してください。
関連するコード例
次の表は、高度に使用されるSOAP APIエンドポイントと、このガイドに含まれる関連するコード例を示しています。サンプルを使用して、新しいAPIまたはSDKを使用するようにコードを翻訳する方法に関するアイディアを作成します。
SOAP APIエンドポイント | Workload Security APIの操作 | 関連するコード例 |
---|---|---|
securityProfileRetrieve | ポリシーの説明 | 侵入防御ルールをコンピュータのポリシーに追加する |
securityProfileRetrieveByName | 検索ポリシー、またはポリシーの説明 | ポリシーを検索してコンピュータに追加する |
IPListRetrieve | 侵入防御 ルールのリスト | CVEの 侵入防御 ルールを検索する |
hostDetailRetrieve | リストのコンピュータ | コンピュータの設定を取得する |
hostRetrieve | コンピュータの説明 | コンピュータのオーバーライドを取得する |
認証する | N/A | リストポリシー |
securityProfileSave | ポリシーの作成 ポリシーの変更 | 基本ポリシーの下にポリシーを作成する |
securityProfileAssignToHost | コンピュータの変更 | ポリシーを検索してコンピュータに追加する |