检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Code删除后,将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/apps/{app_id}/app-codes/{id} URI中的参数说明如下表所示。
在同一区域中,可实现云内跨VPC访问/开放API。 图1 同一区域跨VPC访问 约束与限制 目前除墨西哥城一、北京一区域外,其他区域都支持终端节点管理功能。 配置终端节点信息 进入API网关控制台页面。 在左侧导航栏选择“实例管理”。 在已创建的实例上,单击“查看控制台”或实例名称。 单击“终端
FullAccess”。 创建用户并加入用户组 在IAM控制台创建用户,并将其加入1中创建的用户组。 用户登录并验证权限 新创建的用户登录控制台,验证API网关服务的权限。 APIG自定义策略 如果系统预置的API网关权限,不满足您的授权要求,可以创建自定义策略。自定义策略中可以添加的授权项(
如果证书为非pem编码格式,可参考转换证书为PEM格式进行证书格式转换。 如果当前实例不支持配置CA证书,可提交工单升级实例。 单击“确定”。 证书创建完成后,进入API分组页面为独立域名绑定SSL证书(可选)。 转换证书为PEM格式 格式类型 转换方式(通过OpenSSL工具进行转换) CER/CRT
目为单位进行授权,用户可以访问您账号中该区域的所有资源。此处默认为已选择的区域。 函数名称 根据规划自定义名称。 企业项目 企业项目是项目的升级版,针对企业不同项目间资源的分组和管理,是逻辑隔离。此处默认“default”。 委托名称 用户委托函数工作流去访问其他的云服务。此处选择“未使用任何委托”。
API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。 访问某个环境上的API,其实访问的就是其运行时的定义 调用方法 请参见如何调用API。
API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。 访问某个环境上的API,其实访问的就是其运行时的定义 URI HTTP/HTTPS请求方法以及URI如下表所示。
API的定义分为临时定义和运行时定义,分别代表如下含义: 临时定义:API在编辑中的定义,表示用户最后一次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。 访问某个环境上的API,其实访问的就是其运行时的定义 URI HTTP/HTTPS请求方法以及URI如下表所示。
API网关提供的实例版本有:基础版、专业版、企业版、铂金版等,您可以根据实际业务需要按需使用。实例版本说明,请参考产品规格。如果您当前使用的实例版本不能满足需要,API网关支持升级产品版本,例如从“基础版”升级到“专业版”或者铂金版,并且对现有业务没有影响。 实例版本单价,请参考价格详情中的包年/包月计费价格。
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
x-apigateway-access-control 含义:引用访问控制策略。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-access-control:
PC通道,其中ECS 01和ECS 04已添加到VPC通道中,此时API网关通过VPC通道可以直接访问VPC中的ECS 01和ECS 04。 图1 通过API网关访问VPC通道中的ECS 前提条件 已创建云服务器。 用户需要具备VPC Administrator角色权限。 创建快速通道
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
已创建API分组。如果未创建API分组,可在本操作页面中创建API分组。 如果后端服务需要使用VPC通道,请先创建VPC通道,或在本操作页面中创建VPC通道。 设置基本信息 进入共享版控制台。 单击“开放API > API管理”,进入到API列表信息页面。 单击“新建API”,进入“新建API”页面。填写如表1所示信息。
表1 实例信息 可编辑项 说明 基本信息 实例的基本信息,包括实例名称、实例ID、实例规格、可用区、描述、企业项目和时间窗。 用户可以根据实际需要修改基本信息。 用户可以单击“实例ID”右侧的复制实例ID信息。 计费信息 实例的计费模式和创建实例的时间。 网络配置 虚拟私有云 实
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
x-apigateway-access-controls 含义:访问控制策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-access-controls: customAccessControlName: acl-type:
如果API的前后端服务与实例绑定了相同的安全组、相同的虚拟私有云,则无需专门为实例开放上述端口。 创建实例 进入购买实例页面。 根据下表参数说明,配置实例参数。 表1 API网关实例参数说明 参数 说明 计费模式 实例的收费方式,当前支持“按需计费”和“包周期”两种方式。在购买实例后,如果发现
custom_data_log2 用户自定义日志字段值2。 41 custom_data_log3 用户自定义日志字段值3。 42 custom_data_log4 用户自定义日志字段值4。 43 custom_data_log5 用户自定义日志字段值5。 44 custom_data_log6 用户自定义日志字段值6。
删除环境 功能介绍 删除指定的环境。 该操作将导致此API在指定的环境无法被访问,可能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI