BindPolarClawAgent - 绑定PolarClaw Agent

更新时间:
复制 MD 格式

将指定的Channel与特定的PolarClaw Agent进行绑定。

接口说明

请求说明

本 API 用于将 PolarClaw(通过ApplicationId标识)的 Agent(由AgentId指定)与给定的通信渠道(Channel)进行关联。如果需要,还可以指定该渠道内的账户 ID(ChannelAccountId)。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardb:BindPolarClawAgent

create

*全部资源

*

无 无

请求语法

POST  HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

ApplicationId

string

是

应用 ID

pa-**************

AgentId

string

是

要绑定的 Agent ID

work

Channel

string

是

通道插件 ID

feishu

ChannelAccountId

string

否

通道账户 ID,不传时默认为 default

default

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID

2281C6C9-CBAB-1AFD-8400-670750CF6025_2212

Message

string

successful

successful

Code

integer

200

200

ApplicationId

string

应用 ID

pa-********************

AgentId

string

Agent ID

work

Binding

object

新创建的绑定详情

AgentId

string

Agent ID

work

Channel

string

通道 ID

feishu

AccountId

string

账户 ID

default

TotalBindings

integer

操作后的全局绑定总数

1

示例

正常返回示例

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
}

错误码

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

变更历史

更多信息,参考变更详情。