检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
创建APIG实例 本小节指导您顺利创建实例,实例创建完成后,才能创建API并对外提供服务。 约束说明 创建实例存在一些约束,当您登录后无法创建实例,或者创建失败,请参考以下约束说明进行检查,并解除限制。 实例配额 同一项目ID下,一个主账号默认只能创建5个实例。如果您需要创建更多实例,可提交工单,申请修改配额。
01和ECS 04已添加到VPC通道中,此时API网关通过VPC通道可以直接访问VPC中的ECS 01和ECS 04。 图1 通过API网关访问VPC通道中的ECS 前提条件 已创建云服务器。 用户需要具备VPC Administrator角色权限。 创建快速通道 进入共享版控制台。
次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。 访问某个环境上的API,其实访问的就是其运行时的定义 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
次编辑后的API的状态 运行时定义:API在发布到某个环境时,对发布时的API的临时定义进行快照,固化出来的API的状态。 访问某个环境上的API,其实访问的就是其运行时的定义 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/ins
x-apigateway-access-controls 含义:访问控制策略名称与关联策略映射。 作用域:Swagger Object 示例: x-apigateway-access-controls: customAccessControlName: acl-type:
授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法
参数说明 参数 是否必选 类型 说明 acl-type 是 String 访问控制行为,支持PERMIT、DENY entity-type 是 String 访问控制对象,仅支持IP value 是 String 访问控制策略值,多个值以“,”间隔 父主题: APIG的API设计文件扩展定义
API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。 对外开放API时,您需要为API分组绑定您自己的独立域名。 后续操作 API分组创建成功后,您可以为此分组绑定域名,API调用者通过访问独立域名来调用您开放的API。 父主题: API分组管理
怎样给指定的用户开放API? 可以采用以下两种方式: 创建API时可选取APP认证方式,APP key和APP Secret分享给指定的用户。 使用访问控制策略,按照IP地址或者账号名,只允许符合允许策略的用户调用API。 父主题: API策略
删除App Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/
API网关控制台提供的调试功能,用的是特定的debug环境,调试完成后需先发布到对应环境,之后可使用代码或者postman等工具,并添加请求消息头X-Stage,才能访问指定环境。 父主题: 发布API
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP地址,则将此服务的访问方式设置为VPC内网访问,在API网关中创建API时,通过VPC通道访问部署在VPC内的此服务。创建VPC通道和API的详细步骤请参见创建负载通道和创建API。 父主题: 开放API
创建APP 功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/apps
删除APP Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{
近1小时数据每2分钟刷新一次。 近6小时数据每2小时刷新一次。 近一天数据每2小时刷新一次。 近一周和近一月数据每天刷新一次。 如果需要查看实例、实例节点的监控信息,请单击“查看更多监控”,查看更多的监控数据。 监控数据保留周期为两天,如果需要长时间保留,需要配置OBS桶,将监控数据保
下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。
如您仍有业务通过该连接进行访问,拒绝已建立的连接可能导致业务受损,请谨慎操作。 权限管理 权限管理用于控制是否允许跨租户的终端节点进行访问。可以设置允许连接该终端节点服务的授权账号ID,将授权账号ID添加至终端节点服务的白名单中。 单击“添加白名单记录”,填写账号ID。 授权账号ID:连接访问终端节点的授权账号ID。
API可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。 创建API的负载通道(可选) 通过创建负载通道,可访问指定服务器中已部署的后端服务。 创建API 把已有后端服务封装为标准RESTFul