停止任务
文档信息
| 字段 | 内容 |
|---|---|
| 关联产品 | [[DTS]] |
| 服务名称 | Microservice-DigitalTwin-Center |
| 接口类型 | 对外开放接口 |
| 协议类型 | HTTP |
| 当前版本 | v1.0.0 |
| 维护人 | 产品组 |
| 适用对象 | 后端开发 / 第三方集成商 |
服务接口简介
设置任务为停止
接口信息
| 项 | 内容 |
|---|---|
| 方法 | POST |
| 路径 | /bv-microservice-digitaltwin-center/sceneLinkage/stop |
| 协议 | HTTP |
| 是否鉴权 | 是 |
| 幂等性 | 否 |
| 超时时间建议 | 5s |
请求参数
请求体：
| 字段 | 类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
ruleId |
true |
否 | 规则id | - |
响应参数
| 字段 | 类型 | 说明 | 示例 |
|---|---|---|---|
code |
integer(int32) |
- | 0 |
info |
object |
- | {} |
message |
string |
- | - |
响应示例：
{
"code": 0,
"info": {},
"message": ""
}
调用示例
curl 示例：
curl -X POST "http://<Host>/bv-microservice-digitaltwin-center/sceneLinkage/stop" \
-H "bv-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json"
接口错误码
| 错误码 | HTTP 状态 | 场景 | 处理建议 |
|---|---|---|---|
200 |
200 |
OK (ResponseData) | 成功 |
201 |
201 |
Created | 创建成功 |
401 |
401 |
Unauthorized | 请登录通用用户系统获取 API Key，并在 Header 中携带 bv-api-key |
403 |
403 |
Forbidden | 请检查该 API Key 是否被授权访问该接口 |
404 |
404 |
Not Found | 检查接口 URL 是否正确 |
备注
- 前置条件：API Key 已在“通用用户系统”中创建并关联了相应的 DTS 权限。
- 副作用：无。
作者：北京-产品-yantings 创建时间：2025-11-26 18:17
最后编辑：北京-产品-yantings 更新时间：2026-07-07 18:14
最后编辑：北京-产品-yantings 更新时间：2026-07-07 18:14
