本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。
与组件生命周期交互
使用组件生命周期 IPC 服务可以:
-
更新核心设备上的组件状态。
-
订阅组件状态更新。
-
防止 nucleus 在部署期间停止组件以应用更新。
-
暂停和恢复组件进程。
主题
SDK 的最低版本
下表列出了在与组件生命周期交互时必须使用的最低版本。Amazon IoT Device SDK
SDK | 最低版本 |
---|---|
v1.2.10 |
|
v1.5.3 |
|
v1.17.0 |
|
v1.12.0 |
授权
要暂停或恢复自定义组件中的其他组件,必须定义允许您的组件管理其他组件的授权策略。有关定义授权策略的信息,请参阅授权组件执行IPC操作。
组件生命周期管理的授权策略具有以下属性。
IPC 服务标识符:aws.greengrass.ipc.lifecycle
操作 | 描述 | 资源 |
---|---|---|
|
允许组件暂停您指定的组件。 |
组件名称,或者 |
|
允许组件恢复您指定的组件。 |
组件名称,或者 |
|
允许组件暂停和恢复您指定的组件。 |
组件名称,或者 |
授权策略示例
您可以参考以下授权策略示例,以帮助您为组件配置授权策略。
例 授权策略示例
以下示例授权策略允许组件暂停和恢复所有组件。
{ "accessControl": { "aws.greengrass.ipc.lifecycle": { "
com.example.MyLocalLifecycleComponent
:lifecycle:1": { "policyDescription": "Allows access to pause/resume all components.", "operations": [ "aws.greengrass#PauseComponent", "aws.greengrass#ResumeComponent" ], "resources": [ "*" ] } } } }
UpdateState
更新核心设备上组件的状态。
请求
此操作的请求具有以下参数:
state
-
要设置的状态。这个枚举
LifecycleState
具有以下值:-
RUNNING
-
ERRORED
-
响应
此操作在其响应中未提供任何信息。
SubscribeToComponentUpdates
订阅即可在 Amazon IoT Greengrass Core 软件更新组件之前接收通知。该通知指定了在更新过程中核是否会重新启动。
只有当部署的组件更新策略指定通知组件时,nucleus 才会发送更新通知。默认行为是通知组件。有关更多信息,请参阅创建部署以及您在调用CreateDeployment操作时可以提供的DeploymentComponentUpdatePolicy对象。
重要
本地部署不会在更新之前通知组件。
此操作是一种订阅操作,您可以在其中订阅事件消息流。要使用此操作,请定义一个流响应处理程序,其中包含处理事件消息、错误和流关闭的函数。有关更多信息,请参阅 订阅IPC活动直播。
事件消息类型:ComponentUpdatePolicyEvents
提示
你可以按照教程学习如何开发一个有条件地推迟组件更新的组件。有关更多信息,请参阅 教程:开发一个可以延迟组件更新的 Greengrass 组件。
请求
此操作的请求没有任何参数。
响应
此操作的响应包含以下信息:
messages
-
通知消息流。此对象包含以下信息:
ComponentUpdatePolicyEvents
preUpdateEvent
(Python:pre_update_event
)-
(可选)指示 nucleus 想要更新组件的事件。您可以通过DeferComponentUpdate操作进行响应,以确认更新或推迟更新,直到您的组件准备好重启为止。此对象包含以下信息:
PreComponentUpdateEvent
deploymentId
(Python:deployment_id
)-
更新组件的Amazon IoT Greengrass部署的 ID。
isGgcRestarting
(Python:is_ggc_restarting
)-
Nucleus 是否需要重启才能应用更新。
postUpdateEvent
(Python:post_update_event
)-
(可选)指示 nucleus 更新组件的事件。此对象包含以下信息:
PostComponentUpdateEvent
deploymentId
(Python:deployment_id
)-
更新组件的Amazon IoT Greengrass部署的 ID。
注意
此功能需要 Greengrass nucleus 组件的 v2.7.0 或更高版本。
DeferComponentUpdate
确认或推迟您发现的组件更新SubscribeToComponentUpdates。您可以指定在组件是否准备好让组件更新继续进行之前等待的时间。您也可以使用此操作告诉 nucleus 您的组件已准备好进行更新。
如果某个组件未响应组件更新通知,则 nucleus 会等待您在部署组件更新策略中指定的时间。超时之后,核心继续部署。默认的组件更新超时时间为 60 秒。有关更多信息,请参阅创建部署以及您在调用CreateDeployment操作时可以提供的DeploymentComponentUpdatePolicy对象。
提示
你可以按照教程学习如何开发一个有条件地推迟组件更新的组件。有关更多信息,请参阅 教程:开发一个可以延迟组件更新的 Greengrass 组件。
请求
此操作的请求具有以下参数:
deploymentId
(Python:deployment_id
)-
要推迟的Amazon IoT Greengrass部署的 ID。
message
-
(可选)要推迟更新的组件的名称。
默认为发出请求的组件的名称。
recheckAfterMs
(Python:recheck_after_ms
)-
延迟更新的时间(以毫秒为单位)。原子核会等待这段时间,然后发送另一个你可以用它
PreComponentUpdateEvent
来发现。SubscribeToComponentUpdates指定
0
以确认更新。这会告诉 nucleus 您的组件已准备好进行更新。默认为零毫秒,这意味着确认更新。
响应
此操作在其响应中未提供任何信息。
PauseComponent
此功能适用于 Greengrass nucleus 组件的 v2.4.0 及更高版本。 Amazon IoT Greengrass目前不支持在 Windows 核心设备上使用此功能。
在核心设备上暂停组件的进程。要恢复组件,请使用ResumeComponent操作。
只能暂停通用组件。如果您尝试暂停任何其他类型的组件,则此操作会抛出。InvalidRequestError
此操作不会暂停组件依赖项或依赖于您暂停的组件的组件。当你暂停依赖于另一个组件的组件时,请考虑这种行为,因为依赖组件在暂停依赖关系时可能会遇到问题。
当您重启或关闭已暂停的组件时(例如通过部署),Greengrass nucleus 会恢复该组件并运行其关闭生命周期。有关重启组件的更多信息,请参阅RestartComponent。
重要
要使用此操作,您必须定义授权策略来授予使用此操作的权限。有关更多信息,请参阅 授权。
SDK 的最低版本
下表列出了暂停和恢复组件时Amazon IoT Device SDK必须使用的最低版本。
SDK | 最低版本 |
---|---|
v1.4.3 |
|
v1.6.2 |
|
v1.13.1 |
|
v1.12.0 |
请求
此操作的请求具有以下参数:
componentName
(Python:component_name
)-
要暂停的组件的名称,它必须是通用组件。有关更多信息,请参阅 组件类型。
响应
此操作在其响应中未提供任何信息。
ResumeComponent
此功能适用于 Greengrass nucleus 组件的 v2.4.0 及更高版本。 Amazon IoT Greengrass目前不支持在 Windows 核心设备上使用此功能。
在核心设备上恢复组件的进程。要暂停组件,请使用PauseComponent操作。
您只能恢复已暂停的组件。如果您尝试恢复未暂停的组件,则此操作会抛出。InvalidRequestError
重要
要使用此操作,您必须定义授权策略来授予执行此操作的权限。有关更多信息,请参阅 授权。
SDK 的最低版本
下表列出了暂停和恢复组件时Amazon IoT Device SDK必须使用的最低版本。
SDK | 最低版本 |
---|---|
v1.4.3 |
|
v1.6.2 |
|
v1.13.1 |
|
v1.12.0 |
请求
此操作的请求具有以下参数:
componentName
(Python:component_name
)-
要恢复的组件的名称。
响应
此操作在其响应中未提供任何信息。