检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API描述信息必须易于理解，表述准确 本条规则是Should类型的扩展规则，可提升API调用者的使用体验。 API描述信息要易于理解，字面表述准确，能说明API的用途，场景及约束。 API描述信息建议使用Markdown格式编写，便于生成对应API文档，API描述信息长度建议不超过2000字符。
HEAD 返回资源的元信息比如：ETag和Last-Modified之类的信息。 是 PATCH 用于部分更新资源的场景，如果使用PUT操作所需输入的整体资源信息内容大小与PATCH操作无太大差异，优先使用PUT操作，不推荐使用PATCH操作。 是 OPTIONS 获取当前资源支持哪些方法的信息。
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
导入API支持单个API导入和批量API导入，主要取决于Swagger文件中包含的API数量。 前提条件 已获取待导入API的Swagger文件。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击页面右上角的“导入API”，具体操作请参考导入Swagger文件。 后续操作
进入API中心服务页面。 选择左侧导航栏中的“API订阅管理” ，进入“API订阅管理”页面。 “API订阅管理”页面展示您在API中心门户网站订阅的所有API。您可以在右上角输入API资产名称或服务商名称，筛选想要查看的API。 取消订阅API 进入API中心服务页面。 选择左侧导航栏中的“API订阅管理”
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“环境管理”页签。 单击“创建环境”，填写环境信息。 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”，创建环境。 创建环境成功后，在“环境管理”页面的列表中显示新创建的环境。
API每次最大可以调用12M的请求包。 TLS协议 支持TLS1.1和TLS1.2，推荐使用TLS1.2。 本章描述的“用户”指的都是华为云账号。 如果API网关代理当前的配额限制无法满足您的需求，您可以向系统提交工单申请更多配额。
PI暂未提供调测能力。具体功能以API详情页面展示的为准。 华北-北京四 API凭证获取 对于技术开放型API，应用开发者可根据API使用指南中的指定方式或者联系API服务商获取API调用凭证。 对于商业售卖型API，应用开发者可根据页面引导前往云商店通过购买获得API调用凭证。
安全认证方式为“无认证”或“华为IAM认证”的API，无需创建凭据。 创建凭据 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 单击“创建凭据”，填写凭据信息。 表1 凭据信息 信息项 描述 凭据名称 凭据的名称。 描述 凭据的介绍。 （可选）单击“自定义配置”
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API列表”。 单击待调试的API名称，进入“API运行”页面。 单击“调试”。 配置API请求参数后，单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时，返回HTT
访问1000次。 创建API分组 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击右上角的“创建API分组”，选择下拉框中的“创建API分组”。 在弹框中填写分组信息。 表1 分组信息表 信息项 描述 分组名称 API分组名称，用于将API接口进行分组管理。
后端服务请求的超时时间。此处默认“5000”ms。 在“返回结果基础定义”页面，定义返回结果。 表5 定义返回结果 信息项 描述 成功响应示例 成功调用API时，返回的响应信息示例。 失败响应示例 调用API失败时，返回的响应信息示例。 单击“完成”，完成API的创建。 步骤4：调试API 在左侧导航栏选择“API网关代理
中心服务商。 操作步骤 进入API中心服务页面。 在左侧导航栏选择“服务商入驻”。 单击页面中间的“立即入驻”。 图1 入驻API中心服务商 也可以在API中心门户网站，单击页面右上角的“服务商入驻”，进入服务商入驻页面。 填写服务商信息。 图2 申请入驻API中心 如果您已入驻
X-Apig-RateLimit-api API流量控制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了API流量控制时，返回此参数 X-Apig-RateLimit-user 用户流量限制信息 示例：remain:9
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API凭据管理”。 在“凭据管理”页面，单击凭据名称，进入详情页面。 在“AppCodes”区域，单击“添加AppCode”。 在弹窗中配置AppCode，完成后单击“确定”。 表1 配置AppCode 信息项 描述 生成方式
API网关代理与负载通道中的服务器之间网络互通。 创建负载通道 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 单击“负载通道”页签，进入到负载通道列表页面。 单击“创建负载通道”，配置基本信息。 表1 基本信息配置 信息项 描述 通道名称 自定义负载通道名称，用于识别不同的负载通道。
已完成服务商入驻，具体操作指导参考《用户指南》服务商入驻章节。 操作步骤 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息，配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式
API数据分析 API数据分析页面通过图表的形式，直观地展示您在API网关代理中已经发布的所有API被调用的情况。 前提条件 已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表1所示。
1个服务商创建的所有API资产中API接口的总数量不能超过1000个。 创建API资产 进入API中心服务页面。 选择左侧导航栏中的“API资产管理 > API资产”。 单击页面右上角的“创建API资产”。 填写API资产信息。 根据表1参数信息，配置选择导入API。 表1 选择导入API 参数名称 说明 导入方式
操作步骤 进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API分组”。 单击分组名称。 单击“分组信息”页签。 单击“环境变量”页签后面的，展开环境变量区域。 选择环境。如果未创建环境，可单击“创建环境”创建。 单击“添加环境变量”，填写变量信息。 在实际发送API请
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
