查询流程状态

最近更新时间:2018-11-15 19:05:50

1. 接口描述

接口请求域名: sqlserver.tencentcloudapi.com 。

本接口(DescribeFlowStatus)用于查询流程状态。

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:sqlserver.ap-shanghai-fsi.tencentcloudapi.com 。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeFlowStatus
Version String 公共参数,本接口取值:2018-03-28
Region String 公共参数,详见产品支持的地域列表
FlowId Integer 流程ID

3. 输出参数

参数名称 类型 描述
Status Integer 流程状态,0:成功,1:失败,2:运行中
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询流程状态

输入示例

https://sqlserver.tencentcloudapi.com/?Action=DescribeFlowStatus
&FlowId=30403
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "4be5990d-a4b5-49dc-b2b4-e713b6aa7ba3",
    "Status": 0
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
InternalError 内部错误。
InternalError.DBError 数据库错误。
InternalError.SystemError 系统错误。
InternalError.UnknownError 未知错误。
InvalidParameter 参数错误。
InvalidParameter.ParamsAssertFailed 参数断言转换错误。