PolarDB Agent Enterprise Service Platform は、お客様の Virtual Private Cloud (VPC) 内にデプロイされ、PolarDB Agent Express アプリケーションを一元的に作成および管理する Web サービスです。このサービスでは、PolarDB Agent Express アプリケーションの設定をテンプレート化し、Lark、DingTalk、WeCom などのエンタープライズアプリケーションと統合することで、チームメンバーの認証と認可を一元的に行うことができます。このトピックでは、必要な認証情報の準備、アプリケーションインスタンスの作成、ネットワークアクセスの設定から、最終的なアプリケーションの使用までの一連の手順を説明します。
概要
PolarDB Agent Enterprise Service Platform は、本質的にはお客様の Alibaba Cloud アカウントでデプロイされるプライベートに管理されるプラットフォームです。PolarDB Agent Express アプリケーションの複雑な設定手順をグラフィカルインターフェイスでラップし、以下のニーズに対応します。
-
デプロイの簡素化:事前設定されたテンプレートを使用することで、チームメンバーは技術的な詳細を理解することなく、ワンクリックで PolarDB Agent Express アプリケーションを作成できます。
-
統合認証:エンタープライズアプリケーション (Lark、DingTalk、WeCom など) の組織構造と統合し、チームメンバーがエンタープライズアプリケーションのアカウントで安全にサインインできるようにします。
-
アクセス制御:Enterprise Service Platform の管理者は、PolarDB Agent Express アプリケーションの設定テンプレートを一元的に管理および保守できます。
前提条件
アプリケーションを作成する前に、次の 2 つの認証情報を準備します。
-
必要な権限が付与された RAM ユーザーの AccessKey ペア。
-
Lark、DingTalk、または WeCom で作成およびリリースされたカスタムエンタープライズアプリケーションとその認証情報。
準備 1: RAM ユーザーの AccessKey ペアの取得
PolarDB Agent Enterprise Service Platform は、AccessKey ペアを使用して Alibaba Cloud API を呼び出し、リソースを管理します。最小権限の原則に従い、専用の RAM ユーザーと AccessKey ペアを使用してください。
-
カスタムポリシーを作成します。
-
RAM コンソールにログインします。左側メニューで、[権限] > [ポリシー] を選択します。
-
[ポリシーの作成] をクリックし、[JSON] タブに切り替えます。
-
次の JSON ポリシーをポリシーエディターに貼り付け、[OK] をクリックします。
-
ポリシーに名前 (例:
PolarDB Agent ExpressSaaSMinimalAccess) を入力し、作成を完了します。
-
-
RAM ユーザーを作成し、権限を付与します。
-
左側メニューで、[ID] > [ユーザー] を選択し、RAM ユーザーを選択または作成します。
-
既存のユーザーを選択する:ユーザー詳細ページに移動し、[AccessKey] タブで既存の AccessKey ペアを使用するか、新しいペアを作成します。新しい AccessKey ペアを作成するには、[ローカル開発用] を選択し、生成された AccessKey ID と AccessKey Secret を安全に保存します。
-
新しいユーザーを作成する:[ユーザーの作成] ページで、[基本情報] を入力し、[永続的な AccessKey を使用してアクセス] を選択します。ユーザーが作成された後、RAM ユーザーの AccessKey ID と AccessKey Secret を保存します。
-
-
ユーザー詳細ページで、[権限] タブに切り替え、[権限の付与] をクリックします。前の手順で作成した
PolarDB Agent ExpressSaaSMinimalAccessポリシーをユーザーにアタッチします。
-
準備 2: エンタープライズアプリケーションの認証情報 (App ID と App Secret) の取得
PolarDB Agent Enterprise Service Platform は、カスタムエンタープライズアプリケーション (Lark、DingTalk、WeCom など) を使用してユーザーを認証します。
DingTalk
-
DingTalk アプリの作成:
-
DingTalk Open Platform にアクセスし、上部メニューで [アプリ開発] をクリックします。[アプリ開発] の左側メニューで、[社内向けアプリ] > [DingTalk アプリ] を選択し、右上隅の [アプリ作成] をクリックします。
-
[アプリ作成] パネルで、アプリ名、アプリの説明、アプリのアイコン (任意) を入力し、[保存] をクリックして作成を完了します。
-
-
必要な権限の追加:左側メニューで、[開発] > [権限管理] を選択し、[ユーザープロファイルの読み取り (Contact.User.Read)] 権限を追加します。
-
DingTalk アプリのリリース:アプリを作成した後、企業内の他のユーザーが使用できるようにバージョンをリリースする必要があります。
-
左側メニューで、[アプリリリース] > [バージョン管理とリリース] を選択し、[新しいバージョンを作成] をクリックします。
-
バージョン詳細ページで、アプリのバージョン番号とリリースノートを入力し、適切な公開範囲を選択して [保存] をクリックします。表示されるダイアログボックスで [リリースを確認] をクリックします。
-
-
アプリがリリースされたら、[認証情報と基本情報] ページに移動し、[クライアント ID] と [クライアントシークレット] を記録します。これらの認証情報は、後で PolarDB Agent Enterprise Service Platform を設定する際に必要になります。
Lark
-
Lark Open Platform にサインインし、右上隅の [開発者コンソール] をクリックします。コンソールで [カスタムアプリを作成] をクリックし、[アプリ名]、[アプリの説明]、[アプリアイコン] を入力して [作成] をクリックします。
-
左側メニューで [権限管理] をクリックし、[権限を追加] をクリックします。
-
以下の権限を検索して選択します。[確認] をクリックし、確認ダイアログボックスで再度 [確認] をクリックします。
重要権限を追加した後、変更を保存するために [確認] をクリックする必要があります。そうしないと、権限は有効になりません。
権限 ID
説明
contact:user.employee:readonlyユーザーの従業員情報を読み取ります。
contact:user.phone:readonlyユーザーの電話番号を読み取ります。
contact:user.base:readonlyユーザーの基本プロファイルを読み取ります。
contact:user.email:readonlyユーザーのメールアドレスを読み取ります。
-
設定が完了したら、アプリをリリースして変更を適用します。左側メニューで [バージョン管理とリリース] をクリックし、右上隅の [新しいバージョンを作成] をクリックします。
-
[公開範囲] を [すべての従業員] に設定し、バージョン番号とリリースノートを入力してから、ページ下部の [保存] と [リリースを確認] をクリックします。
-
アプリがリリースされたら、[認証情報と基本情報] ページに移動し、App ID と App Secret を記録します。これらの認証情報は、後で PolarDB Agent Enterprise Service Platform を設定する際に必要になります。
WeCom
-
WeCom アプリの作成:
-
WeCom 管理コンソールにログインします。左側メニューで、[アプリ管理] > [カスタム] を選択し、[アプリを作成] をクリックします。
-
アプリ名、アプリアイコン、公開範囲を入力し、[アプリを作成] をクリックします。
-
-
アプリ認証情報の取得:
-
Agent ID と Secret の取得:作成したアプリを開きます。アプリ詳細ページで、Agent ID と Secret を取得します。
-
Corp ID の取得:左側メニューで [マイエンタープライズ] を選択します。エンタープライズ情報ページで、[企業 ID] (Corp ID) を取得します。
-
-
Corp ID、Agent ID、Secret を記録します。これらの認証情報は、後で PolarDB Agent Enterprise Service Platform を設定する際に必要になります。
手順
すべての準備が完了したら、以下の手順に従ってアプリケーションを作成および設定します。
ステップ 1: PolarDB Agent エンタープライズサービスプラットフォームの作成
-
PolarDB コンソールにログインします。左側メニューで、 をクリックします。上部メニューで、目的の リージョンに切り替えます。
-
PolarDB Agent Express ページで、法人向けサービスプラットフォーム タブに切り替え、今すぐ作成 をクリックします。
-
作成ページで、以下のコアパラメータを設定します。
-
Alibaba Cloud アカウントの AK/SK:「前提条件」で取得した
AccessKey IDとAccessKey Secretを入力します。 -
VPC ネットワーク と ゾーンおよび vSwitch:PolarDB Agent Enterprise Service Platform をデプロイする VPC と vSwitch を選択します。
-
セキュリティグループ:セキュリティグループを選択し、そのインバウンドルールがポート 8080 へのアクセスを許可していることを確認します。
-
SaaS サービスのログイン方法:アプリケーションタイプ で [Lark]、[DingTalk]、または [WeCom] を選択し、「前提条件」で取得した対応するエンタープライズアプリケーションの認証情報を入力します。
-
-
[OK] をクリックして作成を開始します。
ステップ 2: ネットワークアクセスの設定
PolarDB Agent Enterprise Service Platform の作成後、デフォルトでは VPC 経由でのみアクセス可能です。PolarDB Agent Enterprise Service Platform が Lark、DingTalk、または WeCom の認証サービスとインターネット経由で通信し、インターネット経由でアクセスできるようにするには、次のようにネットワークを設定します。
-
インターネット NAT ゲートウェイの作成:インターネット NAT ゲートウェイ購入ページに移動します。作成時に、PolarDB Agent Enterprise Service Platform と同じ VPC と vSwitch を選択していることを確認してください。
-
SNAT エントリの設定:インターネット NAT ゲートウェイページに移動します。目的のゲートウェイの 操作 列の SNAT の構成 をクリックし、SNAT エントリの作成 をクリックします。パラメータを次のように設定します。
-
SNAT エントリの粒度:[VPC] を選択します。
-
Elastic IP Address の選択:ドロップダウンリストから、インターネットアクセスを提供する EIP を選択します。
説明インターネットアクセスを有効にすると、インターネット NAT ゲートウェイとインターネットトラフィックに追加料金が発生します。料金の詳細については、「NAT ゲートウェイの課金」をご参照ください。
-
-
(任意) パブリックエンドポイントの申請
インターネット経由で管理アプリケーションにアクセスしたい場合は、PolarDB コンソール の PolarDB Agent Enterprise Service Platform 詳細ページに戻り、パブリックエンドポイントの有効化 をクリックしてパブリックエンドポイントを申請します。
ステップ 3: エンタープライズアプリケーションのリダイレクト URL の設定
DingTalk
-
リダイレクト URL の取得
PolarDB Agent Enterprise Service Platform の詳細ページ のエリアで、システムによって生成された DingTalk のリダイレクト URL をコピーします。 -
DingTalk のセキュリティ設定
DingTalk Open Platform に戻り、カスタムアプリを開きます。[セキュリティ設定] ページで、コピーしたリダイレクト URL を [リダイレクト URL (コールバックドメイン)] に追加します。
Lark
-
リダイレクト URL の取得
PolarDB Agent Enterprise Service Platform の詳細ページ のエリアで、システムによって生成された Lark のリダイレクト URL をコピーします。 -
Lark のセキュリティ設定
Lark Open Platform に戻り、カスタムアプリを開きます。[セキュリティ設定] ページで、コピーしたリダイレクト URL を [リダイレクト URL] に追加し、リダイレクト URL に含まれる IP アドレスを [IP ホワイトリスト] に追加します。
WeCom
-
信頼できるドメインの設定
WeCom 管理コンソールにログインし、カスタムアプリを開きます。[開発者インターフェイス] > [Web 認証と JS-SDK] エリアで、信頼できるドメインを設定します。ドメインは Enterprise Service Platform のパブリックエンドポイントにバインドされている必要があります。説明信頼できるドメインを設定する際、検証ファイルをダウンロードし、ドメインに対応するサーバーのルートパスにデプロイする必要があります。検証ファイルがインターネット経由でアクセス可能であることを確認した後、検証を送信します。Enterprise Service Platform のパブリックエンドポイントを取得するには、チケットを起票してお問い合わせください。
-
信頼できるエンタープライズ IP アドレスの設定
アプリ詳細ページの [開発者インターフェイス] > [信頼できるエンタープライズ IP] エリアに、Enterprise Service Platform のパブリックアウトバウンド IP アドレスを追加します。IP アドレスを取得するには、チケットを起票してお問い合わせください。
ステップ 4: Enterprise Service Platform へのアクセスと使用
-
アクセス用の IP ホワイトリストの設定
PolarDB Agent Enterprise Service Platform のホワイトリスト設定で、アプリケーションへのアクセスを許可するクライアントの IP アドレスを追加します。-
インターネット経由でアクセスする場合は、ローカルネットワークのパブリックアウトバウンド IP アドレスを追加します。
-
内部ネットワーク経由でアクセスする場合は、VPC 内のクライアントの IP アドレスを追加します。
-
-
アプリケーションへのアクセス
PolarDB Agent Enterprise Service Platform の詳細ページで、プライベートエンドポイントまたは申請したパブリックエンドポイントを見つけ、ブラウザでアクセスします。 -
サインインして PolarDB Agent Express テンプレートを作成
最初にサインインしたユーザーには、自動的に管理者権限が付与されます。[アカウント管理] ページで、PolarDB Agent Express アプリケーション (Crayfish モジュール) の設定テンプレートを作成できます。たとえば、モデルソースを Bailian に設定し、対応するModelFromとModelApiKeyを入力します。 -
チームメンバーによる PolarDB Agent Express アプリケーションの作成
テンプレートが設定された後、他のチームメンバーは Enterprise Service Platform にサインインし、[PolarDB Agent Express 管理] ページに移動して、テンプレートを選択することで、ワンクリックで独自の PolarDB Agent Express アプリケーションを作成できます。