Ringkasan DingTalk Chat Configuration API - OOS - Alibaba Cloud - CloudOps Orchestration Service

Membuat, memperbarui, mengkueri, dan menghapus konfigurasi chat untuk platform seperti DingTalk.

Deskripsi operasi

Operasi API ini digunakan untuk mengelola dan mengonfigurasi pengaturan chatbot yang terintegrasi dengan alat pesan instan seperti DingTalk. Operasi yang didukung meliputi membuat konfigurasi chat, memperbarui konfigurasi yang ada, mengambil detail konfigurasi tertentu, dan menghapus konfigurasi yang tidak lagi diperlukan. Anda dapat menggunakan operasi API ini untuk menerapkan kontrol akses granular untuk pengguna atau kelompok pengguna yang berbeda dan menentukan peran RAM untuk melakukan operasi terkait. Anda juga dapat menambahkan tag ke setiap konfigurasi untuk memudahkan pengelolaan dan kategorisasi.

Saat memanggil operasi API ini, pastikan bahwa RegionId, ConversationId, dan parameter lain dalam badan permintaan sudah benar. Berhati-hatilah saat melakukan handle bidang yang sensitif terhadap keamanan seperti ClientId dan ClientSecret untuk mencegah pengungkapan yang tidak sah.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tabel berikut menjelaskan otorisasi yang diperlukan untuk memanggil API ini. Anda dapat menentukannya dalam kebijakan Resource Access Management (RAM). Kolom pada tabel dijelaskan sebagai berikut:

Action: Aksi yang dapat digunakan dalam elemen Action pada pernyataan kebijakan izin RAM untuk memberikan izin guna melakukan operasi tersebut.
API: API yang dapat Anda panggil untuk melakukan aksi tersebut.
Access level: Tingkat akses yang telah ditentukan untuk setiap API. Nilai yang valid: create, list, get, update, dan delete.
Resource type: Jenis resource yang mendukung otorisasi untuk melakukan aksi tersebut. Ini menunjukkan apakah aksi tersebut mendukung izin tingkat resource. Resource yang ditentukan harus kompatibel dengan aksi tersebut. Jika tidak, kebijakan tersebut tidak akan berlaku.
- Untuk API dengan izin tingkat resource, jenis resource yang diperlukan ditandai dengan tanda bintang (*). Tentukan Nama Sumber Daya Alibaba Cloud (ARN) yang sesuai dalam elemen Resource pada kebijakan.
- Untuk API tanpa izin tingkat resource, ditampilkan sebagai All Resources. Gunakan tanda bintang (*) dalam elemen Resource pada kebijakan.
Condition key: Kunci kondisi yang didefinisikan oleh layanan. Kunci ini memungkinkan kontrol granular, berlaku baik hanya untuk aksi maupun untuk aksi yang terkait dengan resource tertentu. Selain kunci kondisi spesifik layanan, Alibaba Cloud menyediakan serangkaian common condition keys yang berlaku di semua layanan yang didukung RAM.
Dependent action: Aksi dependen yang diperlukan untuk menjalankan aksi tersebut. Untuk menyelesaikan aksi tersebut, pengguna RAM atau role RAM harus memiliki izin untuk melakukan semua aksi dependen.

Action

Access level

Resource type

Condition key

Dependent action

oos:GetChatConfiguration

create

*All Resource

*

None

Parameter permintaan

Parameter	Type	Required	Description	Example
RegionId	string	No	ID wilayah.	cn-hangzhou
Name	string	No	Nama konfigurasi.	chatOps-qiwei

Elemen respons

Element	Type	Description	Example
	object	Detail tanggapan yang berhasil.
RequestId	string	ID permintaan.	4DB0****1234
ChatConfiguration	object	Detail konfigurasi chat, termasuk nama, tipe, peran RAM, dan properti lainnya.	{ "Name": "chatops", "Type": "DingTalk", "RamRole": "OOSServiceRole", "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"****\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}", "ResourceGroupId": "s", "CreatedDate": "2025-12-26T09:53:02+00:00", "UpdatedDate": "2026-01-07T02:14:55+00:00", "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}", "RequestId": "4DB0**1234" }
Name	string	Nama konfigurasi chat.	chatops
Type	string	Format konfigurasi chat. Nilai valid: DingTalk: Konfigurasi DingTalk. WeChat: Konfigurasi WeCom. TODO: Informasi ini dihasilkan oleh AI berdasarkan log panggilan API terbaru. Konfirmasi akurasi informasi ini.	DingTalk
RamRole	string	Nama peran RAM yang digunakan untuk melakukan operasi.	OOSServiceRole
Configuration	string	Konten konfigurasi chat dalam format string JSON, yang berisi informasi sensitif seperti ID klien dan rahasia.	{"DingTalkClientId": "dingpxlbxp0rgs7uxmtb", "DingTalkClientSecret": "******", "DingTalkTemplateId": "381c5aee-f8af-48a4-94be-cce587e42ea4.schema"}
ResourceGroupId	string	ID kelompok sumber daya yang mengidentifikasi kelompok sumber daya tempat resource berada.	s
CreatedDate	string	Waktu pembuatan konfigurasi chat, dalam format ISO 8601.	2025-12-26T09:53:02+00:00
UpdatedDate	string	Waktu pembaruan terakhir konfigurasi chat, dalam format ISO 8601.	2026-01-07T02:14:55+00:00
Outputs	string	Informasi output konfigurasi chat dalam format string JSON, yang berisi parameter seperti URL webhook.	{"URL": "https://1407907063606569.appflow.aliyunnest.com/webhook/"}

Contoh

Respons sukses

JSONformat

{
  "RequestId": "4DB0****1234",
  "ChatConfiguration": {
    "Name": "chatops",
    "Type": "DingTalk",
    "RamRole": "OOSServiceRole",
    "Configuration": "{\"DingTalkClientId\": \"dingpxlbxp0rgs7uxmtb\", \"DingTalkClientSecret\": \"******\", \"DingTalkTemplateId\": \"381c5aee-f8af-48a4-94be-cce587e42ea4.schema\"}",
    "ResourceGroupId": "s",
    "CreatedDate": "2025-12-26T09:53:02+00:00",
    "UpdatedDate": "2026-01-07T02:14:55+00:00",
    "Outputs": "{\"URL\": \"https://1407907063606569.appflow.aliyunnest.com/webhook/\"}"
  }
}

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.