检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
系统参数配置 信息项 描述 系统参数类型 选择系统参数的类型。 网关内置参数：API网关代理支持配置的系统参数。 系统参数名 填写系统参数的名称。 “系统参数类型”为“网关内置参数”时，支持选择如下参数： sourceIp：API调用者的源地址。 stage：API调用的部署环境。
线调测时，用户登录华为云账号后，API中心会为您自动获取Token或者自动生成临时AK/SK，帮助您直接进行在线调测；调用API时，可根据参数填写项的提示链接和指导文档，获取用户Token和AK/SK。 如果是来源于华为云市场的API商品，可按照页面提示完成购买，然后在“买家中心
安全性 涉及敏感信息或个人隐私数据的API，应提供数据传输和存储过程中的安全机制 本条规则是MUST类型的基本规则，可保障API的安全合规。 API接口参数传输和存储过程中，敏感信息和个人隐私数据禁止明文传输和存储，避免造成敏感信息或个人隐私数据泄露。敏感信息和个人隐私数据包括：
进入API中心服务页面。 在左侧导航栏选择“API网关代理 > API策略”。 在“策略管理”页面，单击“创建策略”。 单击需要创建的策略类型。 传统策略 不同的策略类型，策略内容的配置不同： 流量控制策略说明 访问控制策略说明 签名密钥策略说明 单击“确定”。 策略创建后，您还需要为API绑定策略，才能使策略对API生效。
环境定义了API生命周期管理过程中的不同状态，API可以被发布到不同的自定义环境中。 调用不同环境的API，一般通过在API调用的请求头增加指定的头部参数，头部参数名固定为x-stage，它的取值为环境名，用以区分不同的环境。 环境变量 在环境上创建可管理的一种变量，该变量固定在环境上。通过创建环
一个访问控制策略可以绑定多个API。 配置参数说明 表1 配置参数说明 信息项 描述 策略名称 访问控制策略的名称。 类型 控制访问API的类型。 IP地址：允许/禁止访问API的IP地址。 账号名：允许/禁止访问API的账号名。 动作 包括“允许”和“禁止”。 和“类型”配合使用，允许/禁止访问API的IP地址/账号名。
写的字段，字段取值范围不建议小于原有的取值范围。 API文档记录API接口变更 本条规则是Should类型的扩展规则，可方便管理API的生命周期。 API接口的变更，要具体到参数级别，必须将API修订的记录按照时间和版本顺序排列进行条目化，具体示例如表1所示。 表1 API修订记录
代理服务器尝试执行请求时，从上游服务器接收到无效的响应。 API请求设置媒体类型和编码格式，响应内容格式需与响应设置媒体类型和编码格式一致 本条规则是MUST类型的基本规则，可保障API的高可用性。 在API请求中对媒体类型和编码格式的正确定义有助于服务端对请求体进行格式校验，避免出现因请求消息体格式错误导致的执行异常。
的Authorization头中签名是否一致，来校验API网关代理的合法性。 配置参数说明 表1 配置参数说明 信息项 描述 密钥名称 自定义名称，用于识别不同的密钥。 类型 选择签名密钥的认证类型，可选择“HMAC”、“Basic Auth”、“Public Key”和“Aes”。
API请求方法和URI。 API请求参数说明，包括Header、Query参数，需要明确字段内容和取值范围。 API请求Body内容，Body内容需要明确请求结构体内容及各个字段的取值范围。 API响应状态码，状态码及对应的说明。 API响应参数说明包括Header参数，需要明确字段内容和取值范围。
安全性 API使用合适的认证模式 本条规则是Should类型的扩展规则，可提升API的安全性。 根据具体业务场景，选择API调用的认证模式，具体说明如表1所示。 表1 认证模式说明 认证模式 认证描述 AppKey 在API请求Header或者Query中携带AppId和AppK
可维护性 保证API日志采集的实时性及完整性 本条规则是MUST类型的基本规则，可保障API的可维护性。 在采集API调用日志过程中，需要保证API日志的实时性和完整性，以提升API分析的精准度。 API日志在传递过程中，必须保证传递日志不会出现丢失。API日志总体丢失率小于0.5%。
导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时，需要填写API资产的URL地址。 根据表2参数信息，配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。
debug，且后端服务类型不为Mock时，返回此参数 X-Apig-RateLimit-api API流量控制信息 示例：remain:9,limit:10,time:10 second 仅在请求消息头包含X-Apig-Mode: debug，且API配置了API流量控制时，返回此参数 X-Apig-RateLimit-user
配置API请求参数后，单击“调试”。 在页面下方返回结果回显区域打印API调用的Response信息。 调用成功时，返回HTTP状态码为“200”和Response信息。 调试失败时，返回HTTP状态码为4xx或5xx，具体错误信息请参见错误码。 您可以通过调整请求参数与参数值，发送不同的请求，验证API服务。
用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能，从而实现后端服务的负载均衡。 创建负载通道后，在创建API，且后端服务类型为HTTP/HTTPS时，后端服务地址可以直接使用已创建的负载通道。 例如，负载中包含6台ECS，已创建一条负载通道，其中ECS 01和ECS
果导入全部接口，则忽略此参数。 OpenAPI API网关 Postman Collection API Arts API URL 当“导入方式”为“URL”时，需要填写API资产的URL地址。 根据表2参数信息配置资产基本信息。 表2 资产基本信息 参数名称 说明 资产名称 自定义API资产的名称。
服务信息。 选择后端服务类型，此处选择“HTTP/HTTPS”。 表4 HTTP/HTTPS类型定义后端服务 服务参数 参数说明 负载通道 选择“不使用”负载通道访问后端服务。 URL 请求方法：接口调用方式，此处选择“GET”。 请求协议：选择协议类型，此处选择“HTTP”。 后端服务地址：后端服务的地址。
已成功申请入驻成为API中心服务商。具体操作指导参见服务商入驻。 查看步骤 进入API中心服务页面。 在左侧导航栏选择“API数据分析”。 资源概览区域参数的含义如表1所示。 表1 资源概览参数说明 参数名称 含义 API总数 API网关代理中，已创建的API的总个数。数据1个小时刷新一次。 API分组总数 API网
将支持简易认证的API绑定到已创建的凭据。 发送请求时，增加请求头部参数“X-Apig-AppCode”，省略请求签名相关信息。 以Curl方式为例，增加头部参数名称：X-Apig-AppCode，参数值填已生成的AppCode。 curl -X GET "https://api
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
