与组件配置交互 - Amazon IoT Greengrass
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

与组件配置交互

组件配置 IPC 服务让您可以执行以下操作:

  • 获取和设置组件配置参数。

  • 订阅组件配置更新。

  • 在核心应用组件配置更新之前验证这些更新。

GetConfiguration

获取核心设备上组件的配置值。您可以指定要获取配置值的键路径。

Request

该操作的请求具有以下参数:

componentName

(可选)组件名称。

默认为发出请求的组件的名称。

keyPath

配置值的密钥路径。指定一个列表,其中每个条目都是配置对象中单个级别的键。例如,指定["mqtt", "port"]来获取port,以下配置。

{ "mqtt": { "port": 443 } }

Response

该操作的响应包含以下信息:

componentName

组件名称。

value

请求的配置作为对象。

UpdateConfiguration

更新核心设备上组件的配置值。

Request

该操作的请求具有以下参数:

keyPath

(可选)要更新的容器节点(对象)的键路径。指定一个列表,其中每个条目都是配置对象中单个级别的键。例如,指定键路径["mqtt"]和合并值{ "port": 443 }设置port,以下配置。

{ "mqtt": { "port": 443 } }

键路径必须在配置中指定容器节点(对象)。如果该节点不存在于组件的配置中,则此操作将创建该节点并将其值设置为valueToMerge.

默认为配置对象的根级。

timestamp

当前 Unix 纪元时间(以毫秒为单位)。此操作使用此时间戳来解析对键的并发更新。如果组件配置中的密钥的时间戳大于请求中的时间戳,则请求将失败。

valueToMerge

要在您指定的位置合并的配置对象keyPath. 有关更多信息,请参阅更新组件配置

Response

此操作在其响应中不提供任何信息。

SubscribeToConfigurationUpdate

订阅组件配置更新时接收通知。订阅密钥时,当该密钥的任何子项更新时,您会收到通知。

此操作是订阅事件消息流的订阅操作。要使用此操作,请使用处理事件消息、错误和流关闭的函数定义流响应处理程序。有关更多信息,请参阅订阅 IPC 事件流

事件消息类型: ConfigurationUpdateEvents

Request

该操作的请求具有以下参数:

componentName

(可选)组件名称。

默认为发出请求的组件的名称。

keyPath

要订阅的配置值的键路径。指定一个列表,其中每个条目都是配置对象中单个级别的键。例如,指定["mqtt", "port"]来获取port,以下配置。

{ "mqtt": { "port": 443 } }

Response

该操作的响应包含以下信息:

messages

通知消息流。这个对象,ConfigurationUpdateEvents,包含以下信息:

configurationUpdateEvent

配置更新事件。这个对象,ConfigurationUpdateEvent,包含以下信息:

componentName

组件名称。

keyPath

更新的配置值的键路径。

SubscribeToValidateConfigurationUpdates

订阅以在此组件的配置更新之前接收通知。这样,组件就可以验证对其自身配置的更新。使用SendConfigurationValidityReport操作来告诉核心配置是否有效。

重要

本地部署不会通知组件更新。

此操作是订阅事件消息流的订阅操作。要使用此操作,请使用处理事件消息、错误和流关闭的函数定义流响应处理程序。有关更多信息,请参阅订阅 IPC 事件流

事件消息类型: ValidateConfigurationUpdateEvents

Request

此操作的请求没有任何参数。

Response

该操作的响应包含以下信息:

messages

通知消息流。这个对象,ValidateConfigurationUpdateEvents,包含以下信息:

validateConfigurationUpdateEvent

配置更新事件。这个对象,ValidateConfigurationUpdateEvent,包含以下信息:

deploymentId

的 IDAmazon IoT Greengrass部署来更新组件。

configuration

包含新配置的对象。

SendConfigurationValidityReport

告诉核心对此组件的配置更新是否有效。如果您告诉核心新配置无效,部署将失败。使用SubscribeToValidateConfigurationUpdates操作订阅以验证配置更新。

如果组件未响应验证配置更新通知,则核心将等待您在部署的配置验证策略中指定的时间。超时后,核心继续部署。默认组件验证超时为 20 秒。有关更多信息,请参阅 。创建部署配置验证策略对象,您可以在调用CreateDeploymentoperation.

Request

该操作的请求具有以下参数:

configurationValidityReport

告诉核心配置更新是否有效的报告。这个对象,ConfigurationValidityReport,包含以下信息:

status

有效性状态。该枚举,ConfigurationValidityStatus,具有以下值:

  • ACCEPTED— 配置有效,核心可以将其应用于此组件。

  • REJECTED— 配置无效且部署失败。

deploymentId

的 IDAmazon IoT Greengrass部署,请求配置更新。

message

(可选)报告配置无效的原因的消息。

Response

此操作在其响应中不提供任何信息。