GetFlow - 获取Flow详细信息_Chat App 消息服务(Chat App)-阿里云帮助中心

获取Flow详细信息。

接口说明

本接口的单用户 QPS 限制为 5 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cams:GetFlow

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
FlowId	string	是	工作流 ID	123234444
CustSpaceId	string	否	ISV 子客户的 SpaceId。	cams-sdlk12j3njdn

返回参数

名称	类型	描述	示例值
	object	Schema of Response。
AccessDeniedDetail	string	访问被拒绝详细信息。	无
RequestId	string	请求 ID。	90E63D28-E31D-1EB2-8939-A9486641****
Message	string	错误描述信息。	无
Data	object	返回数据。
Status	string	Flow 的状态。	DRAFT
FlowId	string	Flow ID。	92675332812643****
PreviewUrl	string	临时预览链接。	https://pre-url
JSONVersion	string	JSON 版本信息。	2.1
Categories	array	目录。
	string	目录。	SIGN_UP
FlowName	string	Flow 名称。	flow_001
DataApiVersion	string	API 版本信息。	3.0
PreviewUrlExpires	integer	预览 URL 的过期时间。	1700617436633
Code	string	结果返回 OK 为正常。	OK

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "无",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Message": "无",
  "Data": {
    "Status": "DRAFT",
    "FlowId": "92675332812643****",
    "PreviewUrl": "https://pre-url",
    "JSONVersion": "2.1",
    "Categories": [
      "SIGN_UP"
    ],
    "FlowName": "flow_001",
    "DataApiVersion": "3.0",
    "PreviewUrlExpires": 1700617436633
  },
  "Code": "OK"
}

错误码

HTTP status code	错误码	错误信息	描述
400	Product.Unsubscript	You have not subscribed to the specified product.	您尚未订阅指定的产品。
400	Ram.PermissionDeny	You are not authorized to perform the operation.	您无权执行该操作。
400	System.LimitControl	The system is under flow control.	系统处于流控制之下。
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	资源不属于当前用户。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。