GetChatFlowMetric - 获取ChatFlow运行数据_Chat App 消息服务(Chat App)-阿里云帮助中心

接口说明

在调用此接口前，请确保您创建的流程已上线且已触发流程。
若您的流程未上线，可在流程编辑器界面单击流程名称进入画布编排界面手动上线流程或通过 OnlineFlowVersion 接口上线流程。
触发器类型为手动的流程需要通过 TriggerChatFlow 接口触发流程或在营销活动管理界面通过关联营销活动触发流程。
触发器类型为非手动的流程则无需手动触发流程，在对应绑定的商家账号给商家发送消息以后就会触发流程。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

cams:GetChatFlowMetric

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
BizCode	string	否	业务租户编码，默认：ALICOM_OPAAS。	ALICOM_OPAAS
BizExtend	object	否	业务扩展信息，默认为一个空集合。	{}
From	integer	否	开始时刻。时间戳，单位：秒。	1751299200
To	integer	否	结束时刻。时间戳，单位：秒。	1751385599
FlowCode	string	否	流程编码。在流程编辑器界面查看流程编码。	9ccc41**************************
FlowVersion	string	否	流程版本。在流程编辑器界面单击流程名称进入流程编辑器画布界面查看流程版本。	1
MetricName	string	是	监控项名称。取值： nodeUsageStatistics：节点使用统计。 nodeErrorDetails：节点错误明细。	nodeUsageStatistics
MetricParam	object	否	监控项查询的扩展参数。当 MetricName 为 nodeErrorDetails 时，需传入一段 JSON 数据。JSON 字段取值： pageNo：当前页数。 pageSize：每页显示数量。 nodeId：节点 ID，在流程编辑器界面点击流程名称进入画布编排界面复制节点 ID。	{ "pageNo": 1, "pageSize": 20, "nodeId": "SendWhatsAppMessage#H7fKq5rM" }

返回参数

名称	类型	描述	示例值
	object
AccessDeniedDetail	string	访问被拒绝详细信息。	None
Message	string	错误描述信息。	无
RequestId	string	请求唯一 ID。	90E63D28-E31D-1EB2-8939-A94866411B2O
Data	object	返回数据对象。
Code	string	错误码。更多详情请参见错误码。	OK
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true

示例

正常返回示例

JSON格式

{
  "AccessDeniedDetail": "None",
  "Message": "无",
  "RequestId": "90E63D28-E31D-1EB2-8939-A94866411B2O",
  "Data": {
    "test": "test",
    "test2": 1
  },
  "Code": "OK",
  "Success": true
}

错误码

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

变更历史

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