DescribePolarClawChannels

Lists all installed PolarClaw channels and their status information.

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:DescribePolarClawChannels

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
ApplicationId	string	Yes	The application ID.	pa-**************
ChannelList	array	No	The channel IDs to query. Leave this parameter empty to return all channels.	feishu,telegram
	string	No	The channel ID.	feishu

Response elements

Element	Type	Description	Example
	object	The response data.
RequestId	string	The request ID.	2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
Message	string	The response message. A value of `successful` indicates that the request succeeded.	successful
Code	integer	The returned status code.	200
ApplicationId	string	The application ID.	pa-**************
Channels	array<object>	A list of PolarClaw channel objects.
	array<object>	Details of a channel.
ChannelId	string	The channel ID.	feishu
Configured	boolean	Indicates whether the channel is configured.	true
Enabled	boolean	Indicates whether the channel is enabled.	true
Accounts	array<object>	A list of account objects for the channel.
	object	Details of an account.
AccountId	string	The account ID.	default
Enabled	boolean	Indicates whether the account is enabled.	true
Configured	boolean	Indicates whether the account is configured.	true
Connected	boolean	Indicates whether the account is connected.	true
LastInboundAt	integer	The timestamp (in milliseconds) of the last inbound message.	0
LastOutboundAt	integer	The timestamp (in milliseconds) of the last outbound message.	0
Issues	array	A list of issues related to the account.
	string	A description of an issue.	***
DefaultAccountId	string	The default account ID for the channel.	default

Examples

Success response

JSON format

{
  "RequestId": "2281C6C9-CBAB-1AFD-8400-670750CF6025_2212",
  "Message": "successful",
  "Code": 200,
  "ApplicationId": "pa-**************",
  "Channels": [
    {
      "ChannelId": "feishu",
      "Configured": true,
      "Enabled": true,
      "Accounts": [
        {
          "AccountId": "default",
          "Enabled": true,
          "Configured": true,
          "Connected": true,
          "LastInboundAt": 0,
          "LastOutboundAt": 0,
          "Issues": [
            "***"
          ]
        }
      ],
      "DefaultAccountId": "default"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.