API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(appflow/2023-09-04)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

API目录

API

标题

API概述

GenerateUserSessionToken 生成登录会话Token 生成登录会话Token。
CreateFlow 创建连接流 创建连接流
CreateUserAuthConfig 创建用户凭据 创建用户鉴权凭证
DeleteFlow 删除连接流 删除连接流
DeleteUserAuthConfig 删除用户凭据 删除用户鉴权凭证
DisableFlow 禁用连接流 禁用连接流
EnableFlow 启用流 启用连接流
GetFlow 获取连接流详情 获取连接流详情
GetUserAuthConfig 获取用户凭据详情 获取用户鉴权凭证详情
InvokeAction 运行执行动作 运行连接器的执行动作
LaunchFlow 发布连接流 发布连接流
UpdateFlow 更新连接流 更新连接流
UpdateUserAuthConfig 更新用户凭据 编辑用户鉴权凭证
WithdrawFlow 下线连接流 下线连接流