API de MQTT de aprovisionamiento de dispositivos

El servicio Fleet Provisioning admite las siguientes operaciones de la API MQTT:

• CreateCertificateFromCsr

• CreateKeysAndCertificate

• RegisterThing

Esta API admite búferes de respuesta en formato de representación concisa de objetos binarios (CBOR) y notación de JavaScript objetos (JSON), según el formato de carga útil del tema. Para mayor claridad, los ejemplos de respuesta y solicitud de esta sección se muestran en formato JSON.

payload-format	Tipo de datos de formato de respuesta
cbor	Concise Binary Object Representation (Representación concisa de objetos binarios, CBOR)
json	JavaScript Notación de objetos (JSON)

importante

Antes de publicar un tema de mensaje de solicitud, suscríbase a los temas de respuesta para recibir la respuesta. Los mensajes utilizados por esta API utilizan el protocolo de publicación/suscripción de MQTT para proporcionar una interacción de solicitud y respuesta.

Si no te suscribes a los temas de respuesta antes de publicar una solicitud, es posible que no recibas los resultados de esa solicitud.

CreateCertificateFromCsr

Crea un certificado a partir de una solicitud de firma de certificado (CSR). AWS IoT proporciona certificados de cliente firmados por la autoridad de certificación (CA) raíz de Amazon. El nuevo certificado tiene un estado PENDING_ACTIVATION. Cuando llama a RegisterThing para aprovisionar un objeto con este certificado, el estado del certificado cambia a la plantilla ACTIVE o INACTIVE tal como se describe en ella.

Para obtener más información sobre cómo crear un certificado de cliente con el certificado de la autoridad de certificación y una solicitud de firma de certificado, consulte Crear un certificado de cliente mediante el certificado de entidad de certificación.

nota

Por motivos de seguridad, el certificateOwnershipToken devuelto por CreateCertificateFromCsr caduca al cabo de una hora. Se debe llamar a RegisterThing antes de que venza certificateOwnershipToken. Si el certificado creado por no CreateCertificateFromCsr se activó ni se adjuntó a una política o a un elemento antes de que caduque el token, el certificado se eliminará. Si el token caduca, el dispositivo puede realizar una llamada CreateCertificateFromCsr para generar un certificado nuevo.

CreateCertificateFromCsrsolicitud

Publicar un mensaje con el tema $aws/certificates/create-from-csr/payload-format.

payload-format

El formato de carga del mensaje como cbor o json.

CreateCertificateFromCsrsolicitar carga útil

{
    "certificateSigningRequest": "string"
}

certificateSigningRequest

La CSR, en formato PEM.

Respuesta de CreateCertificateFromCsr

Suscripción a $aws/certificates/create-from-csr/payload-format/accepted

payload-format

El formato de carga del mensaje como cbor o json.

CreateCertificateFromCsr carga útil de respuesta

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

certificateOwnershipToken

El token para comprobar la propiedad del certificado durante el aprovisionamiento.

certificateId

El ID del certificado. Las operaciones de administración de certificados solo adoptan un certificateId.

certificatePem

Los datos del certificado, en formato PEM.

CreateCertificateFromCsr error

Para recibir respuestas de error, suscríbase a $aws/certificates/create-from-csr/payload-format/rejected.

payload-format

El formato de carga del mensaje como cbor o json.

CreateCertificateFromCsr carga útil de error

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

statusCode

El código del estado.

errorCode

Código de error.

errorMessage

Mensaje de error.

CreateKeysAndCertificate

Crea nuevas claves y un certificado. AWS IoT proporciona certificados de cliente firmados por la autoridad de certificación (CA) raíz de Amazon. El nuevo certificado tiene un estado PENDING_ACTIVATION. Cuando llama a RegisterThing para aprovisionar un objeto con este certificado, el estado del certificado cambia a la plantilla ACTIVE o INACTIVE tal como se describe en ella.

nota

Por motivos de seguridad, el certificateOwnershipToken devuelto por CreateKeysAndCertificate caduca al cabo de una hora. Se debe llamar a RegisterThing antes de que venza certificateOwnershipToken. Si el certificado creado por no CreateKeysAndCertificate se activó ni se adjuntó a una política o a un elemento antes de que caduque el token, el certificado se eliminará. Si el token caduca, el dispositivo puede realizar una llamada CreateKeysAndCertificate para generar un certificado nuevo.

CreateKeysAndCertificatesolicitud

Publicar un mensaje en $aws/certificates/create/payload-format con una carga de mensajes vacía.

payload-format

El formato de carga del mensaje como cbor o json.

Respuesta de CreateKeysAndCertificate

Suscripción a $aws/certificates/create/payload-format/accepted

payload-format

El formato de carga del mensaje como cbor o json.

Respuesta de CreateKeysAndCertificate

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

certificateId

El ID del certificado.

certificatePem

Los datos del certificado, en formato PEM.

privateKey

La clave privada.

certificateOwnershipToken

El token para comprobar la propiedad del certificado durante el aprovisionamiento.

CreateKeysAndCertificate error

Para recibir respuestas de error, suscríbase a $aws/certificates/create/payload-format/rejected.

payload-format

El formato de carga del mensaje como cbor o json.

CreateKeysAndCertificatecarga útil de error

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

statusCode

El código del estado.

errorCode

Código de error.

errorMessage

Mensaje de error.

RegisterThing

Aprovisiona un objeto mediante una plantilla predefinida.

RegisterThing solicitud

Publica un mensaje en $aws/provisioning-templates/templateName/provision/payload-format.

payload-format

El formato de carga del mensaje como cbor o json.

templateName

El nombre de la plantilla de aprovisionamiento.

RegisterThing solicitar carga útil

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

certificateOwnershipToken

El token que demuestra la propiedad del certificado. AWS IoT genera el token al crear un certificado a través de MQTT.

parameters

Opcional. Pares clave-valor del dispositivo que utilizan los enlaces de preaprovisionamiento para evaluar la solicitud de registro.

RegisterThing respuesta

Suscripción a $aws/provisioning-templates/templateName/provision/payload-format/accepted

payload-format

El formato de carga del mensaje como cbor o json.

templateName

El nombre de la plantilla de aprovisionamiento.

RegisterThing carga útil de respuesta

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

deviceConfiguration

La configuración del dispositivo definida en la plantilla.

thingName

El nombre de la cosa de IoT creado durante el aprovisionamiento.

RegisterThing respuesta de error

Para recibir respuestas de error, suscríbase a $aws/provisioning-templates/templateName/provision/payload-format/rejected.

payload-format

El formato de carga del mensaje como cbor o json.

templateName

El nombre de la plantilla de aprovisionamiento.

RegisterThing carga útil de respuesta a errores

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

statusCode

El código del estado.

errorCode

Código de error.

errorMessage

Mensaje de error.