AWS IoT
开发人员指南
AWS 文档中描述的 AWS 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅 Amazon AWS 入门

RegisterCACertificate

RegisterCACertificate

向 AWS IoT 注册 CA 证书。此 CA 证书可用于对设备证书进行签名,而设备证书随后可注册到 AWS IoT。您最多可以为每个 AWS 账户注册 10 个具有相同主题字段的 CA 证书。这使得您可以让最多 10 个证书颁发机构对您的设备证书进行签名。如果您注册了多个 CA 证书,请确保在使用 RegisterCertificate API 注册设备证书时传递了 CA 证书。

https

请求语法:

POST /cacertificate?setAsActive=setAsActive&allowAutoRegistration=allowAutoRegistration Content-type: application/json { "caCertificate": "string", "verificationCertificate": "string", "registrationConfig": { "templateBody": "string", "roleArn": "string" } }

URI 请求参数:

名称

类型

请求?

描述

setAsActive

SetAsActive

指定 CA 证书是否设置为活动状态的布尔值。

allowAutoRegistration

AllowAutoRegistration

允许将此 CA 证书用于自动注册设备证书。

请求正文参数:

名称

类型

请求?

描述

caCertificate

CertificatePem

CA 证书。

verificationCertificate

CertificatePem

私有密钥验证证书。

registrationConfig

RegistrationConfig

有关注册配置的信息。

响应语法:

Content-type: application/json { "certificateArn": "string", "certificateId": "string" }

响应正文参数:

名称

类型

请求?

描述

certificateArn

CertificateArn

CA 证书 ARN。

certificateId

CertificateId

CA 证书标识符。

错误:

ResourceAlreadyExistsException

该资源已存在。

HTTP 响应代码:409

RegistrationCodeValidationException

注册代码无效。

HTTP 响应代码:400

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

HTTP 响应代码:400

CertificateValidationException

证书无效。

HTTP 响应代码:400

ThrottlingException

速率超过限制。

HTTP 响应代码:429

LimitExceededException

附加的实体数超过了限制。

HTTP 响应代码:410

UnauthorizedException

您没有权限执行此操作。

HTTP 响应代码:401

ServiceUnavailableException

服务暂时不可用。

HTTP 响应代码:503

InternalFailureException

出现意外错误。

HTTP 响应代码:500

cli

摘要:

aws iot register-ca-certificate \ --ca-certificate <value> \ --verification-certificate <value> \ [--set-as-active | --no-set-as-active] \ [--allow-auto-registration | --no-allow-auto-registration] \ [--registration-config <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "caCertificate": "string", "verificationCertificate": "string", "setAsActive": "boolean", "allowAutoRegistration": "boolean", "registrationConfig": { "templateBody": "string", "roleArn": "string" } }

cli-input-json 字段:

名称

类型

描述

caCertificate

字符串

最大长度:65536,最小长度:1

CA 证书。

verificationCertificate

字符串

最大长度:65536,最小长度:1

私有密钥验证证书。

setAsActive

布尔值

指定 CA 证书是否设置为活动状态的布尔值。

allowAutoRegistration

布尔值

允许将此 CA 证书用于自动注册设备证书。

registrationConfig

RegistrationConfig

有关注册配置的信息。

templateBody

字符串

模板正文。

roleArn

字符串

最大长度:2048,最小长度:20

角色的 ARN。

输出:

{ "certificateArn": "string", "certificateId": "string" }

cli 输出字段:

名称

类型

描述

certificateArn

字符串

CA 证书 ARN。

certificateId

字符串

最大长度:64,最小长度:64

模式:(0x)?[a-fA-F0-9]+

CA 证书标识符。

错误:

ResourceAlreadyExistsException

该资源已存在。

RegistrationCodeValidationException

注册代码无效。

InvalidRequestException

请求的内容无效。例如,UpdateJobExecution 请求包含无效状态详细信息时,将返回此代码。消息包含有关错误的详细信息。

CertificateValidationException

证书无效。

ThrottlingException

速率超过限制。

LimitExceededException

附加的实体数超过了限制。

UnauthorizedException

您没有权限执行此操作。

ServiceUnavailableException

服务暂时不可用。

InternalFailureException

出现意外错误。