UpdateProductTopic - IoT Platform - Alibaba Cloud Documentation Center

Memodifikasi kategori topik kustom.

Batas QPS

Anda dapat memanggil operasi API ini hingga 50 kali per detik per akun.

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

Debugging

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

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	UpdateProductTopic	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke UpdateProductTopic.
Operation	String	Yes	PUB	Izin perangkat pada kategori topik. Nilai yang valid: SUB: Berlangganan. PUB: publish ALL: publish dan subscribe
TopicId	String	Yes	821****	ID kategori topik yang ingin Anda modifikasi. Jika kategori topik kustom dibuat setelah Anda memanggil operasi CreateProductTopic, ID kategori topik yang ditunjukkan oleh TopicId akan dikembalikan.
TopicShortName	String	Yes	resubmit	Nama level kategori kustom. Secara default, kategori topik mencakup level berikut: _productkey_ dan _devicename_. Pisahkan kedua level tersebut dengan garis miring (/). Format kategori topik: `productKey/deviceName/topicShortName`. Catatan Setiap level dapat berisi huruf, angka, dan garis bawah (_), serta tidak boleh kosong.
IotInstanceId	String	Optional	iot_instc_pu***_c-v64********	ID instans. Anda dapat memperoleh 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 selengkapnya tentang instans, lihat Overview.
Desc	String	No	resubmit a test topic	Deskripsi kategori topik. Panjang deskripsi harus antara 1 hingga 100 karakter.
EnableProxySubscribe	Boolean	No	false	Jika Anda menetapkan Operation ke SUB atau ALL, Anda dapat mengaktifkan fitur delegated subscription. Nilai yang valid: true: mengaktifkan fitur delegated subscription. false: menonaktifkan fitur delegated subscription. Jika Anda mengaktifkan fitur delegated subscription untuk suatu topik, IoT Platform akan memperoleh 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 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 selengkapnya, lihat Data compression. Penting Jika Anda menentukan nilai yang mencakup karakter wildcard (`+` dan `#`) untuk TopicShortName, Anda tidak dapat mengonfigurasi Codec. Jika fitur kompresi atau dekompresi data diaktifkan saat Anda menggunakan karakter wildcard untuk membuat kategori topik, permintaan ini akan gagal.

Selain parameter permintaan spesifik operasi di atas, Anda harus menentukan parameter permintaan umum saat memanggil operasi ini. Untuk informasi selengkapnya 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 selengkapnya, 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.

Contoh

Contoh permintaan

https://iot.cn-shanghai.aliyuncs.com/?Action=UpdateProductTopic
&TopicId=821****
&TopicShortName=resubmit
&Operation=PUB
&Desc=resubmit a test topic
&<Common request parameters>

Contoh respons sukses

XML format

<UpdateProductTopicResponse>
      <RequestId>FCC27691-9151-4B93-9622-9C90F30542EC</RequestId>
      <Success>true</Success>
</UpdateProductTopicResponse>

JSON format

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

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.