更新时间：2025-10-11 GMT+08:00
查询工作流实例 - QueryBPMInstance
功能介绍
获取当前账号下工作流实例信息。
URI
GET 华为云Astro轻应用域名/u-route/baas/bp/v2.0/runtime/instances?states={X}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
states |
是 |
String |
参数解释： 工作流实例状态。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
fields |
否 |
String |
参数解释： 指明要查询的工作流实例信息的字段，多个字段名之间以英文逗号分隔。如果不指明字段，则返回缺省的字段。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
orderField |
否 |
String |
参数解释： 用于排序的字段名。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
orderType |
否 |
String |
参数解释： 排序类型。 约束限制： 不涉及。 取值范围：
默认取值： 不涉及。 |
响应参数
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
resCode |
String |
参数解释： 返回码。 取值范围： 如果返回“0”代表请求成功，其他错误码说明请参考错误码（数据面）。 |
|
resMsg |
String |
参数解释： 返回消息。 取值范围： 成功返回“Success”，其他情况会返回具体的错误信息。 |
|
result |
Object |
参数解释： 在成功请求时会有内容，返回查询到的工作流实例信息列表。 |
请求示例
查询当前工作流实例列表，例如示例中查询到了一个匹配的记录项。
GET https://华为云Astro轻应用域名/u-route/baas/bp/v2.0/runtime/instances?states=Completed OK&orderField=title&orderType=asc
响应示例
{
"resCode":"0",
"resMsg":"Success",
"result":[
{
"bpStage":"Stage 1",
"bpStatus":"begin",
"bpStep":"Transfer 1",
"businessKey":"BK001",
"createdBy":"10gd0000003T2E10UTfk",
"createdBy.__objectType":"User",
"createdBy.name":"ecommerce",
"createdDate":"2018-08-13 16:21:17",
"curElement":"",
"description":"Transfer 1",
"endTime":"2018-08-17 14:40:09",
"id":"002N000000IpNGFfNvm4",
"label":"TestFSM2 2018-08-13 16:21:17",
"lastHandler":null,
"lastModifiedBy":"10gd0000003T2E10UTfk",
"lastModifiedBy.__objectType":"User",
"lastModifiedBy.name":"ecommerce",
"lastModifiedDate":"2018-08-17 14:40:09",
"name":"TestFSM2",
"owner":"10gd0000003T2E10UTfk",
"owner.__objectType":"User",
"owner.name":"ecommerce",
"startTime":"2018-08-13 16:21:17",
"state":"Completed OK",
"suspended":false,
"title":"Hello, this is a title",
"type":"BP",
"urgency":0,
"version":"0.0.1"
}
]
}
状态码
状态码请参见状态码。
错误码
错误码请参见错误码（数据面）。
父主题： 工作流
