BindPolarClawAgent - PolarDB - Alibaba Cloud ドキュメントセンター

操作説明

リクエスト

この API は、PolarClaw アプリケーションのエージェントを通信チャネルに関連付けます。アプリケーションを ApplicationId で、エージェントを AgentId で、チャネルを Channel で指定します。オプションで、ChannelAccountId を使用してチャネルのアカウント ID を指定できます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:BindPolarClawAgent

create

* すべてのリソース

*

なし

リクエスト構文

POST HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApplicationId	文字列	必須	アプリケーション ID。	pa-************
AgentId	文字列	必須	エージェント ID。	work
Channel	文字列	必須	チャネル ID。	feishu
ChannelAccountId	文字列	任意	チャネルのアカウント ID。省略した場合、デフォルト値は 'default' です。	default

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト	返されたデータ。
RequestId	文字列	リクエスト ID。	2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
Message	文字列	リクエスト結果を示すメッセージ。	successful
Code	整数	HTTP ステータスコード。	200
ApplicationId	文字列	アプリケーション ID。	pa-******************
AgentId	文字列	エージェント ID。	work
Binding	オブジェクト	新しく作成されたバインディングの詳細。
AgentId	文字列	エージェント ID。	work
Channel	文字列	チャネル ID。	feishu
AccountId	文字列	アカウント ID。	default
TotalBindings	整数	操作後の、このアプリケーションにおけるバインディングの総数。	1

例

成功レスポンス

JSON JSON

{
  "RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-********************",
  "AgentId": "work",
  "Binding": {
    "AgentId": "work",
    "Channel": "feishu",
    "AccountId": "default"
  },
  "TotalBindings": 1
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。