AliyunCloudOpenAPI コンポーネント - Security Center - Alibaba Cloud ドキュメントセンター

AliyunCloudOpenAPI コンポーネントは、主に Alibaba Cloud OpenAPI を呼び出すために使用されます。

機能説明

操作	説明	シナリオ
assumeApi	ロール偽装を通じて Alibaba Cloud OpenAPI を呼び出します。	Alibaba Cloud OpenAPI を呼び出します。

構成例

このトピックでは、AliyunCloudOpenAPI コンポーネントの各アクションのパラメーター構成例を提供します。これらの例は、テストプレイブックとしてインポートできます。ビジュアルワークフローエディターを使用すると、各アクションの構成パラメーターを直感的に理解してテストできるため、コンポーネントの機能ロジックと使用方法を簡単に把握できます。

説明

サンプルデータを最初に JSON ファイルとして保存してから、エディターにインポートしてください。

サンプルデータ

{
    "cells": [
        {
            // プレイブック開始ノード。プレイブックには開始ノードが 1 つだけ必要です。プレイブックの入力データ構成が必要です。
            "position": {
                "x": -590,
                "y": -170
            },
            "size": {
                "width": 36,
                "height": 36
            },
            "attrs": {
                "body": {
                    "fill": "white",
                    "strokeOpacity": 0.95,
                    "stroke": "#63ba4d",
                    "strokeWidth": 2
                },
                "label": {
                    "text": "start",
                    "fontSize": 12,
                    "refX": 0.5,
                    "refY": "100%",
                    "refY2": 4,
                    "textAnchor": "middle",
                    "textVerticalAnchor": "top"
                },
                "path": {
                    "stroke": "#63ba4d"
                }
            },
            "visible": true,
            "shape": "circle",
            "id": "58d87b7d-28d9-4f0e-b135-4adc4f1a70e4",
            "zIndex": 1,
            "data": {
                "nodeType": "startEvent",
                "appType": "basic",
                "nodeName": "start",
                "icon": "icon-circle",
                "description": "Playbook start node. A playbook must have one and only one start node, which requires input data configuration for the playbook."
            },
            "markup": [
                {
                    "tagName": "circle",
                    "selector": "body"
                },
                {
                    "tagName": "text",
                    "selector": "label"
                }
            ],
            "isNode": true
        },
        // シーケンスフロー
        {
            "shape": "custom-edge",
            "attrs": {
                "line": {
                    "stroke": "#63ba4d",
                    "targetMarker": {
                        "stroke": "#63ba4d"
                    }
                }
            },
            "zIndex": 1,
            "id": "5293c3f9-e1c9-4a49-b0eb-635067dc67e8",
            "data": {
                "nodeType": "sequenceFlow",
                "appType": "basic",
                "isRequired": true,
                "icon": "icon-upper-right-arrow"
            },
            "isNode": false,
            "source": {
                "cell": "58d87b7d-28d9-4f0e-b135-4adc4f1a70e4"
            },
            "target": {
                "cell": "1776030c-a880-4278-985d-372aa1245097"
            },
            "visible": true,
            "router": {
                "name": "manhattan",
                "args": {
                    "padding": 5,
                    "excludeHiddenNodes": true,
                    "excludeNodes": [
                        "clone_node_id"
                    ]
                }
            },
            "vertices": []
        },

assumeApi

コンポーネントは次のように構成されます。

重要

クラウドサービスの API を選択した後、適切な権限ポリシーがアタッチされているかどうかを確認します。アタッチされていない場合は、最初に必要な権限を付与します。

クラウドサービスを選択する

基本情報タブで、Alibaba Cloud サービス領域にある対応するクラウドサービスをクリックします。あいまい一致を使用してサービス名を検索できます。

API を選択する

クラウドサービスを選択すると、そのサービスでサポートされている API のリストが自動的に表示されます。API 名をクリックして選択します。

API パラメーターを構成する

API を選択すると、API パラメーター構成ページが自動的に表示されます。構成ボタンをクリックして構成ページにアクセスすることもできます。

API パラメーターを構成する

Alibaba Cloud アカウント

Alibaba Cloud アカウントは、デフォルトで現在ログインしているクラウドアカウントの UID になります。式 ${event._tenant_id} を使用して、この UID を取得できます。
ログインアカウントに複数のメンバーアカウントが構成されている場合は、ここにメンバーアカウントの UID を入力できます。メンバーアカウントの UID を表示するには、「複数アカウント管理機能を使用する」または DescribeMonitorAccounts API を使用します。

サーバーアドレス

[推奨アドレス] をクリックすると、システム推奨のアドレスを取得できます。一般的な推奨アドレスは次のとおりです。

重要

推奨アドレスは参考用です。各クラウドサービスのエンドポイントドキュメントについては、Alibaba Cloud 公式ドキュメントにアクセスして、正確な情報を入手することをお勧めします。

[ProductCode].[RegionId].aliyuncs.com (例: ecs.ap-southeast-2.aliyuncs.com)
[ProductCode].aliyuncs.com (例: ram.aliyuncs.com)

パラメーター構成

パラメーター構成では、選択した API に基づいてアクセスパラメーターのリストを自動的に取得できます。ドキュメントに従って、対応するパラメーター値を入力するだけです。左下隅にあるをクリックすると、API リファレンスが開きます。

詳細設定

操作でページングされたクエリがサポートされている場合は、詳細設定でページングパラメーターを構成します。コンポーネントは、自動ページング (PageSize+PageNumber) とカーソルベースのページング (カーソルキー) の両方をサポートしています。ページングパラメーターを自動的にマッピングし、すべてのデータが取得されるまで API を再帰的に呼び出すことができます。

タイプ	パラメーター	説明
自動ページング	最大リクエスト数	ページングリクエストの最大数。API を再帰的に呼び出すことができる回数を決定します。
	合計カウントパス	レスポンスパラメーターから合計カウントを取得するためのパス。JSONPath 形式で指定され、複数レベルのネストをサポートします。単層構造の場合は、`.target_parameter_field_name` 形式を使用します。以下の例のパスは `.TotalCount` です。 `{ "TotalCount": 1, "PageNumber": 1, "PageSize": 10 }` ネストされた構造の場合は、完全なパラメーターパスを階層的に連結します。形式は `"." + first_level_parameter_field_name + "." + second_level_parameter_field_name + ... + "." + target_parameter_field_name` です。以下の例は 2 層ネストであり、パスは `.Page.TotalCount` です。 `"Page": { "TotalCount": 22, "PageNumber": 1, "PageSize": 10 }`
	ページマッピングフィールド	現在のページ番号にマッピングされるリクエストパラメーター (例: `PageNumber`)
	1 ページあたりのアイテム数マッピングフィールド	1 ページあたりのアイテム数にマッピングされるリクエストパラメーター (例: `PageSize`)
カーソルベースのページング	最大リクエスト数	ページングリクエストの最大数。API を再帰的に呼び出すことができる回数を決定します。
	カーソルフィールドマッピング	リクエストパラメーターのカーソルフィールド (例: `NextToken`)
	カーソル取得パス	レスポンスパラメーターのカーソルの値 (JSONPath 形式)。単層レスポンスパラメーターの場合は、`.target_parameter_field_name` 形式を使用します。以下の例のパスは `.NextToken` です。 `{ "CurrentPage": 1, "PageSize": 10, "TotalCount": 202, "Count": 4, "NextToken": "B604532DEF982B875E8360A6EFA3B*" }` ネストされたレスポンスパラメーターの場合は、ターゲットパラメーターが見つかるまで、完全なパラメーターパスを階層順に連結します。形式は `"." + first-level_parameter_field_name + "." + second-level_parameter_field_name + ... + "." + target_parameter_field_name` です。以下の例は 2 層ネストであり、パスは `.PageInfo.NextToken` です。 `{ "PageInfo": { "CurrentPage": 1, "PageSize": 10, "TotalCount": 202, "Count": 4, "NextToken": "B604532DEF982B875E8360A6EFA3B" }, "Success": true, "Code": 200, "Message": "successful", "RequestId": "CB414DB5-F692-5DAB-9F0F-975C060AF**", "HttpStatusCode": 200 }`
再帰呼び出し	API 再帰呼び出し間隔	速度制限のトリガーを回避するために、各ページングクエリ API 呼び出しの間隔を設定します。

API 承認

現在の API を呼び出すために必要なロール名と、アタッチする必要がある API 権限ポリシーが表示されます。

次のようにポリシーをアタッチします。

実行ロールを作成します (オプション)。関連するロールをすでに作成している場合は、この手順をスキップします。
Go to RAM Console to Create Role をクリックし、Resource Access Management クイック承認ページで承認を確認します。
重要
ロールを作成する権限がない場合は、RAM 管理者 (リソース管理権限を持つ RAM ユーザーまたはプライマリアカウント) に連絡して、RAM コンソールでロールの作成と信頼ポリシーのアタッチを完了することができます。具体的な操作については、「信頼できる Alibaba Cloud サービスの RAM ロールを作成する」をご参照ください。次の表に示すようにパラメーターを構成します。
- 信頼できるエンティティ: [Alibaba Cloud サービス]
- 信頼できるエンティティ名: cloudsiem.sas.aliyuncs.com
- ロール名: AliyunSiemSoarExecutionDefaultRole
API 権限をアタッチします (オプション)。関連する権限をすでにアタッチしている場合は、この手順をスキップします。
1. [ポリシーのアタッチ] をクリックします。権限ポリシー選択ダイアログボックスで、適切な権限ポリシーをクリックします。システム推奨の権限ポリシーを使用することをお勧めします。
  説明
  現在適切な権限ポリシーがない場合は、RAM コンソールにログインして新しい権限ポリシーを作成できます。権限ポリシーの構成方法については、「カスタムポリシーを作成する」をご参照ください。
2. [OK] ボタンをクリックして RAM 承認ページに移動し、承認を確認します。
重要
承認権限がない場合は、RAM 管理者 (リソース管理権限を持つ RAM ユーザーまたはプライマリアカウント) に連絡して、システム推奨の権限ポリシーを AliyunSiemSoarExecutionDefaultRole ロールにアタッチします。詳細については、「RAM ロールに権限を付与する」をご参照ください。