检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
附录-API治理规范指导 概述 规范要求 工具平台
概述 简介 术语 父主题： 附录-API治理规范指导
规范要求 API生产 API开放 父主题： 附录-API治理规范指导
API门户的资产目录便捷高效地查找和获取API，并进行调测、试用。 API网关代理 API中心的网关代理模块提供API管理，分组管理，策略配置，凭据管理等能力。帮助伙伴服务商对外开放API服务，为API数据分析提供支撑。 API运营 API中心为平台运营人员提供灵活高效的运营管理
服务韧性 API中心提供了4级可靠性架构，通过全局部件跨Region容灾、Region部件跨AZ容灾、AZ内集群容灾、数据库主备容灾，保障服务的持久性与可靠性。 表1 API中心可靠性架构 可靠性方案 简要说明 跨Region容灾 全局级部件支持跨Region容灾，当主Regio
认证证书 合规证书 华为云服务及平台通过了多项国内外权威机构（ISO/SOC/PCI等）的安全合规认证，用户可自行申请下载合规资质证书。 图1 合规证书下载 资源中心 华为云还提供以下资源来帮助用户满足合规性要求，具体请查看资源中心。 图2 资源中心 销售许可证&软件著作权证书
标签主要用于对API添加分类属性，方便在创建了大量API后，快速过滤和查找。 描述 API的描述。 根据下表参数信息，配置安全配置。 表3 定义API请求 参数 配置说明 安全认证 选择API认证方式，此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名，API网关
凭据名称 凭据的名称。 描述 凭据的介绍。 （可选）单击“自定义配置”后面的，展开自定义配置区域，可以自定义配置AppKey和AppSecret。AppKey是身份标识，需要保证全局唯一。 如果没有特殊需求，不建议使用“自定义配置”，系统会默认生成全局标识，可在凭据详情中查看。 单击“确定”，创建凭据。
debug，且API配置了API流量控制时，返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了用户流量限制时，返回此参数
在“域名管理”区域，单击“绑定独立域名”，并在弹窗中配置域名信息。 表1 独立域名配置 信息项 描述 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本，TLS1.1或TLS1.2，推荐使用TLS1.2。 该配置仅对HTTPS生效，不影响HTTP或者其他访问方式。
址的访问控制策略绑定。 同一个环境中，一个API只能被一个限制账号名的访问控制策略绑定。 一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：允许/禁止访问API的IP地址。
PI。 仅在“导入方式”选择“选择已有分组”时，需要选择是否覆盖。 （可选）单击“全局配置(可选)”。 安全配置。请参考安全配置。 后端请求配置。请参考1。 确认无误后，单击“完成”，完成配置。 单击“立即导入”，在弹窗中选择是否现在发布API到环境。 如果选择“现在发布”，还需
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息，配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI
进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息，配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式 支持以下6种方式，上架API文件至API中心门户网站： OpenAPI：支持导入符合OpenAPI
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API，用于系统集成和项目开发，请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索：输入您需要的API的一些关键信息，如API名称、描述等，系统会展示相关的搜索结果。
configurations do not exist. 联系技术支持。 400 APIC.0106 Orchestration error. 检查API配置的前后端参数是否合理。 400 APIC.0201 Bad request. 使用合法的请求。 413 APIC.0201 Request
在“凭据管理”页面，单击凭据名称，进入详情页面。 在“AppCodes”区域，单击“添加AppCode”。 在弹窗中配置AppCode，完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式 选择AppCode的生成方式。 自动生成：由系统随机生成AppCode。 手动输入：自定义AppCode。
）进行签名，通过比对签名结果和API网关代理传过来的Authorization头中签名是否一致，来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“HMAC”、“Basic
与其他服务的关系 API Arts API中心将API Arts作为API生产工具提供给API开发者，并支持API开发者将工具中的API文档一键发布到API中心进行分享和开放。 API Explorer API中心对接集成API Explorer，并将其作为API中心的API调试
API门户 您可以在API中心门户网站搜索行业价值API，用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站： 直接访问API中心门户网站。 进入API中心服务页面。，单击左侧导航栏中的“API门户”链接，跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
