检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对外开放的请求URL,保存后生成URL。 API请求方式 是 指定该URL接口以何种方式调用触发。 API认证方式 否 APIG注册接口的认证方式。 IAM认证 APP认证 无认证 API请求体架构 是 定义该URL接口传入的参数,参数格式以JsonSchema为准,当前支持参数位置位于quer
API概览 开天集成工作台接口的分类与说明如表1所示。 表1 API概览 类型 子类型 说明 流管理 流管理 包含查询流活动记录、查询流运行信息、运行流、禁用流等。 应用模型 实体管理 包含添加实体、更新实体、删除实体等接口。 关系管理 包含关系操作接口。 特征管理 包含特征操作接口。
API生命周期 关于API生命周期的常见问题,请参见《API网关 APIG》的“常见问题”章节。
API 流管理 应用模型
历史API 查询流历史活动记录 查询单个流历史活动记录 获取流运行详细信息
获取API接口 操作步骤 进入华为云商店,在搜索框搜索“全球IP归属地查询-IP地址查询”,选择如图1所示接口。 图1 球IP归属地查询-IP地址查询 选择规格和套餐包,如图1所示。 单击“立即购买”。 按照提示完成API接口的订阅。创建连接器时需要用到的信息如图2、图3所示。 图2
如何调用API 构造请求 认证鉴权 返回结果
华为短信(体验) 华为云消息短信服务,将相关信息发送到指定号码中。包含“发送短信”一个执行动作。如果短信内容中含有敏感信息,则短信发送失败。 约束与限制 体验次数,每天5次。 连接参数 华为短信(体验)连接器无需认证,无连接参数。 发送短信 将文本文档发送到指定手机号码中。 输入参数
录音文件识别接口,用于识别长录音文件,录音文件放在华为云OBS(对象存储服务)上,由于录音文件识别通常会需要较长的时间,因此识别是异步的,也即接口分为创建识别任务和查询任务状态两个接口,创建识别任务接口创建任务完成后返回,然后用户通过调用查询任务状态接口来获得转写状态和结果。 该接口用于提交录音文件识别任务
华为类 华为图像识别 华为图像识别(体验) 华为图像搜索 华为文字识别 华为文字识别(体验) 华为人脸识别 华为语音识别 华为语言生成 华为语言理解 华为机器翻译 华为机器翻译(体验) 华为天气服务 华为天气(体验) 华为会议(体验) 华为云OBS 华为短信 华为短信(体验) 华为空气质量(体验)
华为云OBS 对象存储服务(Object Storage Service,OBS)提供海量、安全、高可靠、低成本的数据存储能力,可供用户存储任意类型和大小。包含“读取文件”和“上传文件”两个执行动作,“当有新文件上传”一个触发事件。 连接参数 华为云OBS连接器使用自定义认证,连接参数说明如表1所示。
华为天气服务 华为天气服务,可以根据用户输入的城市名称,查询当前或未来的天气情况。包含“查询实时天气”和“三天天气逐日预报”两个执行动作。 连接参数 华为天气服务连接器使用OAuth2.0认证,连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称
使用API接口创建流 前提条件 获取API接口 创建连接器 创建流 运行流 父主题: 进阶能力
华为语言生成 华为语言生成连接器基于华为云自然语言处理 NLP进行集成开发,包含“文本摘要(基础版)”、“文本摘要(领域版)”、“诗歌生成”三个执行动作。 连接参数 华为语言生成连接器使用IAM认证,连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称
华为短信 华为云消息短信服务,将相关信息发送到指定号码中。包含“发送短信”一个执行动作。 连接参数 华为短信连接器使用IAM认证,连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称 是 设置连接名称。 华为短信的连接 描述 否 对于连接的信息描述说明。
API生命周期 API生命周期包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API,并上架API市场进行售卖。借助API网关,可以简单、快速
华为内容审核(体验) 内容审核(Content Moderation),是基于图像、文本、音视频的检测技术,可自动检测涉黄、涉政涉暴、涉政敏感人物、图文违规等内容,对用户上传的图片、文字、音视频进行内容审核,以满足上传要求,帮助客户降低业务违规风险。包含“图像内容审核”和“文本内容审核”执行动作。
华为语言理解 华为语言理解连接器基于华为云自然语言处理 NLP进行集成开发,包含“情感分析”、“文本分类”、“文档分类”、“意图理解”等执行动作。 连接参数 华为语言理解连接器使用IAM认证,连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称
目标语种 翻译的目标语种。 文档翻译(创建翻译任务) 由于文档翻译会需要较长的时间,因此翻译是异步的,也即接口分为创建翻译任务和查询任务状态两个接口。 输入参数 用户配置文档翻译执行动作,相关参数说明如表4所示。 表4 文档翻译输入参数说明 参数 必填 说明 文档文件存放路径 是 存放在OBS的文档文件路径。
WeatherAPI 提供天气、大气相关的信息查询服务,包含“Forecast weather”,“Astronomy Info”,“City Location Info”和“Air Quality”执行动作。 连接参数 WeatherAPI连接器使用APIkey认证,创建Wea