检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
一个API只能绑定一个相同类型的策略。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
在“SSL证书管理”页面,可执行下表操作。 表1 管理证书 相关任务 使用场景 操作步骤 查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。 删除证书 删除不需要的证书。 找到需要删
在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。 图2 运行环境信息 对于APP认证的API,您必须提供有效的AppKey、AppSecret才能够生成认证签名。 在凭
为API绑定策略时,API的请求方法必须为allow_methods中允许的请求方法。 配置参数说明 表1 配置参数说明 参数 配置说明 allowed origins Access-Control-Allow-Origin响应头,指定允许访问API的外域URI,多个URI之间使用英文逗号隔开。
响应头操作,您可以覆盖、添加、删除、跳过或新增指定的响应头。 override:覆盖 当API响应中存在指定的响应头时,使用当前响应头的值覆盖已有响应头的值。 当API响应中存在多个与指定响应头相同名称的响应头时,该操作只会按当前响应头的值返回一条响应头记录。 当API响应中不存在指定的响应头时,添加当前响应头。
问控制等策略对象的定义。 导出格式 选择导出的API服务文件格式,可选择JSON或YAML。 自定义版本 填写导出API的版本号,如果没有指定版本号,默认使用当前时间作为版本号。 父主题: API服务管理
创建规则集 根据业务需求创建规则集。 设置无需检查的接口 设置无需规范性检查的接口。 配置扩展字段 支持统一自定义扩展字段,指定显示区域,字段名必须以“x-”开头。 启用规则集 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏单击“API设计”。
3986标准化URI路径,移除冗余和相对路径部分,路径中每个部分必须为URI编码。如果URI路径不以“/”结尾,则在尾部添加“/”。 举例: 示例中的URI:/app1,此时规范的URI编码为: GET /app1/ 计算签名时,URI必须以“/”结尾。发送请求时,可以不以“/”结尾。 添加
仅当“协议”选择“HTTP”或“HTTPS”时需要配置。 服务器在返回指定的HTTP响应码时,判定响应成功。可同时指定多个响应码。 通道内服务器配置 服务器添加方式 选择添加服务器方式,目前支持“选择云服务器”和“指定服务器地址”。 单击“完成”,创建完成。 父主题: 实例管理
单击“编辑”,修改API信息,具体操作请参考创建API。 授权API 仅使用APP认证方式的API,才需要授权,发布API后,通过指定授权给某些应用,让指定应用能够调用API。 选择需要授权的API。 选择“更多 > 授权”。 在弹窗中设置授权信息。 选择授权应用。 设置访问参数。 选择是否开启绿色通道。
在“环境变量”区域,单击“添加环境变量”,选择待添加变量的环境名称。 填写变量相关信息,单击“确定”。 图2 新增变量 表1 新增变量 参数 配置说明 变量名 变量的名称,必须与创建API时定义的变量标识完全相同。 变量值 变量路径。 父主题: API服务管理
建用于前端认证的函数后端或创建用于后端认证的函数后端。 身份来源 设置用于认证的请求参数。 当“类型”为“前端”,且“缓存时间”不为0时,必须设置此参数。使用缓存时,此参数将作为搜索条件来查询认证结果。 缓存时间 设置认证结果缓存的时间。 值为0时代表不缓存,最大支持3600秒。
frontend.property 前端自定义认证响应的context映射的指定键值对的字符串值 $context.authorizer.backend.property 后端自定义认证响应的context映射的指定键值对的字符串值 $context.error.message 当前网关错误响应的错误信息
”。 在弹窗中配置策略信息。 表3 配置访问控制策略 参数 配置说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。
HTTP响应头管理 API响应是指ROMA API返回客户端的响应,HTTP响应头是API响应中的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 HTTP响应头管理策略 3 SLA配置 提前设计接口运行的可靠性和性能指标。 配置SLA 4 导入规则检查 系统根据默认API导入规则,检测API文件。
助您轻松构建、管理和部署任意规模的API。 API设计 创建API设计 管理规则集 API实现 创建后端 API管理 创建API服务 绑定域名 创建API 授权API 跨域资源共享策略 HTTP响应头管理策略 自定义认证 流量控制 访问控制 签名密钥 API消费 创建API产品 上架目录