跳转到主内容

界面：HealthConfig

定义于: packages/extension-api/src/extension-api.d.ts:3088

用于定义容器运行状况检查的配置选项。要获取运行状况检查结果，您可以使用 containerEngine.inspectContainer，在获取的 ContainerInspectInfo 中，您可以访问 Status.Health 属性，其中包含 HealthCheckResults。

属性​

Interval?​

可选 Interval: number

定义于: packages/extension-api/src/extension-api.d.ts:3117

检查之间的等待时间（纳秒）。应为 0 或至少 1000000（1 毫秒）。0 表示继承。

示例​

// Set interval to 1 second
Interval?: 1000000000;

Retries?​

可选 Retries: number

定义于: packages/extension-api/src/extension-api.d.ts:3145

将容器视为不健康的连续失败次数。0 表示继承。

示例​

// Set retries to 3
Retries?: 3;

StartPeriod?​

可选 StartPeriod: number

定义于: packages/extension-api/src/extension-api.d.ts:3136

容器初始化前的启动周期，在开始健康重试倒计时之前（纳秒）。应为 0 或至少 1000000（1 毫秒）。0 表示继承。

示例​

// Set start period to 2 seconds
StartPeriod?: 2000000000;

Test?​

可选 Test: string[]

定义于: packages/extension-api/src/extension-api.d.ts:3108

要执行的测试。

示例​

// Inherit healthcheck from image
Test?: [];
// Disable healthcheck
Test?: ["NONE"];
// Execute command in host system
Test?: ["CMD", "curl", "https://"];
// Podman will execute the command inside the target container and wait for either a "0" or "failure  exit" code.
Test?: ["CMD-SHELL", "curl https:// || exit 1"];

Timeout?​

可选 Timeout: number

定义于: packages/extension-api/src/extension-api.d.ts:3126

在认为检查已挂起之前等待的时间（纳秒）。应为 0 或至少 1000000（1 毫秒）。0 表示继承。

示例​

// Set timeout to 5 seconds
Timeout?: 5000000000;