检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建负载通道 创建负载通道后,在创建API服务,且后端服务类型为HTTP/HTTPS时,后端服务地址可以直接使用已创建的负载通道。 前提条件 已创建云服务器。如需创建请参考创建云服务器。 已购买实例。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。
绑定凭据配额策略和绑定访问控制策略,且只有管理员(IAM用户拥有“Tenant Administrator”权限)能设置。 凭据策略分三种类型:集成凭据、订阅凭据和客户凭据(集成凭据由ROMA实例下的集成应用同步创建;订阅凭据通过订阅产品后,在产品所属实例下同步创建;客户凭据由租户管理员在APIG实例下创建)。
参数 配置说明 策略名称 填写策略的名称,根据规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 选择策略的类型,不同类型的策略提供不同扩展能力。 跨域资源共享:为API的跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的能力。 HT
不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。
访问控制策略信息 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括允许和禁止。 和“限制类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 单
自定义名称,用于识别不同的密钥。 类型 选择签名密钥的认证类型,可选择“APP认证”、“Basic Auth”或“Public Key”。 在应用关联实例的配置参数中开启public_key功能后,才支持选择“Public Key”类型。 Key 根据选择的密钥类型,填写不同的密钥信息。
API自动增加默认值发送给后端服务。 字节限制 最大长度/最大值:“类型”为“STRING”时,设置参数值的最大字符串长度,“类型”为“NUMBER”时,设置参数值的最大值。 最小长度/最小值:“类型”为“STRING”时,设置参数值的最小字符串长度,“类型”为“NUMBER”时,设置参数值的最小值。 示例
根据选择不同的“后端服务类型”,所需要配置的参数有所不同。 FunctionGraph类型依赖于函数工作流服务FunctionGraph,若当前环境中未部署FunctionGraph服务,则后端服务类型FunctionGraph不可用。 表2 HTTP&HTTPS类型定义后端服务 服务参数
已准备虚拟私有云、子网和安全组。 已在本地PC上下载并安装接口调试工具。 步骤一:购买实例 选择实例类型。 登录ROMA API控制台,单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 单击“购买实例”。 选择实例类型,以APIG实例为例。 购买实例。 创建APIG实例。 图2 配置实例信息
der参数,默认为Authorization。 public_key_enable public_key类型签名密钥开关。启用后,可在签名密钥认证中使用public_key类型签名。 public_key_uri_prefix:获取public_key对应secret的uri前缀
在创建自定义认证弹框中,根据下表填写参数信息。 表1 自定义认证参数 信息项 描述 认证名称 您自定义的认证名称,用于区分不同的自定义认证。 类型 前端:对API的访问进行认证鉴权。 后端:对后端服务的访问授权。 函数地址 选择用于前端自定义认证或后端自定义认证的函数后端,且创建的函
从开始与后端建立连接到从后端获取到最后一个字节所用时间,单位秒。发生重试时,为所用时间总和。 25 errorType API请求的错误类型。 0:非流控错误。 1:流控错误。 26 auth_type API认证类型。 27 access_model1 认证模式1。 28 access_model2 认证模式2,开启双重认证时,为自定义认证编号。
如果只需要导出个别API,可单击“自定义导出API”,勾选需要导出的API。 API定义范围 选择导出的API服务文件中,API定义字段的类型范围。 基础定义:包括API前端请求定义和响应定义,不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外,还包括APIC的一些Swagger扩展字段。
入请求体。 未定义Body 通过POST/PUT/PATCH方法请求的API支持展示自定义填写。 说明: 如果API已定义formData类型参数,将不展示Body参数,且暂不支持调试。 IAM认证 支持Token认证或AK/SK认证。Explorer自动获取或临时生成Token或AK/SK。
在左侧导航栏单击“API设计”。 单击“创建API文件”。 在弹窗中修改“名称”,或默认系统自动生成的名称;根据下表说明,选择模板。 表1 API文件模板 模板类型 类型说明 SimpleAPI 提供简单GET请求样例。 DescriptionWithGFM 提供如何在API的描述信息中使用markdown语法,使描述信息更直观。
登录ROMA API控制台。 在控制台单击,选择区域。 在左侧导航栏选择“管理中心 > 实例管理”。 在页面右上角单击“购买实例”。 选择实例类型。 选择ROMA Connect实例,进入购买实例页面,具体操作请参考创建Connect实例。 选择APIG实例,进入购买实例页面,具体操作请参考购买专享版实例。
在左侧导航栏选择“总览”或“管理中心 > 应用管理”。 单击“创建应用”,填写应用名称和描述。 单击“新增关联区域资源”,选择关联区域。 关联实例资源,单击,选择实例类型。 不支持关联2019年6月份之前创建的ROMA Connect实例。 ROMA Connect实例:选择实例和集成应用。 APIG实例:选择实例。
文件(后缀名为“.pem”或“.key”),将私钥复制到“密钥”中即可。 单击“确定”,完成SSL证书的添加。 转换证书为PEM格式 格式类型 转换方式(通过OpenSSL工具进行转换) CER/CRT 将“cert.crt”证书文件直接重命名为“cert.pem”。 PFX 提取私钥命令,以“cert
在当前应用关联的实例中,根据实际业务选择实例。 单击“关联资源”。 在“项目资源”区域,选择您的DevCloud的项目,单击“保存”。 单击“导入用例”,选择导入类型。 导入API服务:从“API服务”中选择API导入,生成测试用例。选择API服务,单击“确定”。 导入API设计文件:从“API设计”选
用您开放的API。 前提条件 已备案独立域名,未备案的独立域名无法被访问。 已经将独立的域名解析到该服务的实例IP上,具体方法请参考增加A类型记录集。 如果API服务中的API支持HTTPS请求协议,那么在独立域名中需要添加SSL证书,请您提前准备SSL证书。此证书不支持导入,您需要填写证书的名称、内容和密钥。