QueryBatchRegisterDeviceStatus - IoT Platform - Alibaba Cloud Documentation Center

Menanyakan status pemrosesan dan hasil pendaftaran perangkat untuk beberapa perangkat.

Batas QPS

Anda dapat memanggil operasi API ini hingga 30 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 ini untuk berbagai SDK.

Parameter permintaan

Parameter	Type	Required	Example	Description
Action	String	Yes	QueryBatchRegisterDeviceStatus	Operasi yang ingin Anda lakukan. Tetapkan nilainya ke QueryBatchRegisterDeviceStatus.
ApplyId	Long	Yes	1295006	ID aplikasi. Jika pemanggilan operasi BatchRegisterDeviceWithApplyId atau BatchRegisterDevice berhasil, ID aplikasi akan dikembalikan.
ProductKey	String	Yes	a1BwAGV****	ProductKey produk tempat perangkat tersebut terdaftar.
IotInstanceId	String	No	iot_instc_pu***_c-v64********	ID instans. Anda dapat melihat ID instans pada halaman 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 halaman Overview atau ID, Anda tidak perlu mengonfigurasi parameter ini. Untuk informasi selengkapnya, lihat Overview.

Selain parameter permintaan khusus operasi di atas, Anda harus mengonfigurasi 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. Catatan Sertifikat X.509 hanya tersedia untuk perangkat di wilayah China (Shanghai). Jika perangkat Anda tidak berada di wilayah China (Shanghai), Anda tidak dapat membuat sertifikat X.509 untuk perangkat tersebut dan kode kesalahan iot.device.RegionNotSupportX509 akan dikembalikan.
Data	Struct		Informasi status yang dikembalikan jika pemanggilan berhasil.
InvalidDetailList	Array of invalidDetailList		Jika nilai kembali parameter Status adalah CHECK_FAILED atau CREATE_FAILED, beberapa perangkat gagal dibuat. Detail perangkat yang gagal dibuat dikembalikan oleh parameter InvalidDetailList. Jika nilai kembali parameter Status adalah CHECK_SUCCESS atau CREATE_SUCCESS, semua perangkat berhasil dibuat. Dalam kasus ini, detail perangkat yang gagal tidak perlu dikembalikan, dan nilai kembali parameter InvalidDetailList adalah array kosong.
invalidDetailList
DeviceName	String	light	NamaPerangkat perangkat tersebut.
ErrorMsg	String	The nick name is illegal.	Pesan kesalahan yang dikembalikan jika beberapa perangkat gagal dibuat. Catatan Pesan kesalahan ganda dipisahkan oleh tanda pipa vertikal (\|).
NickName	String	Campus light-1	Alias perangkat tersebut.
InvalidList	List	{ "Name": ["Elec_instrument"] }	Jika nilai kembali parameter Status adalah CHECK_FAILED atau CREATE_FAILED, beberapa perangkat gagal dibuat. NamaPerangkat dari perangkat yang gagal dibuat dikembalikan oleh parameter InvalidList. Jika nilai kembali parameter Status adalah CHECK_SUCCESS atau CREATE_SUCCESS, semua perangkat berhasil dibuat. Dalam kasus ini, NamaPerangkat tidak perlu dikembalikan, dan nilai kembali parameter InvalidList adalah array kosong.
Status	String	CREATE_SUCCESS	Status dan hasil pemrosesan. Nilai yang valid: CHECK: Sistem sedang memverifikasi nama perangkat. CHECK_SUCCESS: Semua perangkat dalam formulir aplikasi telah diverifikasi. CHECK_FAILED: Semua perangkat dalam formulir aplikasi gagal diverifikasi. CREATE: Sistem sedang membuat perangkat. CREATE_SUCCESS: Semua perangkat dalam formulir aplikasi telah dibuat. Catatan Jika jenis autentikasi produk tempat perangkat tersebut terdaftar adalah X.509, semua perangkat dan sertifikat X.509 terkait telah dibuat. CREATE_FAILED: Beberapa perangkat dalam formulir aplikasi gagal dibuat. Catatan Jika pembuatan perangkat atau sertifikat X.509 gagal dalam batch saat ini ketika jenis autentikasi adalah X.509, semua perangkat gagal dibuat.
ValidList	List	{ "Name": ["light3"] }	Jika nilai parameter Status adalah CHECK_FAILED atau CREATE_FAILED, beberapa perangkat gagal dibuat. NamaPerangkat dari perangkat yang berhasil dibuat dikembalikan oleh parameter ValidList. Jika nilai parameter Status adalah CHECK_SUCCESS atau CREATE_SUCCESS, semua perangkat berhasil dibuat. Dalam kasus ini, NamaPerangkat tidak perlu dikembalikan, dan nilai kembali parameter ValidList adalah array kosong.
ErrorMessage	String	A system exception occurred.	Pesan kesalahan yang dikembalikan jika pemanggilan gagal.
RequestId	String	E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565	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=QueryBatchRegisterDeviceStatus
&ProductKey=a1BwAGV****
&ApplyId=1234567
&<Common request parameters>

Contoh respons sukses

XML format

<QueryBatchCheckDeviceNamesStatusResponse>
  <RequestId>E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565</RequestId>
  <Data>
        <Status>CREATE_SUCCESS</Status>
        <InvalidDetailList>
              <invalidDetailList>
                    <ErrorMsg>The nick name is illegal. | The nick name is illegal.</ErrorMsg>
                    <NickName>Campus light-1</NickName>
                    <DeviceName>Elec_instrument</DeviceName>
              </invalidDetailList>
        </InvalidDetailList>
        <ValidList>
              <Name>light3</Name>
        </ValidList>
        <InvalidList>
              <Name>Elec_instrument</Name>
        </InvalidList>
  </Data>
  <Code></Code>
  <Success>true</Success>
</QueryBatchCheckDeviceNamesStatusResponse>

JSON format

{
    "RequestId": "E55E50B7-40EE-4B6B-8BBE-D3ED55CCF565",
    "Data": {
        "Status": "CREATE_SUCCESS",
        "InvalidDetailList": {
            "invalidDetailList": [{
                "ErrorMsg": "The nick name is illegal. | The nick name is illegal.",
                "NickName": "Campus light-1",
                "DeviceName": "Elec_instrument"
            }]
        },
        "ValidList": {
            "Name": ["light3"]
        },
        "InvalidList": {
            "Name": ["Elec_instrument"]
        }
    },
    "Code": "",
    "Success": true
}

Kode kesalahan

Untuk daftar kode kesalahan, lihat Service error codes.