检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com
返回结果 请求发送以后,会收到响应,包含:状态码、响应消息头和响应消息体。 状态码 状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头
添加实体 功能介绍 添加实体。 URI POST /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方法请参考获取项目
获取流运行详细信息 当前页面API为历史版本API,未来可能停止维护。请使用获取流运行详细信息。 功能介绍 根据流ID和流运行记录ID查询流运行详细信息,包括每一步的输入、输出、结果、执行时间。 URI GET /v1/{project_id}/flows/{flow_id}/running-history
批量删除实体 功能介绍 批量删除实体。 URI POST /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/delete 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
删除实体 功能介绍 删除实体。 URI DELETE /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} 表1 路径参数 参数 是否必选 参数类型 描述 entity_urn 是
APIG的App认证则需提供AppKey以及AppSecret。 自定义:自定义用户在创建连接时的身份验证方式。 说明: 使用自定义认证时,如果选择使用函数,函数支持缓存时间,在这个缓存时间内,不再调用这个函数,直接使用这个缓存的调用结果。
提交运行流 功能介绍 根据流id提交流到后台运行。 接口约束 无 URI POST /v1/{project_id}/flows/{flow_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,用于资源隔离。获取方法请参考获取项目
关系操作接口 功能介绍 关系操作接口。 URI POST /v3/{project_id}/abm/instances/{instance_id}/metadata3/relationships 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
更新实体 功能介绍 更新实体。 URI PUT /v3/{project_id}/abm/instances/{instance_id}/metadata3/entities/{entity_urn} 表1 路径参数 参数 是否必选 参数类型 描述 entity_urn 是 String
查询单个流历史活动记录 当前页面API为历史版本API,未来可能停止维护。请使用查询单个流运行历史记录。 功能介绍 根据单个流ID查询运行记录。 URI GET /v1/{project_id}/flows/{flow_id}/running-history 表1 路径参数 参数
webhook触发流调用(废弃) 功能介绍 webhook触发流调用,该接口在集成工作台新版本中已经废弃。 接口约束 无 URI POST /v1/{project_id}/flows/webhook/trigger/{id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id
特征操作接口 功能介绍 特征操作接口。 URI POST /v3/{project_id}/abm/instances/{instance_id}/metadata3/signatures 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目
查询单个流运行历史记录 功能介绍 根据单个流id查询该流的所有运行历史记录。 接口约束 无 URI GET /v2/{project_id}/flows/{flow_id}/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String
查询流运行历史记录 功能介绍 查询租户下的所有流运行的历史记录。 接口约束 无 URI GET /v2/{project_id}/flows/running-history 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目id,用于资源隔离
获取流运行详细信息 功能介绍 根据流id和运行记录id查询流运行详细信息,包括流的Id、名称、图标、开始时间、结束时间、最后一步运行状态以及流步骤元数据。 接口约束 无 URI GET /v2/{project_id}/flows/{flow_id}/running-history
附录 状态码 错误码 获取项目ID 获取账号ID
状态码 状态码如表1所示。 表1 状态码 状态码 编码 说明 100 Continue 继续请求。 这个临时响应用来通知客户端,它的部分请求已经被服务器接收,且仍未被拒绝。 200 OK 接口调用成功。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求
应用示例 运行流并查看运行记录
使用前必读 概述 调用说明 终端节点 约束与限制 基本概念