检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
上架目录 将API产品上架到API目录,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API产品”。 选择需要上架的API产品,单击产品名称。 在“版本列表”中,选择上架版本,单击“上架”。
账号用户可管理其下所有IAM用户所创建的应用和资源,IAM用户只能管理自己创建的应用和资源,默认无法查看其他IAM用户创建的应用和资源。您可以通过应用授权的方式,把应用下的资源共享给同一账号下的其他IAM用户来查看和使用。 前提条件 已购买ROMA Connect实例或APIG实例。 已创建项目资源。
API指标分析 云监控对ROMA API的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
订阅API产品 API目录相当于一个资产中心,以产品的形式将API资源上架到API目录中,供其他用户查看和使用。 操作步骤 登录ROMA API控制台。 在控制台单击,选择区域,在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API消费 > API目录”。 单击产品右侧的“订阅”。
签,可查看申请详情。 在“审核管理”页面,选择“我审核的申请”页签,单击“查看详情”,审批产品信息。 仅支持拥有租户管理员权限者审批。 图2 审批申请 查看上架是否成功。 返回产品详情页面,查看版本是否上架成功。 图3 上架成功 查看API产品 B部门在“目录列表”中查看API产品。
单击“确定”,并返回“API产品”页面。 查看申请 在左侧导航栏选择“API消费 > 审核管理”。 单击“我提交的申请”页签。 在已提交的申请所在行,单击“查看详情”,查看申请信息。 审核申请 仅支持拥有租户管理员权限者审批。 单击“我审核的申请”页签。 在待审核申请所在行,单击“查看详情”。 在审核详情页面查看产品基本信息和审核内容。
API设计文件的变更记录。支持查看变更前后的内容和还原变更内容。 查看全局API设计文件的变更历史 在页面右上角单击“API变更历史”,进入变更列表页面。 通过变更时间、请求方式或URL筛选变更信息。 单击“查看详情”,可通过文本形式或表单形式查看变更内容。 查看单个API设计文件的变更历史
盖。 如需查看已启用规则,可单击规则集名称。 (可选)查看规则集详情,包含已启用规则和未启用规则,可单击“管理”或“查看”。 管理:自己创建的规则集支持查看和编辑。 查看:其他用户创建的规则集仅支持查看。 通过“问题级别”和“规则类型”选择性查看。 单击规则名称,可查看规则的“正确示例”和“错误示例”。
配置API是否支持跨域访问CORS。 CORS请求分为两类: 简单请求:头信息之中,增加一个Origin字段。 非简单请求:在正式通信之前,增加一次HTTP查询请求。 开启CORS(非简单请求)时,您需要单独创建一个“Method”为“OPTIONS”的API,具体操作请参考开启跨域访问。 后端请求配置。
单击“Explorer”页签,选择版本号进入。 页面的最左侧展示产品下的API,中间可配置API请求参数,最右侧支持查看调试结果和API文档。 (可选)单击“文档”页签,查看API文档信息。 根据已设置认证方式,编辑请求参数,单击“调试”。 表1 请求参数说明 认证方式 Headers
单击“自定义认证”页签。 在“自定义认证”页面,可执行下表操作。 表1 管理自定义认证 相关任务 使用场景 操作步骤 查看自定义认证 查看自定义认证详情。 单击认证名称,查看自定义认证详情。 编辑自定义认证 修改自定义认证信息。 找到需要编辑的自定义认证,单击所在行的“编辑”,即可修改自定义认证信息。
单击“SSL证书管理”页签。 在“SSL证书管理”页面,可执行下表操作。 表1 管理证书 相关任务 使用场景 操作步骤 查看证书 查看证书详情。 单击证书名称,查看证书详情。包括序列号、有效期、签名算法、域名等信息。 编辑证书 修改证书信息。 找到需要编辑的证书,单击所在行的“编辑”,即可修改证书信息。
单击“确定”,克隆完成。 在已克隆版本中可查看、添加或移除API,以及上架克隆版本。 同步 API服务变更后,需要手动同步信息到产品。 选择变更API服务所属产品,单击产品名称。 在“版本列表”中选择同步版本。 在需要同步的API所在行,单击“同步”。 查看API 查看API产品下的API详情。
API概念,提供的能力,以及操作指引。 您可以根据不同角色查看行为路径,或者单击“查看指引”查看详细的操作指引。 初级使用者入门指导 中级使用者入门指导 高级使用者,敬请期待。 API治理专家,敬请期待。 目前仅初级使用者和中级使用者支持“查看指引”。
> 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“配置参数”页签。 在“配置参数”页面,找到需要配置的参数,单击“编辑”。 根据下表参数说明,配置参数。 表1 配置参数说明 内容 内容说明 参数 参数的名称。查看参数的具体功能说明,请参考实例配置参数说明。 参数默认值
在左侧导航栏选择“管理中心 > 实例管理”。 单击实例名称或实例卡片右上角的“查看控制台”。 单击“日志分析”。 单击“配置访问日志”。 在弹窗中将“启动日志记录”修改为即启用日志记录能力。 “日志组”和“日志流”设置完成后,单击“确定”。 查看日志分析可单击“日志字段说明”,根据日志字段说明分析日志。
),请将调试域名更改为实例的弹性IP地址,并且header中需添加参数host,值为调试域名。 单击执行测试。 若执行失败,可单击“查看结果”,查看日志定位原因。 更多详细操作,请参考快速入门。 父主题: API管理
如需批量发布,单击“批量操作”,选择要发布的API,单击。 填写发布信息,单击“确定”,完成发布。 图1 填写发布信息 如需查看发布历史,单击“更多”,选择“发布历史”。 图2 查看发布历史 后续操作 API发布完成后,您可直接将API服务生成产品,或从API服务中挑选部分API组合生成产品。
删除API API不再提供服务且已下线,可以将API删除。 选择需要删除的API。 选择“更多 > 删除”。 发布历史 查看API发布的历史记录。 选择需要查看的API。 选择“更多 > 发布历史”。 批量操作 批量发布、下线或删除API。 单击“批量操作”,勾选需要批量操作的API。
单击“确定”,完成访问控制策略的创建。 获取账号名 登录管理控制台。 获取账号名。 将鼠标移至用户名,在下拉列表中单击“我的凭证”。 在“API凭证”页面查看账号名。 图2 查看账号名 父主题: APIs管理