向指定作业的Pod发送信号并获取信号ID。
接口说明
请求说明
该 API 用于向指定作业的一个或多个 Pod 发送特定信号。
发送信号后,API 立即返回一个
SignalId,实际的信号投递由后台 worker 处理。信号的状态可以通过
GetSignal或ListSignals接口查询。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST /api/v1/jobs/{JobId}/signals HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| JobId |
string |
否 |
任务 ID。 |
dlc******** |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 Body 参数。 |
|
| Signal |
string |
否 |
信号码。 |
SIGUSR1 |
| Target | SignalTarget |
否 |
信号发送范围。 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回数据 |
||
| JobId |
string |
任务 ID。 |
dlc******** |
| SignalId |
string |
信号 ID。 |
oper************ |
| Signal |
string |
信号码。 |
SIGUSR1 |
| Status |
string |
信号状态。 |
Succeeded |
| RequestId |
string |
请求 ID。 |
019F6385-7481-57A7-BEC9-*********** |
示例
正常返回示例
JSON格式
{
"JobId": "dlc********",
"SignalId": "oper************",
"Signal": "SIGUSR1",
"Status": "Succeeded",
"RequestId": "019F6385-7481-57A7-BEC9-***********"
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。