检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
进入。 页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。 表1 请求参数说明 认证方式 Headers Parameters Body APP认证
单击“确定”,克隆完成。 在已克隆版本中可查看、添加或移除API,以及上架克隆版本。 同步 API服务变更后,需要手动同步信息到产品。 选择变更API服务所属产品,单击产品名称。 在“版本列表”中选择同步版本。 在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。
访问服务前,首先需要得到API的请求方法和请求url。 在API服务详情中的“API运行”页面,查看对应API的请求方法和请求url。 图1 API基础定义 您必须将API发布到环境才能访问。 在API服务详情中的“API运行”页面,查看已发布的环境。 图2 运行环境信息 对于APP认证的API,您必须提供
将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
在当前应用关联的实例中,根据实际业务选择实例。 单击“SSL证书管理”页签。 在“SSL证书管理”页面,可执行下表操作。 表1 管理证书 相关任务 使用场景 操作步骤 查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编
订阅API产品 API目录相当于一个资产中心,以产品的形式将API资源上架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。
在当前应用关联的实例中,根据实际业务选择实例。 单击“自定义认证”页签。 在“自定义认证”页面,可执行下表操作。 表1 管理自定义认证 相关任务 使用场景 操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,
{user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 {project_id}为项目ID。在管理控制台,将鼠标移至用户名,在下拉列表中单击“我的凭证”,查看“项目ID”。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值,如下图所示: 图1 从
在当前应用关联的实例中,根据实际业务选择实例。 在页面上单击服务名称,进入API服务详情页面。 单击“API运行”页签。 根据下表相关任务,了解如何管理API。 表1 管理API 相关任务 使用场景 操作步骤 编辑API 修改API信息。 选择需要编辑的API。 单击“编辑”,修改API信息,具体操作请参考创建API。
导入API设计文件,从“API设计”中选择设计文件导入,单击“确定”。 导入Swagger文件,从本地导入文件,单击“打开”。 参考下表配置后端。 表1 后端配置参数说明 参数 参数说明 后端名称 后端的名称。 归属项目 自动读取当前应用已关联Devcloud服务中的项目。 新建代码仓
盖。 如需查看已启用规则,可单击规则集名称。 (可选)查看规则集详情,包含已启用规则和未启用规则,可单击“管理”或“查看”。 管理:自己创建的规则集支持查看和编辑。 查看:其他用户创建的规则集仅支持查看。 通过“问题级别”和“规则类型”选择性查看。 单击规则名称,可查看规则的“正确示例”和“错误示例”。
单击“创建后端”,选择“导入API设计”。 选择API设计文件,单击“确定”。 后端配置 表2 后端参数配置 参数 配置说明 后端名称 填写后端的名称,建议您按照一定的命名规则填写实例名称,方便您快速识别和查找。 归属项目 在创建应用时需要关联项目,默认步骤二中关联项目。 新建代码仓 填写代码仓的名称。
输入描述信息,单击“确定”。 创建成功后,在“创建成功”弹窗中,单击“立即下载”下载密钥,并妥善保管。 您可以在访问密钥列表中查看访问密钥ID(AK),在下载的.csv文件中查看访问密钥(SK)。 获取临时AK/SK,请参考IAM接口文档。 请及时下载保存,弹窗关闭后将无法再次获取该密钥信息,但您可重新创建新的密钥。
如果title超长,将自动截断并显示省略号,若需鼠标经过时冒泡,请在样式中增加 js-title 如果title超长,将自动截断(文字超长时,列表项样式改为:listitem_qFLwPs2_100) 03 入门 弹性云服务器(Elastic Cloud Server)是一种可随时自动获取、计算能力可弹性伸缩的云服务器。
API”下选择待操作的应用。 在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“环境管理”页签。 单击“创建环境”。 根据下表参数说明,配置环境信息。 表1 环境参数说明 参数项 说明 环境名称 API环境名称。 描述 - 单击“确定”,创建完成。
L4:非常特殊输入、场景、阈值条件的用例。 用例描述 用例的描述信息。 选择API接口,单击“立即导入”,跳转到用例列表页面。 单击用例名称,进入“功能手工测试”页面。 单击“接口自动化”页签,可查看或编辑已创建的测试用例。 单击用例名称,进入“测试详情”页面。 单击“测试脚本”页签。 将鼠标移至测试步骤区域,单击展开。
在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。
添加API的标签信息,用于快速过滤和查找API。 描述 填写API的描述信息。 根据下表参数定义,配置安全配置。 表2 安全配置参数 信息项 描述 安全认证 API认证方式: APP认证:表示由ROMA API服务负责接口请求的安全认证。 华为IAM认证:表示借助IAM服务进行安全认证。