检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
认证前准备 APP认证方式调用API,需要提前获取如下信息: 访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。
本章节以IntelliJ IDEA 2018.3.5版本为例介绍。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Go安装包,如果未安装,请至Go官方下载页面下载。 获取并安装IntelliJ IDEA,如果未安装,请至IntelliJ
然后新建工程,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Android Studio,如果未安装,请至Android Studio官方网站下载。 获取SDK 下
包中的工程文件,最后参考API调用示例调用API。 准备环境 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 获取并安装Visual Studio,如果未安装,请至Visual Studio官方网站下载。 获取SDK 下载S
”。 图1 单击签名密钥 配置签名密钥。 选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。 表1 密钥信息 信息项 描述 密钥名称 自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“APP认证”、“Basic Auth”或“Public
SDK生成curl命令,然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息,具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 下载JavaScript SDK的最新版本,并解压。在浏览器中打开demo
图1 单击访问控制 配置访问控制。 选择已有策略:单击“选择已有策略”后,选择策略名称。 创建新策略:请参考表1所示输入信息。 表1 访问控制策略信息 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。
导入的YAML或JSON格式文件内容应满足Swagger 2.0规范定义。 导入的zip压缩包大小不能超过1MB,单个YAML或JSON格式文件中内容不能超过1024000个字符(包括空格),否则将无法导入设计文件。 页面自动跳转到设计文件列表页面,如需编辑导入后的设计文件,请参考6~12。
制”。 图1 单击流量控制 配置流量控制。 选择已有策略:单击“选择已有策略”后,选择策略。 创建新策略:请参考表1所示输入信息。 表1 流控策略信息 信息项 描述 策略名称 API流控策略名称。 类型 分“基础流控”和“共享流控”两类。 基础流控:针对单个API进行流量统计和控制。
支持选择扩展字段在设计文件“表单”中显示的区域。 API基本信息 请求参数 数据模型基本信息 数据模型属性 将鼠标移至“显示区域”右侧的问号,单击“了解扩展字段显示区域”查看扩展字段对应区域显示详情。 描述 填写扩展字段的描述信息。 配置扩展字段。 进入API设计文件详情,在“表单”中
策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。 如果策略与API有绑定关系,则策略无法执行删除操作。 创建策略 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API管理
配置参数 实例创建完成后,可在控制台编辑实例的配置信息。 前提条件 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。
置的响应头。 使用限制 无法修改ROMA API增加的系统响应头(x-apig-*,x-request-id等),包括ROMA API提供的CORS功能增加的响应头。 配置参数说明 表1 配置参数说明 参数 配置说明 Name 响应头名称。每个策略中不能添加重复名称的响应头(不区分大小写),且最多添加10条响应头。
权限管理 ROMA API中管理员以及IAM用户创建的应用是隔离的,无法互相访问。如果用户想分配权限给不同的IAM用户,需要手动在应用管理内的权限管理进行分配,或在IAM中给用户添加Tenant Administrator权限。 除应用外,IAM用户也需拥有应用关联资源的权限才可进行对应操作,具体可参考:
选择步骤十一中已创建凭证,查看“凭证信息”的“Key”和“Secret”。 使用接口测试工具配置调用信息。 配置获取的API请求信息。 添加Header参数“X-HW-ID”,参数值为“凭证信息”的“Key”。 添加Header参数“X-HW-AppKey”,参数值为“凭证信息”的“Secret”。
API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA
B部门在“目录列表”中订阅API产品。 单击“订阅”,填写订阅申请信息。 图4 订阅申请 在“审核管理”页面,选择“我提交的申请”页签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批订阅信息。 仅支持拥有租户管理员权限者审批。 图5 审批申请 订阅成功后,B部门可以调用A部门的API。
根据下表相关任务,了解如何管理策略。 表1 管理策略 相关任务 使用场景 操作步骤 编辑策略 修改策略信息。 选择需要编辑的策略,或单击策略名称,进入策略详情。 单击“编辑”,修改策略信息,具体操作请参考创建API策略。 删除策略 删除不再使用的策略。 单击策略名称,进入策略详情。 未绑定API的策略,单击右上角“删除”。
通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”,可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史 单击对应API设计文件所在行的“变更历史”,即可查看相关操作记录。 单击对应操作所在行的“查看对比”,查看变更前和变更后的对比信息。 (可选)差异对比,可任
在当前应用关联的实例中,根据实际业务选择实例。 单击“自定义认证”页签。 在自定义认证页面,单击“创建自定义认证”。 在创建自定义认证弹框中,根据下表填写参数信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。