检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。 在对API日志处理过程中，仅能对API日志进行增维操作，禁止对API日
发者搜索和调用。 API网关代理：API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务。 API数据分析：查看API网关代理中已发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。
发者搜索和调用。 API网关代理：API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务。 API数据分析：查看API网关代理中已发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 只允许华为云企业账号申请成为API中心服务商。
SSL证书配置 参数 配置说明 证书名称 填写SSL证书的名称，根据规划自定义。建议您按照一定的命名规则填写SSL证书名称，方便您快速识别和查找。 证书内容 填写pem编码格式的SSL证书内容。 以文本方式打开待添加证书里的PEM格式证书文件（后缀名为“.pem”），将证书内容复制到“证书内容”中即可。
概述 API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务，能快速将企业服务能力包装成标准API服务，帮助您轻松构建、管理和部署任意规模的API。借助API网关代理，可以简单、快速、低成本、低风险地实现内部系统集
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
导入方式 导入方式包含以下2种： 生成新的分组：将API定义导入到一个新的分组，导入过程中系统会自动创建一个新的API分组，并将导入的API归属到该分组。 选择已有分组：将API定义导入到一个已有的分组，导入过程中不会删除分组中已有的API，只是将新增的API导入分组。 扩展覆盖 勾选后
在使用过程中需要使用HTTPS协议保证传输安全。 签名认证 请求Header或者Query中携带请求签名、请求时间和应用身份进行身份认证，该认证方法对请求中URI、HTTP方法、AppId、SignKey、请求时间等采用HMAC-SHA256进行计算，在API请求过程中不会直接
获取资源集合的API建议支持分页。当资源数量较多时服务的查询API需要支持分页，避免一次查询获取的资源数量过多。 不支持分页查询，则服务应该要设置一个显示条数的默认值，避免一次返回过多资源。默认返回数量需要在接口参考中对外说明，避免调用者以为查询出了全量信息。查询条件中可以设定查询数量(limit)，位移量(
无需另外配置。 {Path}：请求路径，需替换为获取API的请求信息中获取的URL。 {Query}：查询参数，可选，格式为“参数名=参数取值”，例如limit=10，多个查询参数之间使用“&”隔开。需根据获取API的请求信息中获取的请求参数进行设置。 {Header}：请求头参数，格式为“参数名:
图2 前端定义 表2 前端定义 参数 配置说明 API名称 系统默认自动生成一个API名称，建议按照一定的命名规则填写，方便后期快速识别和查找。 所属分组 默认创建API分组中已创建分组。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTPS”。
力。 传输流量控制：指API单位时间内传输的数据量。 API发布过程中必须保证API注册信息的准确性 本条规则是MUST类型的基本规则，可保障API的高可用性。 API发布是API生命周期中重要的部分，因此在发布过程中需要保证API的正确性、可读性、可用性，并对服务质量进行约束。
为了方便管理API的生命周期，API网关代理定义了API受限使用范围，这个受限使用的范围，称为环境。例如：API的测试环境，开发环境等。 环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般通过在API调用的请求头增加指定的头部参数，头部参数名固定
发者搜索和调用。 API网关代理：API网关代理包括API的创建、发布、下线和删除所经历的完整生命周期过程，为您提供高性能、高可用、高安全的API托管服务。 API数据分析：查看API网关代理中已经发布的API被调用的情况，如被请求调用的次数，调用失败的次数等。 支持区域： 华北-北京四
APIC.0303 Incorrect App authentication information. 检查请求的方法、路径、查询参数、请求体和签名使用的方法、路径、查询参数、请求体是否一致。 检查客户端机器时间是否正确。 403 APIC.0304 The app is not authorized
服务端提供新版本API的同时，需要对老版本API提供支持。 例如：应用A更新API查询虚拟机列表，增加多个新的查询条件。在API发布之后，之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Shoul
示在API资产列表页。 后续操作 创建完API资产后，您还可以执行表3的操作。 表3 后续操作 操作 说明 查看API资产详情 在API资产列表页，单击API资产名称，查看API资产详情。 修改API资产信息 在API资产列表页，单击API资产所在行“操作”列的“编辑”，修改API资产信息。
在左侧导航栏选择“API网关代理 > API列表”。 在API所在行，单击“操作”列的“更多 > 授权”。 单击“添加授权”。 选择API授权环境，查询并勾选凭据后，单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权，在“授权历史”弹窗中，选择需解除授权的凭据，单击“操作”列“解除授权”。
根据下表参数信息，配置前端定义。 表1 前端定义 信息项 描述 API名称 API名称，根据规划自定义。建议您按照一定的命名规则填写API名称，方便您快速识别和查找。 所属分组 API所属的分组。可以选择已有分组，或者单击右侧的“新建分组”链接，新建一个分组。 URL 前端地址由请求方法、请求协议、子域名和路径组成。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
