ListChatConfigurations API による DingTalk チャット設定の取得 - OOS - Alibaba Cloud - CloudOps Orchestration Service

DingTalk などのプラットフォームのチャット構成を作成、更新、照会、および削除します。

操作説明

操作の説明

この API オペレーションは、DingTalk などのインスタントメッセージ (IM) ツールと統合された Chatbot の設定項目を管理および構成するために使用します。サポートされる操作には、チャット構成の作成、既存の構成の更新、特定の構成の詳細の取得、および不要になった構成の削除が含まれます。この API オペレーションを使用して、異なるユーザーまたはユーザーグループに対するきめ細かいアクセスの制御を実装し、関連する操作を実行する RAM ロールを指定できます。また、管理と分類を容易にするために、各構成にタグを追加することもできます。

この API オペレーションの呼び出し時は、リクエストボディ内の RegionId、ConversationId、およびその他のパラメーターが正しいことを確認してください。ClientId や ClientSecret などのセキュリティ上重要なフィールドを扱う際は、不正な開示を防ぐために注意してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

oos:ListChatConfigurations

create

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Filters	array<object>	任意	チャット構成をフィルター処理するために使用されるフィルター条件のリスト。	[{"Name": "status", "Value": "inactive"}, {"Name": "type", "Value": "private"}]
	object	任意	名前と値を含むフィルター条件の項目。	{"Name": "status", "Value": "inactive"}
Name	string	任意	フィルター条件の名前。	status
Value	string	任意	フィルター条件の値。	inactive
MaxResults	integer	任意	ページングクエリにおける 1 ページあたりのエントリ数。	10
NextToken	string	任意	ページネーショントークン。このパラメーターには、直前の API 呼び出しから返された NextToken の値を設定します。	AQEBARoBBgEAAgIBBQ==

レスポンスフィールド

フィールド	型	説明	例
	object	成功した応答の詳細。
RequestId	string	リクエスト ID。	4DB0****1234
ChatConfigurations	array<object>	チャット構成のリスト。	[{"Name": "test-チャット", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}"}]
	object	単一のチャット構成の情報。	{"Name": "test-チャット", "CreatedDate": "2025-12-10T10:09:32+00:00", "UpdatedDate": "2025-12-28T13:59:48+00:00", "RamRole": "OOSServiceRole", "Type": "WeChat", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\"}"}
Name	string	チャット構成の名前。	test-チャット
CreatedDate	string	チャット構成が作成された時間。時間は協定世界時 (UTC) の ISO 8601 フォーマットです。	2025-12-10T10:09:32+00:00
UpdatedDate	string	チャット構成が最後に更新された時間。時間は協定世界時 (UTC) の ISO 8601 フォーマットです。	2025-12-28T13:59:48+00:00
RamRole	string	操作の実行に使用される RAM ロールの名前。	OOSServiceRole
Type	string	チャット構成のタイプ。有効な値: WeChat: WeCom。 DingTalk: DingTalk。 TODO: この情報は、最近の API 呼び出しログに基づいて AI により生成されています。この情報の精度をご確認ください。	WeChat
Outputs	string	Webhook URL および暗号鍵を含む出力情報。	{"URL": "https://1407907063606569.appflow.aliyunnes", "AesKey": "UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF"}

例

成功レスポンス

JSONJSON

{
  "RequestId": "4DB0****1234",
  "ChatConfigurations": [
    {
      "Name": "test-wechat",
      "CreatedDate": "2025-12-10T10:09:32+00:00",
      "UpdatedDate": "2025-12-28T13:59:48+00:00",
      "RamRole": "OOSServiceRole",
      "Type": "WeChat",
      "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnes\", \"AesKey\": \"UKAxyRabaJlaDxS3XZ6st18grPteemRtGeDVVgF\"}"
    }
  ]
}

エラーコード

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

変更履歴

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