检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
PI描述信息长度建议不超过2000字符。 例如：发布API用于查询虚拟机列表。良好的API描述应为“通过虚拟机名称、IP地址、虚拟机型号查询当前租户下的虚拟机列表，列表包括虚拟机名称，所属VPC、虚拟机IP、虚拟机型号、操作系统版本。” API文档按照模板进行写作 本条规则是Sh
API网关代理提供环境变量功能，通过创建环境变量，实现在不同的环境定义不同的API调用路径。 环境变量是指在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API，在不同环境中调用不同的后端服务。 当创建API时定义了变量标识，则需要在环境中添加变量。例如
华为云租户的安全责任在于对使用的IaaS、PaaS和SaaS类各项云服务内部的安全以及对租户定制配置进行安全有效的管理，包括但不限于虚拟网络、虚拟主机和访客虚拟机的操作系统，虚拟防火墙、API网关和高级安全服务，各项云服务，租户数据，以及身份账号和密钥管理等方面的安全配置。 《华为云安全白皮书》
服务端提供新版本API的同时，需要对老版本API提供支持。 例如：应用A更新API查询虚拟机列表，增加多个新的查询条件。在API发布之后，之前订阅该API的应用不能因为增加了新的查询条件而造成查询虚拟机列表失败。 API请求HTTP动词使用标准化且满足幂等性 本条规则是Should类型的扩展规则，可提升API的可维护性。
调用不同环境的API，一般通过在API调用的请求头增加指定的头部参数，头部参数名固定为x-stage，它的取值为环境名，用以区分不同的环境。 环境变量 在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环境变量，实现同一个API在不同环境中调用不同的后端服务。 流量控制
-Stage头，内容为环境名。例如访问名为“DEVELOP”的环境，则添加“X-Stage:DEVELOP”。 管理控制台的“调试”功能，固定为调试环境，不支持携带环境变量调试。 后续操作 创建完环境和环境变量后，您可以将API发布到环境，以便API调用者调用。 父主题： API策略
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
}标识，例如/a/{b}，也可以通过配置'+'号做前缀匹配，例如：/a/{b+}。 匹配模式 分为两种模式： 绝对匹配：调用的请求Path固定为创建时填写的API请求Path。 前缀匹配：调用的请求Path将以创建时填写的API请求Path为前缀，支持接口定义多个不同Path。
}标识，例如/a/{b}，也可以通过配置'+'号做前缀匹配，例如：/a/{b+}。 匹配模式 分为两种模式： 绝对匹配：调用的请求Path固定为创建时填写的API请求Path。 前缀匹配：调用的请求Path将以创建时填写的API请求Path为前缀，支持接口定义多个不同Path。
服务商入驻 API中心管理控制台的以下功能只允许API中心服务商使用，如果您想要使用以下功能，需要先申请入驻成为API中心服务商： API资产管理：通过创建API资产，将您开发好的API分享至API中心门户网站，供其他开发者搜索和调用。 API网关代理：API网关代理包括API的
消费API 使用场景 如果您需要在API中心门户网站搜索需要的API，用于系统集成和项目开发，请参考本章指导操作。 操作步骤 访问API中心门户网站。 搜索您需要的API。 您可以选择搜索栏搜索或按不同维度搜索API。 搜索栏搜索：输入您需要的API的一些关键信息，如API名称、描述等，系统会展示相关的搜索结果。
最新动态 本文介绍了API中心各特性版本的功能发布和对应的文档动态，欢迎体验。 2023年7月 序号 功能名称 功能描述 阶段 相关文档 1 优化服务商入驻 仅支持华为云账号入驻API中心服务商，不允许该账号下的IAM用户入驻API中心服务商。 商用 服务商入驻 2 优化变更服务商信息
API门户 您可以在API中心门户网站搜索行业价值API，用于您的系统集成和项目开发使用。支持以下两种方式访问API中心门户网站： 直接访问API中心门户网站。 进入API中心服务页面。，单击左侧导航栏中的“API门户”链接，跳转至API中心门户网站。 API中心门户网站支持用户在免登录情况下搜索和查看API。
企业对外开放API供外部伙伴/开发者调用集成 操作场景 企业期望将自身业务能力（如实时快递查询服务）通过API接口对外开放，供外部伙伴/开发者调用集成，构建更繁荣的业务系统生态，并且触达更广泛的业务范围。 准备工作 准备好API接口文档，推荐OpenAPI 2.0/3.0格式。
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
