检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本，列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表，您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client
对象模型 本节介绍自定义域名及证书的对象模型。 “操作类型”用于描述字段的属性，表示对应字段的值可进行的操作： C：创建；U：更新；R：读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作，对应字段是否为必选字段。 表1 域名对象模型 参数 类型 说明 操作类型 是否必选
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL
配置API的调用域名 API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。因此，在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。最多可以添加5个独立域名，不限访问次数。 独立域名可分为内网域名和公网域名两种
配置API的发布环境和环境变量（可选） 环境是指API的受限使用范围，API只有在发布到环境后，才能被调用。API可以被发布到不同的自定义环境中，如开发环境、测试环境等。RELEASE是系统默认的发布环境，也是正式发布环境。 环境变量是指在环境上创建的一种变量，该变量固定在环境上。
调用API 调用API失败的可能原因 调用API报“414 Request URI too large” 调用API报“The API does not exist or has not been published in the environment” 调用API报“No backend
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。 Token认证：通过Token认证调用请求
对象模型 API发布后，如果不想API被某些IP地址访问到，可以将这些IP地址加入黑名单，或者想API被某些特性的IP地址访问到，也可以将这些IP地址加入白名单。这样可以提高API的访问安全性，保护API免受攻击。本节介绍API的黑白名单（ACL策略）管理的对象模型，如表1 ACL
成长地图 | 华为云 API网关 API网关（APIG）是为企业和开发者提供的高性能、高可用、高安全的云原生网关服务，融合安全、负载均衡、流量入口治理、微服务流量治理、运维等多项能力，帮助企业轻松实现API安全开放、API高并发调用和入口流量、微服务流量精细化治理，简单、快速、低成本
APIG的API响应消息头说明 调用API时，API网关增加下表中的响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 X-Request-Id 请求ID。所有合法请求，都会返回此参数。 X-Apig-Latency 从API
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间，监控指标列表和维度定义，用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版：SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
响应消息头 调用API时，API网关增加如下响应消息头。 X-Apig-Mode: debug表示响应消息头增加API网关调试信息。 响应消息头 描述 说明 X-Request-Id 请求ID 所有合法请求，都会返回此参数 X-Apig-Latency 从API网关接收请求到后端返回消息头的用时
创建API的负载通道（可选） 负载通道主要用于将服务通过API网关专享版开放给外部访问。它的优势在于使用VPC的内部子网通信，网络时延更低，同时负载通道具有负载均衡功能（服务器通道类型），以及自动同步服务节点变更的能力（微服务通道类型）和使用已有的负载通道能力（引用负载通道类型），
约束与限制 实例 表1 实例约束与限制 限制项 约束与限制 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”即可。 网络
快速开放并调用API 本章节将为您介绍如何快速使用API网关，这里以APP认证类型的简易认证为例，快速开放并调用API。 图1 APIG使用流程 准备工作 在使用APIG之前，需要确保有可用的网络环境，请提前准备VPC、子网和安全组。 创建实例 创建实例时，根据实际需求选择实例的规格
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎
功能总览 功能总览 全部 API网关 购买API网关 开放API 调用API 导入导出API 自定义认证 API SDK OBS 2.0支持 API网关 API网关（API Gateway）提供高性能、高可用、高安全的API托管服务，能快速将企业服务能力包装成标准API服务，帮助您轻松构建
在CTS事件列表查看云审计事件 操作场景 用户进入云审计服务创建管理类追踪器后，系统开始记录云服务资源的操作。在创建数据类追踪器后，系统开始记录用户对OBS桶中数据的操作。云审计服务管理控制台会保存最近7天的操作记录。 云审计控制台对用户的操作事件日志保留7天，过期自动删除，不支持人工删除
在CTS事件列表查看云审计事件 操作场景 用户进入云审计服务创建管理类追踪器后，系统开始记录云服务资源的操作。在创建数据类追踪器后，系统开始记录用户对OBS桶中数据的操作。云审计服务管理控制台会保存最近7天的操作记录。 云审计控制台对用户的操作事件日志保留7天，过期自动删除，不支持人工删除
API概览 API网关专享版接口的分类与说明如表1所示，API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
