DescribePolarClawChannels - PolarDB - Alibaba Cloud ドキュメントセンター

インストール済みのすべての PolarClaw チャネルとそのステータス情報を一覧表示します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardb:DescribePolarClawChannels

get

* すべてのリソース

*

なし

リクエスト構文

POST  HTTP/1.1

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ApplicationId	文字列	必須	アプリケーションID。	pa-**************
ChannelList	配列	任意	クエリするチャネルIDを指定します。このパラメーターが空の場合、すべてのチャネルが返されます。	["feishu","telegram"]
	文字列	任意	チャネルID。	feishu

レスポンスフィールド

フィールド	型	説明	例
	オブジェクト	レスポンスデータです。
RequestId	文字列	リクエスト ID です。	2281C6C9-CBAB-1AFD-8400-670750CF6025_2212
Message	文字列	レスポンスメッセージです。値が `successful` の場合は、リクエストが成功したことを示します。	successful
Code	整数	ステータスコードです。	200
ApplicationId	文字列	アプリケーション ID です。	pa-**********
Channels	配列<オブジェクト>	PolarClaw チャネルオブジェクトのリストです。
	オブジェクト	チャネルの詳細です。
ChannelId	文字列	チャネル ID です。	feishu
Configured	ブール値	チャネルが設定済みかどうかを示します。	true
Enabled	ブール値	チャネルが有効かどうかを示します。	true
Accounts	配列<オブジェクト>	チャネルのアカウントオブジェクトのリストです。
	オブジェクト	アカウントの詳細です。
AccountId	文字列	アカウント ID です。	default
Enabled	ブール値	アカウントが有効かどうかを示します。	true
Configured	ブール値	アカウントが設定済みかどうかを示します。	true
Connected	ブール値	アカウントが接続済みかどうかを示します。	true
LastInboundAt	整数	最後のインバウンドメッセージのタイムスタンプ (ミリ秒単位) です。	0
LastOutboundAt	整数	最後のアウトバウンドメッセージのタイムスタンプ (ミリ秒単位) です。	0
Issues	配列	アカウントに関連する問題のリストです。
	文字列	問題の説明です。	**
DefaultAccountId	文字列	チャネルのデフォルトアカウント ID です。	default

例

成功レスポンス

JSONJSON

{
  "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"
    }
  ]
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。