检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
对外开放的请求URL,保存后生成URL。 API请求方式 是 指定该URL接口以何种方式调用触发。 API认证方式 否 APIG注册接口的认证方式。 IAM认证 APP认证 无认证 API请求体架构 是 定义该URL接口传入的参数,参数格式以JsonSchema为准,当前支持参数位置位于query参数与Body参
API概览 开天集成工作台接口的分类与说明如表1所示。 表1 API概览 类型 子类型 说明 流管理 流管理 包含查询流活动记录、查询流运行信息、运行流、禁用流等。 应用模型 实体管理 包含添加实体、更新实体、删除实体等接口。 关系管理 包含关系操作接口。 特征管理 包含特征操作接口。
API 流管理 应用模型
API生命周期 关于API生命周期的常见问题,请参见《API网关 APIG》的“常见问题”章节。
历史API 查询流历史活动记录 查询单个流历史活动记录 获取流运行详细信息
获取API接口 操作步骤 进入华为云商店,在搜索框搜索“全球IP归属地查询-IP地址查询”,选择如图1所示接口。 图1 球IP归属地查询-IP地址查询 选择规格和套餐包,如图1所示。 单击“立即购买”。 按照提示完成API接口的订阅。创建连接器时需要用到的信息如图2、图3所示。 图2
therAPI连接时连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称 是 设置连接名称。 WeatherAPI的连接。 描述 否 对于连接的信息描述说明。 description key 是 API密钥。 登录https://www.weatherapi
如何调用API 构造请求 认证鉴权 返回结果
API生命周期 API生命周期包括API的创建、发布、下线和删除所经历的完整生命周期过程,为您提供高性能、高可用、高安全的API托管服务,能快速将企业服务能力包装成标准API服务,帮助您轻松构建、管理和部署任意规模的API,并上架API市场进行售卖。借助API网关,可以简单、快速
HTTP(apiKey认证) HTTP(apiKey认证)连接器包含“创建http请求”一个执行动作。 连接参数 创建http请求连接时连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 连接名称 是 设置连接名称。 描述 否 对于连接的信息描述说明。 X-API-Key
例。 查看证书 当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的“操作”列下,单击“查看证书”,可以查看证书详细信息。 编辑SSL证书 当API分组中的API支持HTTS请求协议时,才有此操作。 在独立域名列表中,在对应的SSL证书列下,单击,可以修改证书名称、证书内容及密码。
面。接着选择“APIC”类型的数据源,单击“下一步”。 在页面中配置数据源的连接信息,如下表所示。 表1 数据源连接信息 参数 配置说明 数据源名称 填写数据源的名称,根据规划自定义。建议您按照一定的命名规则填写数据源名称,方便您快速识别和查找。 描述 填写数据源的描述信息。 数据湖分层
使用API接口创建流 前提条件 获取API接口 创建连接器 创建流 运行流 父主题: 进阶能力
账号具备所有接口的调用权限,如果使用账号下的IAM用户发起API请求时,该IAM用户必须具备调用该接口所需的权限,否则,API请求将调用失败。每个接口所需要的权限,与各个接口所对应的授权项相对应,只有发起请求的用户被授予授权项所对应的策略,该用户才能成功调用该接口。例如,用户要
约束与限制 无。 父主题: 使用前必读
状态码是一组从1xx到5xx的数字代码,状态码表示了请求响应的状态,完整的状态码列表请参见状态码。 对于获取用户Token接口,如果调用后返回状态码为“201”,则表示请求成功。 响应消息头 对应请求消息头,响应同样也有消息头,如“Content-type”。 对于获取用户Token接口,返回如图
构造请求 本节介绍REST API请求的组成,并以调用IAM服务的获取用户Token接口说明如何调用API,该API获取用户的Token,Token可以用于调用其他API时鉴权。 您还可以通过这个视频教程了解如何构造请求调用API:https://bbs.huaweicloud.com/videos/102987
Access Key):与访问密钥ID结合使用的密钥,对请求进行加密签名,可标识发送方,并防止请求被修改。 使用AK/SK认证时,可以基于签名算法使用AK/SK对请求进行签名,也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 父主题: 如何调用API
自动:会按照触发器的类型自动运行流。 测试:用户在创建流的时候可以测试流的功能。 status String 最后一次运行,流运行状态。 success:流运行成功 fail:流运行失败 icon String 流图标。 start_time String 流运行的开始时间。 end_time
run_model String 流运行模式,通常有手动、自动、测试三种。 手动:需要用户在页面单击运行流。 自动:会按照触发器的类型自动运行流。 测试:用户在创建流的时候可以测试流的功能。 status String 最后一次运行,流程运行状态。 success:流运行成功 fail:流运行失败