View a markdown version of this page

Penyediaan perangkat MQTT API - AWS IoT Core
CreateCertificateFromCsrCreateKeysAndCertificateRegisterThing

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Penyediaan perangkat MQTT API

Layanan Fleet Provisioning mendukung operasi API MQTT berikut:

API ini mendukung buffer respons dalam format Concise Binary Object Representation (CBOR) dan JavaScript Object Notation (JSON), tergantung pada payload-format topik. Untuk kejelasan, contoh respons dan permintaan di bagian ini ditampilkan dalam format JSON.

payload-format Jenis data format respons
cbor Representasi Objek Biner Ringkas (CBOR)
json JavaScript Notasi Objek (JSON)
penting

Sebelum menerbitkan topik pesan permintaan, berlangganan topik tanggapan untuk menerima tanggapan. Pesan yang digunakan oleh API ini menggunakan publish/subscribe protokol MQTT untuk memberikan interaksi permintaan dan respons.

Jika Anda tidak berlangganan topik tanggapan sebelum mempublikasikan permintaan, Anda mungkin tidak menerima hasil permintaan tersebut.

IoT Core Fleet Provisioning mengembalikan hasil MQTT API penyediaan perangkat melalui koneksi MQTT yang sama yang digunakan untuk mempublikasikan permintaan API.

CreateCertificateFromCsr

Membuat sertifikat dari permintaan penandatanganan sertifikat (CSR). AWS IoT menyediakan sertifikat klien yang ditandatangani oleh otoritas sertifikat Root Amazon (CA). Sertifikat baru memiliki PENDING_ACTIVATION status. Ketika Anda memang RegisterThing gil untuk menyediakan sesuatu dengan sertifikat ini, status sertifikat berubah menjadi ACTIVE atau INACTIVE seperti yang dijelaskan dalam template.

Untuk informasi selengkapnya tentang membuat sertifikat klien menggunakan sertifikat Otoritas Sertifikat dan permintaan penandatanganan sertifikat, lihatMembuat sertifikat klien menggunakan sertifikat CA Anda.

catatan

Untuk keamanan, pengem certificateOwnershipToken balian CreateCertificateFromCsr berakhir setelah satu jam. RegisterThingharus dipanggil sebelum kedalu certificateOwnershipToken warsa. Jika sertifikat yang dibuat oleh CreateCertificateFromCsr belum diaktifkan dan dilampirkan ke kebijakan atau sesuatu pada saat token kedaluwarsa, sertifikat akan dihapus. Jika token kedaluwarsa, perangkat dapat memang CreateCertificateFromCsr gil untuk menghasilkan sertifikat baru.

CreateCertificateFromCsr permintaan

Publikasikan pesan dengan $aws/certificates/create-from-csr/payload-format topik.

payload-format

Format muatan pesan sebagai cbor ataujson.

CreateCertificateFromCsr minta muatan

{
    "certificateSigningRequest": "string"
}
certificateSigningRequest

CSR, dalam format PEM.

CreateCertificateFromCsr tanggapan

Berlangganan$aws/certificates/create-from-csr/payload-format/accepted.

payload-format

Format muatan pesan sebagai cbor ataujson.

CreateCertificateFromCsr muatan respons

{
    "certificateOwnershipToken": "string",
    "certificateId": "string",
    "certificatePem": "string"
}
certificateOwnershipToken

Token untuk membuktikan kepemilikan sertifikat selama penyediaan.

certificateId

ID sertifikat. Operasi manajemen sertifikat hanya mengambil CertificateID.

certificatePem

Data sertifikat, dalam format PEM.

CreateCertificateFromCsr kesalahan

Untuk menerima tanggapan kesalahan, berlangganan$aws/certificates/create-from-csr/payload-format/rejected.

payload-format

Format muatan pesan sebagai cbor ataujson.

CreateCertificateFromCsr kesalahan payload

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

Kode status.

errorCode

Kode kesalahan.

errorMessage

Pesan kesalahan.

CreateKeysAndCertificate

Membuat kunci baru dan sertifikat. AWS IoT menyediakan sertifikat klien yang ditandatangani oleh otoritas sertifikat Root Amazon (CA). Sertifikat baru memiliki PENDING_ACTIVATION status. Ketika Anda memang RegisterThing gil untuk menyediakan sesuatu dengan sertifikat ini, status sertifikat berubah menjadi ACTIVE atau INACTIVE seperti yang dijelaskan dalam template.

catatan

Untuk keamanan, pengem certificateOwnershipToken balian CreateKeysAndCertificate berakhir setelah satu jam. RegisterThingharus dipanggil sebelum kedalu certificateOwnershipToken warsa. Jika sertifikat yang dibuat oleh CreateKeysAndCertificate belum diaktifkan dan dilampirkan ke kebijakan atau sesuatu pada saat token kedaluwarsa, sertifikat akan dihapus. Jika token kedaluwarsa, perangkat dapat memang CreateKeysAndCertificate gil untuk menghasilkan sertifikat baru.

CreateKeysAndCertificate permintaan

Publikasikan pesan $aws/certificates/create/payload-format dengan payload pesan kosong.

payload-format

Format muatan pesan sebagai cbor ataujson.

CreateKeysAndCertificate tanggapan

Berlangganan$aws/certificates/create/payload-format/accepted.

payload-format

Format muatan pesan sebagai cbor ataujson.

CreateKeysAndCertificate tanggapan

{
    "certificateId": "string",
    "certificatePem": "string",
    "privateKey": "string",
    "certificateOwnershipToken": "string"
}
certificateId

ID sertifikat.

certificatePem

Data sertifikat, dalam format PEM.

privateKey

Kunci pribadi.

certificateOwnershipToken

Token untuk membuktikan kepemilikan sertifikat selama penyediaan.

CreateKeysAndCertificate kesalahan

Untuk menerima tanggapan kesalahan, berlangganan$aws/certificates/create/payload-format/rejected.

payload-format

Format muatan pesan sebagai cbor ataujson.

CreateKeysAndCertificate kesalahan payload

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

Kode status.

errorCode

Kode kesalahan.

errorMessage

Pesan kesalahan.

RegisterThing

Menyediakan sesuatu menggunakan template yang telah ditentukan sebelumnya.

RegisterThing permintaan

Publikasikan pesan di$aws/provisioning-templates/templateName/provision/payload-format.

payload-format

Format muatan pesan sebagai cbor ataujson.

templateName

Nama template penyediaan.

RegisterThing minta muatan

{
    "certificateOwnershipToken": "string",
    "parameters": {
        "string": "string",
        ...
    }
}
certificateOwnershipToken

Token untuk membuktikan kepemilikan sertifikat. AWS IoT menghasilkan token saat Anda membuat sertifikat melalui MQTT.

parameters

Opsional. Key-value pasangan dari perangkat yang digunakan oleh kait pra-penyediaan untuk mengevaluasi permintaan pendaftaran.

RegisterThing tanggapan

Berlangganan$aws/provisioning-templates/templateName/provision/payload-format/accepted.

payload-format

Format muatan pesan sebagai cbor ataujson.

templateName

Nama template penyediaan.

RegisterThing muatan respons

{
    "deviceConfiguration": {
        "string": "string",
        ...
    },
    "thingName": "string"
}
deviceConfiguration

Konfigurasi perangkat didefinisikan dalam template.

thingName

Nama benda IoT yang dibuat selama penyediaan.

RegisterThing respon kesalahan

Untuk menerima tanggapan kesalahan, berlangganan$aws/provisioning-templates/templateName/provision/payload-format/rejected.

payload-format

Format muatan pesan sebagai cbor ataujson.

templateName

Nama template penyediaan.

RegisterThing payload respons kesalahan

{
    "statusCode": int,
    "errorCode": "string",
    "errorMessage": "string"
}
statusCode

Kode status.

errorCode

Kode kesalahan.

errorMessage

Pesan kesalahan.