DeleteDevice - IoT Platform - Alibaba Cloud Documentation Center

Menghapus sebuah device. Jika operasi ini dipanggil untuk menghapus gateway, hubungan topologi antara gateway tersebut dan sub-device yang terhubung juga akan dihapus.

Catatan penggunaan

Sebelum memanggil operasi ini

Jika Anda ingin memanggil operasi ini sebagai pengguna Resource Access Management (RAM), buat kebijakan izin kustom untuk memberikan izin detail halus kepada pengguna RAM tersebut. Hal ini menjamin keamanan device. Untuk informasi selengkapnya, lihat Pemetaan antara operasi API IoT Platform dan kebijakan RAM dan Izin kustom.

Peringatan

Setelah sebuah device dihapus, ID device (IotId) menjadi tidak valid, dan semua informasi terkait device tersebut juga dihapus. Selain itu, Anda tidak dapat lagi melakukan operasi apa pun pada device tersebut.
Sebelum menghapus device di Konsol IoT Platform, pastikan device fisik tersebut sedang offline. Jika tidak, device fisik akan terus-menerus mengirim permintaan koneksi ke IoT Platform setelah dihapus. Jika jumlah permintaan melebihi batas atas, IoT Platform akan menerapkan pengendalian aliran (throttle), yang dapat menyebabkan device lain dalam Akun Alibaba Cloud Anda gagal terhubung ke IoT Platform.
Setelah device dihapus, sertifikatnya menjadi tidak valid dan tidak dapat dipulihkan. Lakukan tindakan ini dengan hati-hati.

Saat memanggil operasi ini

Anda harus menentukan IotId atau kombinasi ProductKey dan DeviceName untuk mengidentifikasi device.
Jika operasi ini dipanggil untuk menghapus gateway yang memiliki lebih dari 2.000 sub-device terhubung, sistem akan membuat pekerjaan asinkron untuk menghapus hubungan topologi. Operasi ini mengembalikan JobId dari pekerjaan asinkron tersebut.

Batas QPS

Operasi ini dapat dipanggil hingga 50 kali per detik per akun.

Catatan

Pengguna RAM dalam satu 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	Wajib	Contoh	Deskripsi
Action	String	Ya	DeleteDevice	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke DeleteDevice.
IotInstanceId	String	Tidak	iot-cn-0pp1n8t****	ID instans. Anda dapat melihat ID instans pada tab Overview di Konsol IoT Platform. Penting Anda harus menentukan parameter ini jika instans Anda memiliki ID. Jika tidak, permintaan akan gagal. Jika tab Overview atau ID instans tidak ditampilkan di Konsol IoT Platform, Anda tidak perlu menentukan parameter ini. Untuk informasi selengkapnya tentang instans, lihat Overview.
ProductKey	String	Tidak	a1FlqIQ****	ProductKey dari produk tempat device tersebut terdaftar. Penting Jika Anda menentukan parameter ini, Anda juga harus menentukan DeviceName.
DeviceName	String	Tidak	light	Nama device yang ingin Anda hapus. Penting Jika Anda menentukan parameter ini, Anda juga harus menentukan ProductKey.
IotId	String	Tidak	MpEKNuEUJzIORNANAWJX0010929900*****	ID dari device yang ingin Anda hapus. Penting IotId menentukan GUID sebuah device. IotId berkorespondensi dengan kombinasi ProductKey dan DeviceName. Jika Anda menentukan parameter ini, Anda tidak perlu menentukan ProductKey atau DeviceName. Jika Anda menentukan IotId, ProductKey, dan DeviceName secara bersamaan, IotId akan diutamakan.

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 Parameter umum.

Parameter respons

Parameter	Jenis	Contoh	Deskripsi
Code	String	iot.prod.NullProductKey	Kode kesalahan yang dikembalikan jika permintaan gagal. Untuk informasi selengkapnya tentang kode kesalahan, lihat Kode kesalahan.
ErrorMessage	String	The product ID is invalid.	Pesan kesalahan yang dikembalikan jika permintaan gagal.
RequestId	String	57b144cf-09fc-4916-a272-a62902d5b207	ID permintaan.
Success	Boolean	false	Menunjukkan apakah permintaan berhasil. Nilai yang valid: true false

Contoh

Permintaan contoh

https://iot.cn-shanghai.aliyuncs.com/?Action=DeleteDevice
&ProductKey=a1rYuVF****
&DeviceName=device1
&<Common request parameters>

Respons sukses contoh

XML format

<DeleteDeviceResponse>
  <RequestId>57b144cf-09fc-4916-a272-a62902d5b207</RequestId>
  <Success>true</Success>
</DeleteDeviceResponse>

JSON format

{
  "RequestId":"57b144cf-09fc-4916-a272-a62902d5b207",
  "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Kode kesalahan layanan.