SetNotifyConfig - Intelligent Media Services - Alibaba Cloud ドキュメントセンター

操作説明

説明

この操作は、AI エージェントインスタンスのイベント通知設定を構成します。イベント通知の有効化/無効化、コールバック URL の指定、サブスクライブするイベントタイプの定義が可能です。セキュリティを強化するために認証トークンを提供することもできます。リクエストが成功すると、追跡とトラブルシューティングのためのユニークなリクエスト 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

ice:SetNotifyConfig

none

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
AIAgentId	string	必須	AI エージェントの ID です。	39f8e0bc005e4f309379701645f4****
EnableNotify	boolean	必須	イベント通知を有効にするか無効にするかを指定します。	true
CallbackUrl	string	任意	イベント通知を受信するためのコールバック URL です。デフォルトでは設定されていません。	http://customer.com/callback
EventTypes	string	任意	イベントタイプです。このパラメーターを指定しない場合、デフォルトですべてのイベントタイプがサブスクライブされます。有効な値： agent_start agent_stop error 列挙値: agent_start : agent_start error : error agent_stop : agent_stop	agent_start,agent_stop,error
Token	string	任意	イベントコールバック用の認証トークンです。サービスは、各コールバックリクエストの `Authorization` ヘッダーにこのトークンを含めます。	eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx
AudioOssPath	string	任意
EnableAudioRecording	boolean	任意

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	771A1414-27BF-53E6-AB73-EFCB*****ACF

例

成功レスポンス

JSONJSON

{
  "RequestId": "771A1414-27BF-53E6-AB73-EFCB*****ACF"
}

エラーコード

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

変更履歴

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