「翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。」
デバイスプロビジョニング MQTT API
フリートプロビジョニングサービスは、次の MQTT APIs をサポートします。
この API は、 に応じて、簡潔なバイナリオブジェクト表現 (CCOR) 形式および JavaScript オブジェクト表記 (JSON) 形式のレスポンスバッファをサポートします。payload-format
トピックの 。ただし、わかりやすくするために、このセクションのレスポンスとリクエストの例を JSON 形式で示します。
payload-format |
レスポンス形式のデータ型 |
---|---|
cbor | 簡潔なバイナリオブジェクトの表現 (CCOR) |
json | JavaScript オブジェクト表記 (JSON) |
リクエストメッセージトピックを発行する前に、応答トピックをサブスクライブしてレスポンスを受信します。この API で使用されるメッセージは、MQTT のパブリッシュ/サブスクライブプロトコルを使用して、リクエストとレスポンスの相互作用を提供します。
リクエストを発行する前にレスポントピックをサブスクライブしていない場合、そのリクエストの結果を受信できない可能性があります。
CreateCertificateFromCsr
証明書署名リクエスト (CSR) から証明書を作成します。新しい証明書には PENDING_ACTIVATION
ステータスがあります。RegisterThing
を呼び出して、この証明書を使用してモノをプロビジョニングすると、テンプレートで説明されているように、証明書のステータスが ACTIVE
または INACTIVE
に変わります。
CreateCertificateFromCsrリクエスト
$aws/certificates/create-from-csr/
トピックを含むメッセージを発行します。
payload-format
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。
CreateCertificateFromCsr リクエストペイロード
{ "certificateSigningRequest": "string" }
certificateSigningRequest
-
PEM 形式の CSR。
CreateCertificateFromCsr レスポンス
$aws/certificates/create-from-csr/
をサブスクライブします。
payload-format
/accepted
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。
CreateCertificateFromCsr レスポンスペイロード
{ "certificateOwnershipToken": "string", "certificateId": "string", "certificatePem": "string" }
certificateOwnershipToken
-
プロビジョニング中に証明書の所有権を証明するトークン。
certificateId
-
証明書の ID。証明書管理オペレーションでは、certificateId のみが使用されます。
certificatePem
-
PEM 形式の証明書データ。
CreateCertificateFromCsr エラー
エラーレスポンスを受信するには、$aws/certificates/create-from-csr/
をサブスクライブします。
payload-format
/rejected
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。
CreateCertificateFromCsr エラーペイロード
{ "statusCode": int, "errorCode": "string", "errorMessage": "string" }
statusCode
-
ステータスコード。
errorCode
-
エラーコード。
errorMessage
-
エラーメッセージ。
CreateKeysAndCertificate
新しいキーと証明書を作成します。新しい証明書には PENDING_ACTIVATION
ステータスがあります。RegisterThing
を呼び出して、この証明書を使用してモノをプロビジョニングすると、テンプレートで説明されているように、証明書のステータスが ACTIVE
または INACTIVE
に変わります。
CreateKeysAndCertificateリクエスト
空のメッセージペイロードで $aws/certificates/create/
にメッセージを発行します。
payload-format
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。
CreateKeysAndCertificate レスポンス
$aws/certificates/create/
をサブスクライブします。
payload-format
/accepted
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。
CreateKeysAndCertificate レスポンス
{ "certificateId": "string", "certificatePem": "string", "privateKey": "string", "certificateOwnershipToken": "string" }
certificateId
-
証明書 ID。
certificatePem
-
PEM 形式の証明書データ。
privateKey
-
プライベートキー。
certificateOwnershipToken
-
プロビジョニング中に証明書の所有権を証明するトークン。
CreateKeysAndCertificate エラー
エラーレスポンスを受信するには、$aws/certificates/create/
をサブスクライブします。
payload-format
/rejected
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。
CreateKeysAndCertificate エラーペイロード
{ "statusCode": int, "errorCode": "string", "errorMessage": "string" }
statusCode
-
ステータスコード。
errorCode
-
エラーコード。
errorMessage
-
エラーメッセージ。
RegisterThing
事前定義されたテンプレートを使用してモノをプロビジョニングします。
RegisterThingリクエスト
$aws/provisioning-templates/
にメッセージを発行します。
templateName
/provision/payload-format
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。 templateName
-
プロビジョニングテンプレート名。
RegisterThing リクエストペイロード
{ "certificateOwnershipToken": "string", "parameters": { "string": "string", ... } }
certificateOwnershipToken
-
証明書の所有権を証明するトークン。トークンは、MQTT 経由で証明書を作成するときに AWS IoT によって生成されます。
parameters
-
省略可能。登録リクエストを評価するために事前プロビジョニングフックで使用されるデバイスからの、キーと値のペア。
RegisterThing レスポンス
$aws/provisioning-templates/
をサブスクライブします。
templateName
/provision/payload-format
/accepted
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。 templateName
-
プロビジョニングテンプレート名。
RegisterThing レスポンスペイロード
{ "deviceConfiguration": { "string": "string", ... }, "thingName": "string" }
deviceConfiguration
-
テンプレートで定義されているデバイス設定。
thingName
-
プロビジョニング中に作成される IoT モノの名前。
RegisterThing エラーレスポンス
エラーレスポンスを受信するには、$aws/provisioning-templates/
をサブスクライブします。
templateName
/provision/payload-format
/rejected
payload-format
-
メッセージペイロード形式 (
cbor
またはjson
)。 templateName
-
プロビジョニングテンプレート名。
RegisterThing エラーレスポンスペイロード
{ "statusCode": int, "errorCode": "string", "errorMessage": "string" }
statusCode
-
ステータスコード。
errorCode
-
エラーコード。
errorMessage
-
エラーメッセージ。