检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值 参数的系统默认值。 参数范围 参数的取值范围。 参数运行值 参数当前的设置值。 更新时间 参数的最近一次
策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址:允许/禁止访问API的IP地址。 账号名:允许/禁止访问API的账号名。 动作 包括允许和禁止。 和“限制类型”配合使用,允许/禁止访问API的IP地址/账号名。 IP地址 单击“增加IP地址”,输入需要允许或者
移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值,如下图所示: 图1 从返回消息的Header中获取X-Subject-Token 使用如下命令将token设置为环境变量,方便后续事项。
API提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了ROMA API支持的SDK列表,您可以在GitHub仓库选择APIG或ROMA服务查看SDK更新历史、获取安装包以及查看指导文档。 表1 SDK列表 编程语言 Github地址 Reference
仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 选择健康检查所使用的HTTP请求方法,可选择“GET”和“HEAD”。 高级设置 检查端口 健康检查的目标端口,默认使用负载通道配置的端口号,但您可以指定其他的端口。 正常阈值 执行健康检查时,判定服务器状态正常的连续检查成功次数。例如“正常阈值”设置为“
根据API使用的安全认证方式,还要获取相关的请求认证信息: APP认证: 签名认证:向API管理者获取该API所授权应用的Key和Secret(或客户端的AppKey和AppSecret),以及用于调用API的SDK。 简易认证:向API管理者获取该API所在应用的AppCode。 其他认证:
API网关收到请求后,执行1~3,计算签名。 将3中的生成的签名与5中生成的签名进行比较,如果签名匹配,则处理请求,否则将拒绝请求。 APP签名仅支持Body体12M及以下的请求签名。 步骤1:构造规范请求 使用APP方式进行签名与认证,首先需要规范请求内容,然后再进行签名。客户端与API网关使用相同的请求规范,可以
不论“default(默认)”或是您自定义的网关响应,响应类型范围固定不可修改。您可以修改每种响应的状态码,以及响应内容。 响应内容的错误信息以及其他信息,可通过变量的方式获取,支持的变量见表2。 网关错误响应类型说明 ROMA API提供的错误响应类型见表1,其中响应状态码可以按实际需要做自定义修改。
访问密钥保护关闭时,所有IAM用户可以管理(包含创建、启用/停用或删除)自己的访问密钥。 访问密钥保护开启时,仅管理员可以管理用户的访问密钥。 如果您无法管理您的访问密钥,请联系管理员: 由管理员管理您的访问密钥,方法请参见:管理IAM用户访问密钥。 请管理员为您配置权限或修改访
API支持定义多个策略后端,即满足一定条件后转发给指定的API后端服务,用以满足不同的调用场景。例如为了区分普通调用与特殊调用,可以定义一个“策略后端”,通过调用方的源IP地址,为特殊调用方分配专用的后端服务。 除了定义一个默认的API后端服务,一个API共可以定义5个策略后端。 定义默认后端。 添加策略后端前
单击页面右上角的“导出”。 在页面中配置导出参数,完成后单击“导出”,导出结果可在页面右侧查看,同时支持下载到本地。 表1 API服务导出配置 参数 配置说明 API服务 选择待导出API所在的API服务。 运行环境 选择待导出API所在的部署环境。 API 默认导出API服务在
API”下选择待操作的应用。 在左侧导航栏选择“API管理 > API服务”。 在当前应用关联的实例中,根据实际业务选择实例。 单击页面右上角的“创建API服务 > 导入API设计文件”。 在弹窗中选择要开放API所在的设计文件,单击“确定”。 系统根据默认API导入规则检测API文件。
提供如何在API的描述信息中使用markdown语法,使描述信息更直观。 SimpleBookManagementAPI 提供资源管理类的简单API样例。 FileOperation 提供如何定义文件操作类API的简单样例。 Petstore 提供多种复杂API的定义样例。 单击
L1:基本功能验证,可用于继承特性的基本功能验证、迭代验收前的基本功能验证等。 L2:重要特性验证,可用于测试版本(非回归版本)中功能测试。 L3:一般功能/非重要功能验证,包括对基本/重要功能的异常测试。 L4:非常特殊输入、场景、阈值条件的用例。 用例描述 用例的描述信息。 选择API接
选择实例的计费模式,此处选择“按需计费”。 区域 选择实例所在的区域,此处选择“华北-北京四”。 可用区 选择实例所在的可用区,此处选择“可用区1”。 实例名称 填写实例的名称,根据规划自定义。建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。 实例规格 选择实例的容量规
API前,您需要先创建应用,然后在应用中创建和管理您的API资源。 账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件
禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。 绑定API 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧的导航栏选择“API管理
配置环境和环境变量 环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。通过创建环境
删除应用是否会删除关联的实例? 不会。 删除应用只是删除应用和实例的关联关系,并不会删除实例本身的任何资源。
选择是否开启绿色通道。 说明: 仅能授权自己有权限的应用。 访问参数会被添加到后端签名认证信息中,并发送给后端服务,后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后,需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API;黑名单中的地址不允许调用API。 单击“确定”,完成授权。