检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
基础定义：包括API前端请求定义和响应定义，不包括后端服务定义。其中API前端请求定义除了Swagger规范定义项外，还包括APIC的一些Swagger扩展字段。 全量定义：包括API前端请求定义、后端服务定义和响应定义。 扩展定义：包括API前端请求定义、后端服务定义和响应定义，还包括AP
API服务管理 创建API服务 导出API服务 生成产品 绑定域名 配置环境和环境变量 配置网关响应 父主题： API管理
身份认证服务API参考》的获取用户Token接口： {iam_endpoint}请参见地区和终端节点获取。 {user_name}和{password}分别替换为连接IAM服务器的用户名和密码。 {project_id}为项目ID。在管理控制台，将鼠标移至用户名，在下拉列表中单击“我的凭证”，查看“项目ID”。
配置说明 动作 选择访问控制的动作。 允许：表示仅允许指定IP地址的客户端调用API。 禁止：表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”，添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后，单击“确定”。 绑定API 登录ROMA
”导出文件。 Mock调测 对API设计文件的接口地址进行调测。 在页面中单击API设计文件名称，进入API编辑页面。 单击“编辑器”页签。 在编辑窗口上方开启“Mock”会自动生成Mock服务地址，您可以在可视化窗口对接口地址进行调测。 规范性检查 在API设计过程中提供接口规
生成签名的方式和APP认证相同，用AK代替APP认证中的AppKey，SK替换APP认证中的AppSecret，即可完成签名和请求。您可使用Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步
访问参数会被添加到后端签名认证信息中，并发送给后端服务，后端服务根据携带的访问参数返回不同的响应参数。 开启绿色通道后，需要设置白名单和黑名单。白名单中的地址可以不用认证即可调用API；黑名单中的地址不允许调用API。 单击“确定”，完成授权。 下线API 已发布的API因为其他原因需要暂停对外提供服务，可以暂时将API从相关环境中下线。
设计文件。 完成编辑后，单击右上角的“保存”。 您还可以执行以下操作。 （可选）配置SLA，提前设计接口运行的可靠性和性能指标。 （可选）Mock调测，对接口地址进行调测。 （可选）规范性检查，对接口规范性检查。 （可选）导入到API服务，将已设计的接口导入API服务。 （可选）
n”参数，携带的Key和Secret（或客户端的AppKey和AppSecret）进行API的调用认证。 app_secret app_secret认证方式开关。启用后，可在API请求中添加“X-HW-ID”和“X-HW-AppKey”参数，携带的Key和Secret（或客户端的
力。 “日志组”和“日志流”设置完成后，单击“确定”。 查看日志分析可单击“日志字段说明”，根据日志字段说明分析日志。 访问日志的字段采用空格作为分隔符，按照顺序，每个字段的含义如下： 表1 日志字段说明 序号 字段 说明 1 remote_addr 客户端地址 2 request_id
权应用的Key和Secret（或客户端的AppKey和AppSecret），以及用于调用API的SDK。 简易认证：向API管理者获取该API所在应用的AppCode。 其他认证：向API管理者获取该API所授权应用的Key和Secret（或客户端的AppKey和AppSecret）或凭证信息。
API的全生命周期管理在应用中实现，应用是一个系统资源的集合，即多个区域下，多个实例和多个项目等资源的集合。 API设计 API设计提供API文档的标准化设计和变更管控。 API实现 API实现是API开发者在后端开发、部署和业务编排的能力。 API管理 API管理提供了API服务开放、配置运行策略、API安全配置等能力。
创建自定义认证 自定义认证包含两种认证：前端自定义认证和后端自定义认证。 前端自定义认证：如果您希望使用自己的认证系统，而不是APP认证/华为IAM认证对API的访问进行认证鉴权时，您可以使用自定义认证，通过您自定义的函数进行认证鉴权。 后端自定义认证：当不同的后端服务使用不同的
API开放API，设计API、生成产品并上架到API目录，部门B通过API目录查看和订阅API。此时，部门A通过开放业务能力，使自身服务能力变现，部门B直接订阅部门A开放的API，减少开发时间和成本，实现部门之间业务共享。 前提条件 已创建应用和实例。 开放API A部门将自己的业务变现。 将A部门的业务生成设计文档。
在左侧导航栏选择“API消费 > API产品”。 单击“创建API产品”。 根据参数提示，填写产品基本信息。 在“添加版本和API”区域，选择是否创建产品版本，版本号、实例和API服务，勾选API。 只有已部署到RELEASE环境中的API，才能被添加到API产品中。 每个API仅能被添
在当前应用关联的实例中，根据实际业务选择实例。 在需要生成产品的API服务所在行单击“生成产品”。 填写产品基本信息。 在“添加版本和API”区域，选择是否创建产品版本，版本号、实例和API服务，勾选API。 只有已部署到RELEASE环境中的API，才能被添加到API产品中。 每个API仅能被添
API指标分析 云监控对ROMA API的运行状态进行日常监控，可以通过控制台直观的查看API网关各项监控指标。 前提条件 已创建API服务和API。 查看单个API的监控指标 登录ROMA API控制台。 在控制台单击，选择区域，在“ROMA API”下选择待操作的应用。 在左侧导航栏选择“API分析
规范查询字符串需要满足以下要求： 根据以下规则对每个参数名和值进行URI编码： 请勿对RFC 3986定义的任何非预留字符进行URI编码，这些字符包括：A-Z、a-z、0-9、-、_、.和~。 使用%XY对所有非预留字符进行百分比编码，其中X和Y为十六进制字符（0-9和A-F）。例如，空格字符必须编码为
本手册主要介绍以API设计者、API开发者、API管理者和API消费者角色和流程来定义API的生命周期，包含了API设计、API实现、API管理、API消费和API分析五大流程。API资产从Swagger文档、后端能力、API服务和API产品在流程中轮转，并不断演进。 应用是一个系统
pt SDK生成curl命令，然后将curl命令复制到命令行调用API。 前提条件 已获取API的域名、请求url、请求方法、AppKey和AppSecret等信息，具体参见认证前准备。 调用API示例 使用JavaScript SDK生成curl命令。 下载JavaScript
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
