BindPolarClawAgent

Updated at:

Associates a specified channel with a specific PolarClaw agent.

Operation description

Request description

This API operation associates a PolarClaw agent (specified by AgentId) of a PolarClaw application (identified by ApplicationId) with a given communication channel (Channel). If necessary, you can also specify the account ID (ChannelAccountId) within the channel.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:BindPolarClawAgent

create

*All Resource

*

None None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

ApplicationId

string

Yes

The application ID. You can call the DescribeApplications operation to obtain the application ID from the returned Items list.

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

AgentId

string

Yes

The ID of the agent to associate.

work

Channel

string

Yes

The channel plugin ID.

feishu

ChannelAccountId

string

No

The channel account ID. If you do not specify this parameter, the default value is default.

default

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

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

Message

string

successful

successful

Code

integer

200

200

ApplicationId

string

The application ID.

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

AgentId

string

Agent ID

work

Binding

object

The details of the newly created association.

AgentId

string

Agent ID

work

Channel

string

The channel ID.

feishu

AccountId

string

The account ID.

default

TotalBindings

integer

The total number of global associations after the operation.

1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.