获取任务列表

文档信息

字段	内容
关联产品	[[DTS]]
服务名称	`Microservice-DigitalTwin-Center`
接口类型	`对外开放接口`
协议类型	`HTTP`
当前版本	`v1.0.0`
维护人	`产品组`
适用对象	`后端开发 / 第三方集成商`

服务接口简介

分页获取任务列表

接口信息

项	内容
方法	`POST`
路径	`/bv-microservice-digitaltwin-center/sceneLinkage/rulePage`
协议	`HTTP`
是否鉴权	`是`
幂等性	`否`
超时时间建议	`5s`

请求参数

请求体：

字段	类型	是否必填	说明	示例
`dto`	`true`	否	dto	-
`currentPage`	`false`	否	当前页码（默认第一页）	`0`
`pageSize`	`false`	否	每页条数（默认10条）	`0`
`ruleName`	`false`	否	规则名称	-
`sortColumn`	`true`	否	排序字段 0 场景名称 1 创建时间 2 最近执行时间	`0`
`sortOrder`	`true`	否	排序顺序 0 升序 1 降序	`0`

请求体示例：

{
  "currentPage": 0,
  "pageSize": 0,
  "ruleName": "",
  "sortColumn": 0,
  "sortOrder": 0
}

响应参数

字段	类型	说明	示例
`code`	`integer(int32)`	-	`0`
`info`	`PageVO«SceneLinkageRuleVO»`	-	{"currentPage": 0, "list": [{"addTime": "", "latestExecutionStatus": 0, "latestExecutionTime": "", "operatingStatus": 0, "ruleDescription": "", "ruleId": "", "ruleName": ""}], "pageSize": 0, "totalPage": 0, "totalRow": 0}
`currentPage`	`integer(int64)`	当前页码	`0`
`list`	`array`	分页数据列表	[{"addTime": "", "latestExecutionStatus": 0, "latestExecutionTime": "", "operatingStatus": 0, "ruleDescription": "", "ruleId": "", "ruleName": ""}]
`addTime`	`string`	创建时间	-
`latestExecutionStatus`	`integer`	最近执行状态 0 全部失败 1 全部成功 2 部分成功	-
`latestExecutionTime`	`string`	最近执行时间	-
`operatingStatus`	`integer`	运行状态 0 未启动 1 启动	-
`ruleDescription`	`string`	规则描述	-
`ruleId`	`string`	规则id	-
`ruleName`	`string`	规则名称	-
`pageSize`	`integer(int64)`	每页条数	`0`
`totalPage`	`integer(int64)`	总页数	`0`
`totalRow`	`integer(int64)`	总记录数	`0`
`message`	`string`	-	-

响应示例：

{
    "code": 0,
    "info": {
        "currentPage": 0,
        "list": [
            {
                "addTime": "",
                "latestExecutionStatus": 0,
                "latestExecutionTime": "",
                "operatingStatus": 0,
                "ruleDescription": "",
                "ruleId": "",
                "ruleName": ""
            }
        ],
        "pageSize": 0,
        "totalPage": 0,
        "totalRow": 0
    },
    "message": ""
}

调用示例

curl 示例：

curl -X POST "http://<Host>/bv-microservice-digitaltwin-center/sceneLinkage/rulePage" \
  -H "bv-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"currentPage": 0, "pageSize": 0, "ruleName": "", "sortColumn": 0, "sortOrder": 0}'

接口错误码

错误码	HTTP 状态	场景	处理建议
`200`	`200`	OK (ResponseDataT«PageVO«SceneLinkageRuleVO»»)	成功
`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:12
最后编辑：北京-产品-yantings 更新时间：2026-07-07 18:14