暂停实例

仅在 offering.lifecycle.suspension.supported 为 true 时调用。操作完成后轮询实例到 SUSPENDED。

Authentication

XAPI-Keystring

在 xAPI Console 创建的 API Key。只会发送给 *.xapi.to。

Path parameters

idstringRequiredformat: "uuid"

xAPI Sandbox 实例 UUID。

Request

This endpoint expects an object.
idempotencyKeystringOptional<=160 characters

当前状态操作的幂等键;同一动作在响应不确定时复用原值,新动作使用新值。

Response

暂停操作

idstringOptionalformat: "uuid"

操作记录 UUID,用于日志关联,不是实例 ID。

idempotencyKeystringOptional

此操作的幂等键;重复请求是否属于同一操作由实例 ID 和该值共同确定。

typeenumOptional

操作类型。生命周期操作改变状态;EXEC/FILE/PORT/EXTENSION 是实例内的数据面调用。

statusenumOptional

操作执行状态;HTTP 已接受不代表这里已经 SUCCEEDED。

expectedStateenum or nullOptional

生命周期操作期望实例最终达到的状态;数据面操作通常为 null。

errorstring or nullOptional

操作失败、超时或取消时的诊断信息;成功时为 null。

inputmap from strings to anyOptional

已脱敏/裁剪的操作输入摘要;文件写入只记录路径、编码和大小,不保存文件内容。

requestedAtdatetimeOptional

Gateway 接受操作请求的时间。

startedAtdatetime or nullOptional

适配器实际开始处理的时间;尚未开始时为 null。

completedAtdatetime or nullOptional

操作进入终态的时间;仍在执行时为 null。

durationMsintegerOptional

操作实际执行耗时,单位毫秒;并非实例总运行时长。

exitCodeintegerOptional

EXEC 操作的远端进程退出码;0 通常表示成功,非零表示命令失败但 HTTP 请求可能仍成功。

stdoutPreviewstringOptional

为审计保存的标准输出前缀,不保证是完整 stdout。

stderrPreviewstringOptional

为审计保存的标准错误前缀,不保证是完整 stderr。

outputTruncatedbooleanOptional

stdoutPreview 或 stderrPreview 是否因日志大小限制被截断。

Errors

409
Conflict Error