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 Penyediaan Armada mendukung operasi API MQTT berikut:

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

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

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

Jika Anda tidak berlangganan topik respons sebelum memublikasikan permintaan, Anda mungkin tidak menerima hasil permintaan tersebut.

CreateCertificateFromCsr

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

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

catatan

Untuk keamanan, yang certificateOwnershipToken dikembalikan CreateCertificateFromCsr kedaluwarsa setelah satu jam. RegisterThingharus dipanggil sebelum certificateOwnershipToken kedaluwarsa. Jika sertifikat yang dibuat oleh CreateCertificateFromCsr belum diaktifkan dan dilampirkan pada kebijakan atau sesuatu pada saat token kedaluwarsa, sertifikat akan dihapus. Jika token kedaluwarsa, perangkat dapat menelepon CreateCertificateFromCsr untuk menghasilkan sertifikat baru.

CreateCertificateFromCsrpermintaan

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

payload-format

Format payload pesan sebagai cbor ataujson.

CreateCertificateFromCsrminta muatan

{
    "certificateSigningRequest": "string"
}
certificateSigningRequest

CSR, dalam format PEM.

CreateCertificateFromCsrrespon

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

payload-format

Format payload 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 payload pesan sebagai cbor ataujson.

CreateCertificateFromCsr kesalahan muatan

{
    "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 Amazon Root (CA). Sertifikat baru memiliki PENDING_ACTIVATION status. Saat Anda menelepon RegisterThing untuk menyediakan sesuatu dengan sertifikat ini, status sertifikat berubah menjadi ACTIVE atau INACTIVE seperti yang dijelaskan dalam templat.

catatan

Untuk keamanan, yang certificateOwnershipToken dikembalikan CreateKeysAndCertificate kedaluwarsa setelah satu jam. RegisterThingharus dipanggil sebelum certificateOwnershipToken kedaluwarsa. Jika sertifikat yang dibuat oleh CreateKeysAndCertificate belum diaktifkan dan dilampirkan pada kebijakan atau sesuatu pada saat token kedaluwarsa, sertifikat akan dihapus. Jika token kedaluwarsa, perangkat dapat menelepon CreateKeysAndCertificate untuk menghasilkan sertifikat baru.

CreateKeysAndCertificatepermintaan

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

payload-format

Format payload pesan sebagai cbor ataujson.

CreateKeysAndCertificaterespon

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

payload-format

Format payload pesan sebagai cbor ataujson.

CreateKeysAndCertificaterespon

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

ID sertifikat.

certificatePem

Data sertifikat, dalam format PEM.

privateKey

Kunci privat.

certificateOwnershipToken

Token untuk membuktikan kepemilikan sertifikat selama penyediaan.

CreateKeysAndCertificate kesalahan

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

payload-format

Format payload pesan sebagai cbor ataujson.

CreateKeysAndCertificatekesalahan muatan

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

Kode status.

errorCode

Kode kesalahan.

errorMessage

Pesan kesalahan.

RegisterThing

Ketentuan sesuatu menggunakan template yang telah ditentukan sebelumnya.

RegisterThing permintaan

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

payload-format

Format payload 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

Tidak wajib. Pasangan nilai kunci dari perangkat yang digunakan oleh kait pra-penyediaan untuk mengevaluasi permintaan pendaftaran.

RegisterThing respon

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

payload-format

Format payload pesan sebagai cbor ataujson.

templateName

Nama template penyediaan.

RegisterThing muatan respons

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

Konfigurasi perangkat didefinisikan dalam template.

thingName

Nama hal IoT yang dibuat selama penyediaan.

RegisterThing respon kesalahan

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

payload-format

Format payload pesan sebagai cbor ataujson.

templateName

Nama template penyediaan.

RegisterThing muatan respons kesalahan

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

Kode status.

errorCode

Kode kesalahan.

errorMessage

Pesan kesalahan.