更新时间:2023-12-13 GMT+08:00

创建实例

本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。

创建的约束说明

创建实例存在一些约束,当您登录后无法创建实例,或者创建失败,请参考以下约束说明进行检查,并解除限制。

  • 实例配额

    同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。

  • 用户权限

    如果您使用系统角色相关权限,需要同时拥有“APIG Administrator”和“VPC Administrator”权限才能创建实例。

    如果您使用系统策略,则拥有“APIG FullAccess”即可。

    如果使用自定义策略,请参考对用户组授权

  • 子网中可用私有地址数量

    API网关专享实例的基础版、专业版、企业版,以及铂金版分别需要3、5、6、7个私有地址。请确保您选择的子网段有足够多的私有地址可用,私有地址可在虚拟私有云服务的控制台查询。

网络环境准备

  • 负载

    虚拟私有云。实例需要配置虚拟私有云(负载),在同一负载中的资源(如ECS),可以使用实例的私有地址调用API。

    在创建实例时,建议配置和您其他关联业务相同负载,确保网络安全的同时,方便网络配置。

    创建实例后,不支持修改虚拟私有云(负载)。

  • 弹性公网IP

    实例的API如果要允许外部调用,则需要创建一个弹性公网IP,并与实例绑定,作为实例的公网入口。

    如果API的后端服务部署在公网,还需要有公网出口访问权限,这由API网关统一规划,不需要单独创建弹性公网IP。

  • 安全组

    安全组类似防火墙,控制谁能访问实例的指定端口,以及控制实例的通信数据流向指定的目的地址。安全组入方向规则建议按需开放地址与端口,这样可以保护实例的网络安全。

    实例绑定的安全组有如下要求:

    • 入方向:如果需要从公网调用API,或从其他安全组内资源调用API,则需要为实例绑定的安全组的入方向放开80(HTTP)、443(HTTPS)两个端口。
    • 出方向:如果后端服务部署在公网,或者其他安全组内,则需要为实例绑定的安全组的出方向放开后端服务地址与API调用端口。
    • 如果API的前后端服务与实例绑定了相同的安全组、相同的虚拟私有云,则无需专门为实例开放上述端口。

操作步骤

  1. 进入API网关控制台页面。
  2. 在左侧导航栏选择“实例管理”。
  1. 单击“创建实例”。根据下表参数说明,配置实例参数。

    表1 API网关实例参数说明

    信息项

    描述

    区域

    指APIG实例部署的区域,建议和您其他的业务部署在相同区域,这样不同的业务可以在负载内以子网方式通信,节省公网带宽成本,降低网络延时。

    可用区

    指同一区域内电力、网络等资源物理隔离的地理区域,一般为互相独立的机房。

    APIG实例支持同时选择多个可用区,进行跨可用区部署,提升实例高可用性。

    APIG不支持跨可用区迁移实例。

    实例名称

    实例的名称,根据规划自定义。

    实例规格

    当前开放基础版、专业版、企业版、铂金版实例。不同实例规格,对API请求的并发支持能力不同,具体请参考《API网关产品介绍》的章节。

    可维护时间窗

    指允许云服务技术支持对实例进行维护的时间段。如果有维护需要,技术支持会提前与您沟通确认。

    建议选择业务量较少的时间段。

    企业项目

    使用企业用户登录时,可选择实例所属企业项目。

    有关企业项目的资源使用、迁移以及用户权限等,请参考《企业管理用户指南》。

    公网入口

    指允许外部服务通过弹性IP地址,调用实例创建的API。开启“公网入口”,需要绑定一个“弹性IP地址”。

    说明:
    • 您需要使用独立域名/调试域名访问,使用调试域名访问时存在单日访问次数限制。可在创建API分组后,为分组绑定独立域名,独立域名需要解析到实例的弹性IP地址。

      例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用https://{domain}/apidemo这个URL访问您的API。其中,{domain}表示已绑定到分组的独立域名,目标端口443可默认缺省。

    公网出口

    指允许实例API的后端服务部署在外部网络,APIG为实例开启公网出口。您可以根据业务预估设置合适的“出公网带宽”,出公网带宽费用按小时计算,以弹性IP服务的价格为准。

    网络

    指为实例绑定到一个虚拟私有云,并为其分配子网。

    在相同虚拟私有云中的云服务资源(如ECS),可以使用APIG实例的私有地址调用API。

    建议将实例和您的其他关联业务配置一个相同的虚拟私有云,确保网络安全的同时,方便网络配置。

    安全组

    安全组用于设置端口访问规则,定义哪些端口允许被外部访问,以及允许访问外部哪些地址与端口。

    例如,后端服务部署在外部网络,则需要设置相应的安全组规则,允许访问后端服务地址与API调用端口。

    说明:

    如果开启公网入口,安全组入方向需要放开80(HTTP)和443(HTTPS)端口的访问权限。

    描述

    实例的描述信息。

  2. 单击“立即创建专享版”,进入实例规格确认页面。
  3. 规格确认无误后,开始创建实例,界面显示创建进度。

后续操作说明

实例创建成功后,您可以开始创建和管理您的API。进入实例控制台后,概览界面展现实例信息、网络配置、配置参数等信息。

其中,实例名称、描述、时间窗、安全组,以及弹性IP地址等可以修改。

如果您要删除实例,请确认无业务影响后删除实例即可。