检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
因此,要开放API对外提供服务,首先需要创建实例。 实例创建完成后,您可以通过配置实例参数调整组件的相关功能,配置APIG实例标签分组标记实例资源,配置APIG的终端节点信息连接终端节点服务,更多配置操作请参考管理APIG实例章节。 开放API 将成熟的业务能力(如服务、数据等)
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4 throttle_specials参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String
Peering对等连接,打通VPC1和VPC2。 配置路由 在API专享版实例上配置路由,配置IP为购买ELB所在VPC2网段。 创建API 创建API,后端服务地址配置ELB的IP。 创建ECS 选择VPC2为其VPC,并在其上部署后端应用服务,创建Elastic Cloud Server(应用服务器)。
throttle_specials 字典数据类型 本次查询返回的特殊配置列表 total Integer 符合条件的特殊设置总数 size Integer 本次查询返回的列表长度 表4 throttle_specials参数说明 参数 类型 说明 id String 特殊配置的编号 strategy_id String
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
管理APIG实例 查看或编辑APIG实例信息 配置APIG实例参数 配置APIG实例标签 配置APIG的终端节点信息 自定义APIG的客户端访问端口 变更APIG实例规格
当API的请求协议为GRPC类型时不支持配置。 result_failure_sample 否 String 失败返回示例,描述API的异常返回信息。字符长度不超过20480 说明: 中文字符必须为UTF-8或者unicode编码。 当API的请求协议为GRPC类型时不支持配置。 authorizer_id
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API列表”。 单击“创建API > 创建API”,配置前端信息。 表1 前端配置 参数 配置说明 API名称 填写API名称,建议您按照一定的命名规则填写,方便您快速识别和查找。例如“API01”。 所属分组 默认“DEFAULT”。
删除签名密钥 功能介绍 删除指定的签名密钥,删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id}
导入,界面可预览待导入API内容。 图2 导入参数 (可选)修改待导入API的全局配置。 您可以修改全局配置,如前后端的请求配置,也可以修改具体的接口配置。 图3 修改全局配置 图4 修改接口配置 单击“快速上线”,完成API导入。 导入的API不会自动发布到环境,需要您手动发布。
进入API网关控制台,在左侧导航栏上方选择实例。 在左侧导航栏中选择“API管理 > API策略”。 在“负载通道”页签中单击“创建负载通道”。 基本信息配置。 表1 基本信息配置 参数 配置说明 通道名称 填写负载通道名称,根据规划自定义。建议您按照一定的命名规则填写负载通道名称,方便您快速识别和查找。此处填写“VPC_demo”。
根据下表参数信息,配置安全配置。 表4 定义API请求 参数 配置说明 安全认证 选择API认证方式,此处选择“APP认证”。 支持简易认证 简易认证不需要对请求内容签名,API网关也仅校验AppCode,不校验请求签名,从而实现快速响应。此处勾选简易认证。 单击“下一步”,配置默认后端信息。
页签中获取AppCode。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 构造API请求,示例如下: POST https://{Address}/{Path}
http时必选 enable_client_ssl 否 Boolean 是否开启双向认证。如果开启,则使用实例配置中的backend_client_certificate配置项的证书 缺省值:false status 否 Integer 健康检查状态 1:可用 2:不可用 timeout
仅在用户后端服务所在的VPC下能够解析。 解决方法 方法一:在创建API时,使用公网域名配置“后端服务地址”。 方法二:在创建API时,不使用VPC通道(负载通道),使用用户后端服务IP配置“后端服务地址”,添加常量参数,在HEADER中添加Host:域名字段。 方法三:在创建API时,使用VPC通道(负载通道)。
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
区域中获取AppCode。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 API调用支持长连接。但是需要适当使用长连接,避免占用太多资源。 构造API请求,示例如下:
VPC通道 创建VPC通道 删除VPC通道 编辑健康检查配置 在VPC通道中编辑云服务器配置 父主题: 共享版操作指导(仅存量用户使用)
在“API运行”页面,单击“创建API > 创建GRPC API”。 配置前端定义请参考5.a。 GRPC API前端定义的“请求方法”和“请求协议”默认为“POST”和“GRPCS”。 GRPC API前端定义的“路径”需要根据实际业务从以下三种配置方式中选择配置: / /{包名}.{服务名} /{包名}