DescribeNotifyConfig - 查询智能体通知配置

获取指定智能体的事件回调设置。

接口说明

功能描述:此接口用于查询指定智能体(AIAgent)的事件回调配置详情。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ice:DescribeNotifyConfignone
*全部资源
*

请求参数

名称类型必填描述示例值
AIAgentIdstring

智能体 ID。

39f8e0bc005e4f309379701645f4****

返回参数

名称类型描述示例值
object

Schema of Response

CallbackUrlstring

用户希望接收回调通知的 URL。

http://customer.com/callback
EnableNotifyboolean

用于开启或关闭通知的开关。

true
EventTypesstring

事件类型,不填写则全选。

  • agent_start 智能体就绪
  • agent_stop 智能体停止
  • error 任务错误
agent_start,agent_stop,error
RequestIdstring

请求 Id。

7B117AF5-2A16-412C-B127-FA6175ED1AD0
Tokenstring

回调的鉴权 token。发送回调请求时携带在请求头的 Authorization 字段中。

eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx

示例

正常返回示例

JSON格式

{
  "CallbackUrl": "http://customer.com/callback",
  "EnableNotify": true,
  "EventTypes": "agent_start,agent_stop,error",
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx"
}

错误码

访问错误中心查看更多错误码。