检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用浏览器访问API,需要创建支持OPTIONS方法的API,具体步骤请参见创建OPTIONS方式的API。且返回头中带有“Access-Control-Allow-*”相关访问控制头域,可在创建API时通过开启CORS来添加这些头域。 在html中引入signer.js及依赖。 <script src="js/hmac-sha256
API使用的认证方式,推荐使用APP认证。 APP认证:表示由ROMA API进行API请求的安全认证。 华为IAM认证:表示通过IAM服务进行安全认证。 自定义认证:表示使用自定义的后端函数API进行安全认证。 无认证:表示不需要认证。 须知: 使用IAM认证方式时,任何租户均可
新建工程php的目录结构 “signer.php”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在代码中引入sdk。 1 require 'signer.php'; 生成一个新的Signer, 填入AppKey和AppSecret。 1 2 3
Token认证 操作场景 当您使用Token认证方式调用API时,需要获取用户Token并在调用API时将Token值设置到调用请求的“X-Auth-Token”头域中。 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access
API在发布到环境后,即支持被其他用户调用。根据API所使用的安全认证方式不同,调用API的操作有所差异。 获取API的请求消息 在调用API前,您需要向API管理者获取API的请求信息,包括访问域名、请求协议、请求方法、请求路径以及请求参数。 根据API使用的安全认证方式,还要获取相关的请求认证信息: APP认证:
新建工程go的目录结构 “demo.go”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在工程中引入sdk(signer.go)。 import "apig-sdk/go/core" 生成一个新的Signer,输入AppKey和AppSecret。
sdk-request:签名算法的调用示例,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在工程中引入sdk。 1 using APIGATEWAY_SDK; 生成一个新的Signer, 填入AppKey和AppSecret。 1 2 3
新建工程python的目录结构 “main.py”为示例代码,请根据实际情况修改参数后使用。具体代码说明请参考调用API示例。 调用API示例 在工程中引入apig_sdk。 1 2 from apig_sdk import signer import requests 生成一个新的Sign
范性检查,帮助用户快速设计标准的RESTful API。在开始设计API前,您需要创建一个设计文件。 首次创建API设计支持新建和导入两种方式。 本地无API设计文件可创建API文件。 本地已存在API设计文件可单个导入Swagger文件或批量导入Swagger文件。 非首次创建API设计。
编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。 授权API 仅使用APP认证方式的API,才需要授权,发布API后,通过指定授权给某些应用,让指定应用能够调用API。 选择需要授权的API。 选择“更多 > 授权”。 在弹窗中设置授权信息。
创建API策略 支持通过策略的方式,为API提供灵活的扩展能力。 前提条件 一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。
签名密钥是由一对Key和Secret组成,当签名密钥创建后,ROMA API向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样方式进行签名,通过比对签名结果与请求的Authorization头中签名是否一致来校验API请求是否合法。 同一个环境中一个API只能添加一个
账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA Connect实例或APIG实例。 已创建项目资源。
y。 app_api_key app_api_key认证方式开关。启用后,可在API请求中添加“apikey”参数,携带的Key(或客户端的AppKey)进行API的调用认证。 app_basic app_basic认证方式开关。启用后,可在API请求中添加“Authorizat
求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。 表1 请求参数说明 认证方式 Headers Parameters Body APP认证 说明: APP认证凭证:选择已创建凭证,可选择
填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件(后缀名为“.pem”),将证书内容复制到“证书内容”中即可。 若证书为非pem编码格式,可参考转换证书为PEM格式进行证书格式转换。 密钥 填写pem编码格式的SSL证书密钥。 以文本方式打开待上传证书里的KEY格式或PEM格式的私钥文件(后缀名为“
在弹窗中配置AppCode,完成后单击“确定”。 表1 配置AppCode 参数 配置说明 生成方式 选择AppCode的生成方式。 自动生成:由系统随机生成AppCode。 手动输入:自定义AppCode。 AppCode 仅手动输入方式需要填写AppCode的值。 绑定凭据配额策略 登录ROMA API控制台。
仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 服务器在返回指定的HTTP响应码时,判定响应成功。可同时指定多个响应码。 通道内服务器配置 服务器添加方式 选择添加服务器方式,目前支持“选择云服务器”和“指定服务器地址”。 单击“完成”,创建完成。 父主题: 实例管理
认证方式为华为IAM认证时,任何ROMA API租户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 认证方式为无认证时,任何公网用户均可以访问此API,可能存在恶意刷流量,导致过量计费的风险。 认证方式为自定义认证时,需要在函数服务中写一段函数,对接用户自己的认证系
将生成的产品上架到目录中,供消费者查看和订阅。 步骤十一:订阅产品 在API目录中,订阅产品。 步骤十二:调用API 为简单起见,此处我们使用接口测试工具,通过APP认证方式中的凭证来实现对API的调用。 准备工作 已准备虚拟私有云、子网和安全组。 已在本地PC上下载并安装接口调试工具。 步骤一:购买实例 选择实例类型。