CreateProductTopic - IoT Platform - Alibaba Cloud Documentation Center

Membuat kategori topik kustom untuk suatu Produk.

Batas QPS

Anda dapat memanggil operasi ini hingga satu kali per detik per akun.

Catatan Pengguna RAM dari Akun Alibaba Cloud berbagi kuota akun tersebut.

Debugging

OpenAPI Explorer secara otomatis menghitung nilai signature. Untuk kemudahan Anda, kami menyarankan agar Anda memanggil operasi ini di OpenAPI Explorer. OpenAPI Explorer secara dinamis menghasilkan contoh kode operasi ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	CreateProductTopic	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke CreateProductTopic.
Operation	String	Yes	PUB	Izin Perangkat pada kategori topik kustom. Nilai yang valid: SUB: Subscribe. PUB: Publish. ALL: Publish dan Subscribe.
ProductKey	String	Yes	aldDEin****	ProductKey dari Produk tempat Anda ingin membuat kategori topik kustom.
TopicShortName	String	Yes	submit	Nama kategori topik kustom. Kategori topik terdiri dari beberapa bidang. Pisahkan bidang-bidang tersebut dengan garis miring maju (`/`). Nama dapat berisi huruf, angka, dan garis bawah (_). Setiap nama level dalam kategori topik tidak boleh kosong. Catatan Jika Anda menetapkan Operation ke SUB, Anda dapat menggunakan karakter wildcard tanda plus (`+`) dan tanda pagar (`#`) dalam nama kategori topik agar Perangkat dapat berlangganan ke beberapa topik sekaligus. Untuk informasi lebih lanjut tentang penggunaan karakter wildcard, lihat Custom topics with wildcard characters. Jika Anda menggunakan Produk gerbang cloud, tidak ada awalan yang ditentukan secara otomatis. Anda harus menentukan nilai kustom untuk parameter ini. Anda dapat menggunakan `${deviceName}` untuk menentukan DeviceName. Jika Anda menggunakan Produk non-gerbang cloud, `/${productKey}/${deviceName}/user/` secara otomatis ditetapkan sebagai awalan nilai TopicShortName. Anda hanya perlu menentukan nama kustom untuk kategori topik.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID instans. Anda dapat melihat ID instans pada tab Overview di Konsol IoT Platform. Penting Jika instans Anda memiliki ID, Anda harus menentukan ID tersebut untuk parameter ini. Jika tidak, pemanggilan akan gagal. Jika instans Anda tidak memiliki ID, Anda tidak perlu mengonfigurasi parameter ini. Untuk informasi lebih lanjut tentang instans, lihat Overview.
Desc	String	No	submit a test topic	Deskripsi kategori topik kustom. Panjang deskripsi maksimal 100 karakter.
EnableProxySubscribe	Boolean	No	false	Jika Anda menetapkan Operation ke SUB atau ALL, Anda dapat mengaktifkan fitur langganan didelegasikan. Nilai yang valid: true: mengaktifkan fitur langganan didelegasikan. false: menonaktifkan fitur langganan didelegasikan. Jika Anda mengaktifkan fitur langganan didelegasikan untuk suatu topik, IoT Platform akan mendapatkan detail topik tersebut dan membantu Perangkat berlangganan ke topik saat Anda menghubungkan Perangkat ke IoT Platform.
Codec	String	No	compress	Menentukan apakah akan mengaktifkan fitur kompresi data atau dekompresi data untuk topik kustom. Parameter ini hanya tersedia jika Anda menggunakan instans Edisi Perusahaan Jenis Penyimpanan Standar atau Eksklusif. Nilai yang valid: compress: mengaktifkan kompresi data. decompress: mengaktifkan dekompresi data. Untuk informasi lebih lanjut, lihat Data compression. Penting Jika Anda menentukan nilai yang berisi karakter wildcard, termasuk tanda plus (`+`) dan tanda pagar (`#`), untuk TopicShortName, Anda tidak dapat mengonfigurasi Codec. Jika fitur kompresi data atau dekompresi data diaktifkan saat Anda menggunakan karakter wildcard untuk membuat kategori topik, pemanggilan akan gagal.

Selain parameter permintaan spesifik operasi di atas, Anda harus mengonfigurasi parameter permintaan umum saat memanggil operasi ini. Untuk informasi lebih lanjut tentang parameter permintaan umum, lihat Common parameters.

Parameter respons

Parameter	Type	Example	Description
Code	String	iot.system.SystemException	Kode kesalahan yang dikembalikan jika pemanggilan gagal. Untuk informasi lebih lanjut, lihat Error codes.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	FCC27691-9151-4B93-9622-9C90F30542EC	ID permintaan.
Success	Boolean	true	Menunjukkan apakah pemanggilan berhasil. Nilai yang valid: true: Pemanggilan berhasil. false: Pemanggilan gagal.
TopicId	Long	10000	ID kategori topik kustom. ID ini dikeluarkan oleh IoT Platform jika pemanggilan berhasil. Catatan Jaga kerahasiaan ID kategori topik kustom. ID kategori topik kustom diperlukan saat Anda memanggil operasi tertentu yang terkait dengan kategori topik kustom tersebut.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=CreateProductTopic
&ProductKey=aldDEin****
&TopicShortName=submit
&Operation=PUB
&Desc=submit a test topic
&<Common request parameters>

Contoh respons sukses

XML format

<CreateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
      <TopicId>10000</TopicId>
</CreateProductTopicResponse>

JSON format

{
    "RequestId":"FCC27691-9151-4B93-9622-9C90F30542EC",
    "Success":true,
    "TopicId":10000
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.