检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
检测到您已登录华为云国际站账号，为了您更好的体验，建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
x-apigateway-cors 含义：API网关定义的API请求是否支持跨域。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/path': get: x-apigateway-cors:
x-apigateway-backend.httpEndpoints 含义：API网关定义的HTTP类型API后端服务定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces:
x-apigateway-auth-type 含义：基于Swagger的apiKey认证格式，定义API网关支持的特有认证方式。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger： securityDefinitions:
x-apigateway-backend 含义：API网关定义的API后端服务定义。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/users/{userId}': get: produces:
创建APIG实例 本小节指导您顺利创建实例，实例创建完成后，才能创建API并对外提供服务。 约束与限制 实例配额 同一项目ID下，一个主账号默认只能创建5个实例。如果您需要创建更多实例，可提交工单，申请修改配额。 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC
认证鉴权 调用接口有如下两种认证方式，您可以选择其中一种进行认证鉴权。 AK/SK认证：通过AK（Access Key ID）/SK（Secret Access Key）加密调用请求。推荐使用AK/SK认证，其安全性比Token认证要高。 Token认证：通过Token认证调用请求。
x-apigateway-backend.parameters 含义：API网关定义的API后端参数定义。 作用域：x-apigateway-backend 示例： paths: '/users/{userId}': get: produces:
变更APIG的实例规格 当实例规格无法满足您的业务需求时，您可以进行规格变更操作升配到更高规格版本。 约束与限制 规格变更过程中，长连接会发生闪断，需要重新建链，建议业务低峰期进行规格变更。 只能升配到更高规格，无法降配规格。 规格变更时，出私网IP会发生变化，如有相关防火墙配置
x-apigateway-auth-opt 含义：APP简易认证方式参数。 作用域：Security Scheme Object(2.0)/Security Scheme Object(3.0) Swagger示例： securityDefinitions: apig-auth-app:
配置API的调用域名 API分组创建后，系统为分组自动分配一个内部测试用的调试域名，此调试域名每天最多可以访问1000次。因此，在开放API前，您需要为API分组绑定独立域名，用户通过独立域名访问分组内的API。最多可以添加5个独立域名，不限访问次数。 独立域名可分为内网域名和公网域名两种：
在VPC通道中编辑云服务器配置 操作场景 在创建VPC通道后，可以通过编辑云服务器为VPC通道增加/删除云服务器或编辑云服务器的权重。 前提条件 已创建VPC通道。 操作步骤 进入共享版控制台。 单击“开放API > VPC通道”，进入到VPC通道列表页面。 单击“VPC通道名称”，进入VPC通道详情页面。
包年/包月转按需 创建一个包年/包月实例后，您可以将该实例的计费模式转为按需计费，回收部分成本，同时更加灵活地按需使用实例。 包年/包月转按需，需包年/包月计费模式到期后，按需的计费模式才会生效。 前提条件 实例计费模式为“包年/包月”。 操作步骤 方式一：在API网关控制台的实例管理中变更计费模式。
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面，API网关提供IAM认证、APP认证等方式，帮助用户快速开放API，同时API网关也支持用户使用自己的认证方式（以下简称自定义认证），以便更好地兼容已有业务能力。
授权API 操作场景 API在创建后，通过指定授权给某些应用，让指定应用能够调用API。 仅在API发布到环境后，才支持被授权。 仅在API为APP认证时，才支持授权给应用。 前提条件 已创建API分组和分组内的API。 （可选）已创建环境。 已创建应用。 操作步骤 进入共享版控制台。
x-apigateway-backend-policies 含义：API网关定义的API后端策略。 作用域：Operation Object(2.0)/Operation Object(3.0) 示例： paths: '/users/{userId}': get:
约束与限制 实例 表1 实例约束与限制 限制项 约束与限制 用户权限 如果您使用系统角色相关权限，需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。 如果您使用系统策略，则拥有“APIG FullAccess”权限即可。
APIG最佳实践汇总 本文汇总了基于API网关服务（APIG，APIGateway）常见应用场景的操作实践，为每个实践提供详细的方案描述和操作指导，帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎（Cloud
创建用户并授权使用APIG 如果您需要对您所拥有的API网关服务进行权限管理，您可以使用统一身份认证服务（Identity and Access Management，简称IAM），通过IAM，您可以： 根据企业的业务组织，在您的华为云账号中，给企业中不同职能部门的员工创建IAM
AK/SK认证 使用AK（Access Key ID）、SK（Secret Access Key）对请求进行签名。 AK：访问密钥ID。与私有访问密钥关联的唯一标识符，访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。
权限管理 如果您需要对华为云上购买的API网关（API Gateway）资源，给企业中的员工设置不同的访问权限，以达到不同员工之间的权限隔离，您可以使用统一身份认证服务（Identity and Access Management，简称IAM）进行精细的权限管理。该服务提供用户身
长按/截图保存，微信识别二维码
或者关注公众号“华为云”
