翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

デバイスプロビジョニング MQTT API

フリートプロビジョニングサービスは、次の MQTT API オペレーションをサポートします。

この API は、トピックのペイロード形式に応じて、簡潔なバイナリオブジェクト表現 (CBOR) 形式と JavaScript オブジェクト表記 (JSON) 形式のレスポンスバッファをサポートします。 わかりやすくするために、このセクションのレスポンスとリクエストの例は JSON 形式で示されています。

CreateCertificateFromCsr

証明書署名リクエスト (CSR) から証明書を作成します。 は、Amazon ルート認証局 (CA) によって署名されたクライアント証明書 AWS IoT を提供します。新しい証明書には PENDING_ACTIVATION ステータスがあります。RegisterThing を呼び出して、この証明書を使用してモノをプロビジョニングすると、テンプレートで説明されているように、証明書のステータスが ACTIVE または INACTIVE に変わります。

認証局証明書と証明書署名リクエストを使用してクライアント証明書を作成する方法の詳細については、「CA 証明書を使用してクライアント証明書を作成する」を参照してください。

CreateCertificateFromCsr リクエスト

$aws/certificates/create-from-csr/payload-format トピックを含むメッセージを発行します。

CreateCertificateFromCsr リクエストペイロード

{
    "certificateSigningRequest": "string"
}

CreateCertificateFromCsr レスポンス

$aws/certificates/create-from-csr/payload-format/accepted​ をサブスクライブします。

CreateCertificateFromCsr レスポンスペイロード

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

CreateCertificateFromCsr エラー

エラーレスポンスを受信するには、$aws/certificates/create-from-csr/payload-format/rejected をサブスクライブします。

CreateCertificateFromCsr エラーペイロード

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

CreateKeysAndCertificate

新しいキーと certificate を作成します。Amazon ルート認証局 (CA) によって署名されたクライアント証明書 AWS IoT を提供します。新しい証明書には PENDING_ACTIVATION ステータスがあります。RegisterThing を呼び出して、この証明書を使用してモノをプロビジョニングすると、テンプレートで説明されているように、証明書のステータスが ACTIVE または INACTIVE に変わります。

CreateKeysAndCertificate リクエスト

空のメッセージペイロードで $aws/certificates/create/payload-format にメッセージを発行します。

CreateKeysAndCertificate レスポンス

$aws/certificates/create/payload-format/accepted​ をサブスクライブします。

CreateKeysAndCertificate レスポンス

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

CreateKeysAndCertificate エラー

エラーレスポンスを受信するには、$aws/certificates/create/payload-format/rejected をサブスクライブします。

CreateKeysAndCertificate エラーペイロード

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

RegisterThing

事前定義されたテンプレートを使用してモノをプロビジョニングします。

RegisterThing リクエスト

$aws/provisioning-templates/templateName/provision/payload-format にメッセージを発行します。

RegisterThing リクエストペイロード

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

RegisterThing レスポンス

$aws/provisioning-templates/templateName/provision/payload-format/accepted​ をサブスクライブします。

RegisterThing レスポンスペイロード

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

RegisterThing エラーレスポンス

エラーレスポンスを受信するには、$aws/provisioning-templates/templateName/provision/payload-format/rejected をサブスクライブします。

RegisterThing エラーレスポンスペイロード

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