CreateChatConfiguration API による DingTalk アラートの自動化 - OOS

操作説明

リクエストの説明

この API は、DingTalk などのインスタントメッセージ (IM) ツール向けチャットボット設定を管理します。チャット構成の新規作成、更新、取得、および削除が可能です。また、異なるユーザーまたはユーザーグループに対して細かい権限コントロールを実装したり、操作を実行するための 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:CreateChatConfiguration

create

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	任意	リージョン ID。	cn-hangzhou
Name	string	任意	構成名。	chatops
Type	string	任意	チャットプラットフォームの種類。有効な値： DingTalk：DingTalk。 WeChat：WeChat。	DingTalk
RamRole	string	任意	RAM ロール名。	AliyunOOSDefaultRole
Configuration	string	任意	チャットボット構成情報を JSON 形式で指定します。	("DingTalkTemplateId": "template-123", "DingTalkClientId": "client-123", "DingTalkClientSecret": "secret-123"}
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmxsn4m4******

レスポンスフィールド

フィールド	型	説明	例
	object	正常終了時の応答の詳細。
RequestId	string	リクエスト ID。	4DB0****1234
ChatConfiguration	object	チャット構成の詳細。	{"Name": "TestChatConfig-9be97b40", "CreatedDate": "2025-12-11T13:49:10+00:00", "UpdatedDate": "2025-12-11T13:59:02+00:00"}
Name	string	チャット構成の名前。	TestChatConfig-9be97b40
CreatedDate	string	チャット構成の作成時刻。	2025-12-11T13:49:10+00:00
UpdatedDate	string	チャット構成の最終更新時刻。	2025-12-11T13:59:02+00:00

例

成功レスポンス

JSONJSON

{
  "RequestId": "4DB0****1234",
  "ChatConfiguration": {
    "Name": "TestChatConfig-9be97b40",
    "CreatedDate": "2025-12-11T13:49:10+00:00",
    "UpdatedDate": "2025-12-11T13:59:02+00:00"
  }
}

エラーコード

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

変更履歴

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