本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。
与组件配置交互
组件配置 IPC 服务允许您执行以下操作：
-
获取和设置组件配置参数。
-
订阅组件配置更新。
-
在 nucleus 应用组件配置更新之前对其进行验证。
主题
最低 SDK 版本
下表列出了与组件配置进行交互时必须使用的最低版本。Amazon IoT Device SDK
| SDK | 最低版本 |
|---|---|
|
v1.2.10 |
|
|
v1.5.3 |
|
|
v1.17.0 |
|
|
v1.12.0 |
GetConfiguration
获取核心设备上某个组件的配置值。您可以指定要获取配置值的密钥路径。
请求
此操作的请求具有以下参数：
componentName（Python:component_name）-
（可选）组件的名称。
默认为发出请求的组件的名称。
keyPath（Python:key_path）-
配置值的密钥路径。指定一个列表，其中每个条目都是配置对象中单个级别的密钥。例如，
["mqtt", "port"]在以下配置port中指定获取的值。{ "mqtt": { "port": 443 } }要获取组件的完整配置，请指定一个空列表。
响应
此操作的响应包含以下信息：
componentName（Python:component_name）-
组件名称。
value-
将请求的配置作为对象。
UpdateConfiguration
更新核心设备上此组件的配置值。
请求
此操作的请求具有以下参数：
keyPath（Python:key_path）-
（可选）要更新的容器节点（对象）的密钥路径。指定一个列表，其中每个条目都是配置对象中单个级别的密钥。例如，在以下配置
port中指定密钥路径["mqtt"]和合并值{ "port": 443 }以设置的值。{ "mqtt": { "port": 443 } }密钥路径必须在配置中指定容器节点（对象）。如果组件的配置中不存在该节点，则此操作会创建该节点并将其值设置为中的对象
valueToMerge。默认为配置对象的根。
timestamp-
当前 Unix 纪元时间（以毫秒为单位）。此操作使用此时间戳来解决密钥的并发更新。如果组件配置中的密钥的时间戳大于请求中的时间戳，则请求会失败。
valueToMerge（Python:value_to_merge）-
要在您指定的位置合并的配置对象
keyPath。有关更多信息，请参阅更新组件配置：
响应
此操作在其响应中不提供任何信息。
SubscribeToConfigurationUpdate
订阅以在组件的配置更新时接收通知。当您订阅某个密钥时，当该密钥的任何子项更新时，您会收到通知。
此操作是一种订阅操作，您可以在其中订阅事件消息流。要使用此操作，请定义一个带有处理事件消息、错误和流关闭的函数的流响应处理器。有关更多信息，请参阅订阅 IPC 事件直播：
事件消息类型：ConfigurationUpdateEvents
请求
此操作的请求具有以下参数：
componentName（Python:component_name）-
（可选）组件的名称。
默认为发出请求的组件的名称。
keyPath（Python:key_path）-
要订阅的配置值的密钥路径。指定一个列表，其中每个条目都是配置对象中单个级别的密钥。例如，
["mqtt", "port"]在以下配置port中指定获取的值。{ "mqtt": { "port": 443 } }要订阅组件配置中所有值的更新，请指定一个空列表。
响应
此操作的响应包含以下信息：
messages-
通知消息流。此对象包含以下信息：
ConfigurationUpdateEventsconfigurationUpdateEvent（Python:configuration_update_event）-
配置更新事件。此对象包含以下信息：
ConfigurationUpdateEventcomponentName（Python:component_name）-
组件名称。
keyPath（Python:key_path）-
已更新的配置值的密钥路径。
SubscribeToValidateConfigurationUpdates
订阅以在此组件的配置更新之前接收通知。这允许组件验证其自身配置的更新。使用SendConfigurationValidityReport操作来告诉核心配置是否有效。
重要
本地部署不会将更新通知组件。
此操作是一种订阅操作，您可以在其中订阅事件消息流。要使用此操作，请定义一个带有处理事件消息、错误和流关闭的函数的流响应处理器。有关更多信息，请参阅订阅 IPC 事件直播：
事件消息类型：ValidateConfigurationUpdateEvents
请求
此操作的请求没有任何参数。
响应
此操作的响应包含以下信息：
messages-
通知消息流。此对象包含以下信息：
ValidateConfigurationUpdateEventsvalidateConfigurationUpdateEvent（Python:validate_configuration_update_event）-
配置更新事件。此对象包含以下信息：
ValidateConfigurationUpdateEventdeploymentId（Python:deployment_id）-
更新组件的Amazon IoT Greengrass部署的 ID。
configuration-
包含新配置的对象。
SendConfigurationValidityReport
告诉 nucleus 此组件的配置更新是否有效。如果您告诉 nucleus 新配置无效，部署将失败。使用SubscribeToValidateConfigurationUpdates操作订阅来验证配置更新。
如果组件不响应验证配置更新通知，则 nucleus 将等待您在部署的配置验证策略中指定的时间。超时后，核心继续部署。默认组件验证超时为 20 秒。有关更多信息，请参阅创建部署和调用CreateDeployment操作时可以提供的DeploymentConfigurationValidationPolicy对象。
请求
此操作的请求具有以下参数：
configurationValidityReport（Python:configuration_validity_report）-
该报告告诉 nucleus 配置更新是否有效。此对象包含以下信息：
ConfigurationValidityReportstatus-
有效性状态。此枚举具有以下值：
ConfigurationValidityStatus-
ACCEPTED— 配置有效，nucleus 可以将其应用于此组件。 -
REJECTED— 配置无效，部署失败。
-
deploymentId（Python:deployment_id）-
请求配置更新的Amazon IoT Greengrass部署的 ID。
message-
（可选）报告配置无效原因的消息。
响应
此操作在其响应中不提供任何信息。