BindPolarClawAgent

Operation description

Request

This API associates an agent from a PolarClaw application with a communication channel. You specify the application with ApplicationId, the agent with AgentId, and the channel with Channel. You can optionally specify an account ID for the channel with ChannelAccountId.

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

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	pa-**************
AgentId	string	Yes	The agent ID.	work
Channel	string	Yes	The channel ID.	feishu
ChannelAccountId	string	No	The account ID for the channel. If omitted, the default value is 'default'.	default

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The request ID.	2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
Message	string	A message that indicates the request result.	successful
Code	integer	The HTTP status code.	200
ApplicationId	string	The application ID.	pa-********************
AgentId	string	The agent ID.	work
Binding	object	Details of the newly created binding.
AgentId	string	The agent ID.	work
Channel	string	The channel ID.	feishu
AccountId	string	The account ID.	default
TotalBindings	integer	The total number of global bindings 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.