文档首页/ Astro轻应用 AstroZero/ API参考/ API/ 服务编排/ 查看服务编排运行实例
更新时间：2024-06-28 GMT+08:00
查看PDF
分享

查看服务编排运行实例

功能介绍

查询服务编排运行实例的信息，即根据输入的参数筛选出符合条件的服务编排实例的具体信息并返回。

URI

GET AstroZero域名/u-route/baas/v1.0/flow/{action}

表1 参数说明

参数

是否必选

参数类型

描述

action

是

String

参数解释：

需要查询的服务编排状态或者根据id查询服务编排信息。

约束限制：

不涉及。

取值范围：

各个状态取值及其含义如下：

  • activeFlow：正在执行的服务编排。
  • suspendedFlow：延时的服务编排。
  • terminatedFlow：被终止的服务编排。
  • completedFlow：正常完成的服务编排。
  • instanceId：根据id查询服务编排信息，请求时该参数需替换为具体的服务编排运行实例ID。

默认取值：

不涉及

owner

否

String

参数解释：

所属账号ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

creater

否

String

参数解释：

创建者ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

fields

否

Array

参数解释：

字符串数组，为需要查询的字段，不传则默认。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

orderField

否

String

参数解释：

用于排序的字段，需要在fields中。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

orderType

否

String

参数解释：

排序方式。

约束限制：

不涉及。

取值范围：

  • 0：代表Asc升序。
  • 1：代表Desc降序。

默认取值：

不涉及。

limit

否

Integer

参数解释：

数据条数限制。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

offset

否

Integer

参数解释：

数据起始位置。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

表2 响应参数

参数

参数类型

描述

resCode

String

参数解释：

返回码。

取值范围：

如果返回“0”代表请求成功，其他错误码说明请参考错误码。

resMsg

String

参数解释：

返回消息。

取值范围：

如果成功状态，通常会返回“Success”，其他情况会返回具体的错误信息。

result

Object

参数解释：

在成功请求时会有内容返回。内部包含请求中传入的fields中的字段或默认字段。

请求示例

查询实例ID为“002N000000jrOCerKZBQ”的服务编排实例。 
GET https://AstroZero域名/u-route/baas/v1.0/flow/002N000000jrOCerKZBQ

响应示例

{
    "resCode": "0",
    "resMsg": "成功",
    "result": {
        "createdBy": "10gd000000QwWjXspAOW",
        "createdBy.__objectType": "User",
        "createdBy.name": "bingo",
        "createdDate": "2021-05-19 11:41:30",
        "curElement": "isMasterAccountByIdentityId",
        "description": "",
        "endTime": "",
        "id": "002N000000jrOCerKZBQ",
        "label": "isMasterAccount 2021-05-19 11:41:30",
        "lastHandler": null,
        "lastModifiedBy": "10gd000000QwWjXspAOW",
        "lastModifiedBy.__objectType": "User",
        "lastModifiedBy.name": "bingo",
        "lastModifiedDate": "2021-05-19 11:41:30",
        "name": "CP_DS__isMasterAccountForOperator",
        "owner": "10gd000000QwWjXspAOW",
        "owner.__objectType": "User",
        "owner.name": "bingo",
        "rootID": "",
        "runMode": 2,
        "startTime": "2021-05-19 11:41:30",
        "state": "Broken",
        "suspended": false,
        "type": "Flow",
        "type.name": "Flow",
        "version": "1.0.1"
    }
}

状态码

状态码请参见状态码。

错误码

错误码请参见错误码。

父主题： 服务编排

相关文档