正在生成
详细信息:
检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用前,请先了解前提条件。 配置参数说明 表1 配置参数说明 参数 说明 负载通道 是否使用负载通道作为第三方接口的鉴权服务。 选择“使用”时,配置鉴权服务的负载通道。 选择“不使用”时,配置鉴权服务的访问地址。 后端URL 请求方法 支持GET、POST、PUT、HEAD请求方法。 请求协议
您需保证当前实例与微服务实例地址网络可达,否则导入后调用API会出现失败场景。 未选择服务契约时,导入后会生成一个请求方法为ANY、请求路径为/且匹配模式为前缀匹配的API。 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测微服务下所有在线实例的地址变化,并更新到负载通道中。
API网关的后端服务有3类部署形态: 后端服务部署在虚拟私有云(以下简称VPC)中,仅支持私有地址访问。 可在API网关创建VPC通道,利用VPC通道,打通API网关与虚拟私有云的网络路由。 后端服务部署在公网环境中,即可以直接通过公网地址访问。 后端服务部署在本地数据中心,且不能通过公网地址直接访问。
String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1:可用 2:不可用 枚举值: 1 2 port Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id String
例如,VPC中包含6台ECS,已创建一条VPC通道,其中ECS 01和ECS 04已添加到VPC通道中,此时API网关通过VPC通道可以直接访问VPC中的ECS 01和ECS 04。 图1 通过API网关访问VPC通道中的ECS 前提条件 已创建云服务器。 用户需要具备VPC Administrator角色权限。
在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1.0/apigw/vpc-channels
在“域名管理”区域,单击“绑定独立域名”,并在弹窗中配置域名信息。 表1 独立域名配置 参数 说明 域名 填写要绑定的域名。 支持最小TLS版本 选择域名访问所使用的最小TLS版本,TLS1.1或TLS1.2,推荐使用TLS1.2。 该配置仅对HTTPS生效,不影响HTTP或者其他访问方式。您可以在配置参数页面通过“
前提条件 已启用入口地址或出口地址。入口地址或出口地址可在实例信息中查看。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“监控分析 > 带宽监控”。 根据下表,配置监控信息。 表1 监控信息 参数 配置项 带宽IP 带宽IP为
Timeout 请求超出了服务器的等待时间。 409 Conflict 由于和被请求的资源的当前状态之间存在冲突,请求无法完成。 410 Gone 被请求的资源在服务器上已经不再可用,并且没有任何已知的转发地址。 412 Precondition Failed 服务器在验证在请求的头字段
修改APIG实例参数“backend_timeout”后未生效。 可能原因 在“定义后端服务”中,“后端超时(ms)”未修改。 解决方法 登录控制台,进入目标API详情,单击“编辑”,在“定义后端服务”中配置“后端超时(ms)”。 父主题: API调用
通过浏览器采用https协议调用API。 在浏览器的地址栏中输入“https://API请求路径”后回车。 在键盘上按F12。 在“网络”页签中状态码显示“200”表示调用成功。 通过浏览器采用http协议调用API。 在浏览器的地址栏中输入“http://API请求路径”后回车。 在键盘上按F12。
req_param_location String 关联的请求参数对象位置 表28 VpcInfo 参数 参数类型 描述 ecs_id String 云服务器ID ecs_name String 云服务器名称 cascade_flag Boolean 是否使用级联方式 暂不支持 vpc_channel_proxy_host
return json.dumps(resp) 配置测试事件并调试代码,然后部署。 在下拉框中选择“配置测试事件”并配置。 测试事件的参数值与环境变量中的参数值保持一致。 创建测试事件完成后,单击“测试”调试代码。 单击“部署”。 进入API网关控制台,在左侧导航栏选择“API管理
无认证:无需认证信息。 调用API 本章节仅提供请求地址和认证参数的配置指导,客户端的其他参数配置需要用户自行调整,如超时配置、SSL配置等。如果客户端参数配置错误会导致业务受损,建议参考业界标准进行配置。 配置请求地址相关参数。 API调用场景 API请求参数配置 使用域名调用API 使用服务分配
String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1:可用 2:不可用 枚举值: 1 2 port Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id String
Peering对等连接,打通VPC1和VPC2。 配置路由 在API专享版实例上配置路由,配置IP为购买ELB所在VPC2网段。 创建API 创建API,后端服务地址配置ELB的IP。 创建ECS 选择VPC2为其VPC,并在其上部署后端应用服务,创建Elastic Cloud Server(应用服务器)。 调试API
在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST /v1/{p
删除签名密钥 功能介绍 删除指定的签名密钥。 删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1.0/apigw/signs/{id}
删除签名密钥 功能介绍 删除指定的签名密钥。 删除签名密钥时,其配置的绑定关系会一并删除,相应的签名密钥会失效。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI DELETE /v1/{project_id}/
API网关是否支持多后端节点方案? 支持。 通过VPC通道(负载通道)支持多后端节点,一个VPC通道中可以添加多个云服务器。 关于VPC通道(负载通道)的详细操作,请参考负载通道。 父主题: API创建