检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
使用接口测试工具调用API。 本实践通过IP调用DEFAULT分组下的API,输入“wss://IP地址/hello”发送请求即可。其中,IP地址为APIG控制台“实例信息”中的弹性IP地址。 父主题: 开放API
APIG是否支持多后端节点方案? 支持。 通过VPC通道(负载通道)支持多后端节点,一个VPC通道中可以添加多个云服务器。 关于VPC通道(负载通道)的详细操作,请参考负载通道。 父主题: 开放API
如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP地址,则将此服务的访问方式设置为VPC内
击API的名称进入“API运行”页面,在“前端配置”或“后端配置”区域获取API基本信息。 获取API的认证信息 根据API使用的安全认证方式不同,还要获取相关的请求认证信息: 认证方式 认证信息 APP认证(签名认证) 向API提供者获取该API所授权凭据的Key和Secret,以及认证签名所使用的SDK。
查看可用区信息 功能介绍 查看可用区信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/available-zones 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
热门咨询 开放API API的后端服务是否支持绑定私网ELB地址? API的后端服务地址支持填写私有地址(子网IP)吗? API可以绑定内网域名吗? 调用API 调用API失败的可能原因 调用API报“The API does not exist or has not been published
查看实例约束信息 功能介绍 查看实例约束信息 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/restriction 表1 路径参数 参数 是否必选 参数类型 描述 project_id
获取API的调用信息 在调用API前,您需要向API提供者获取API的调用信息。 获取API的请求信息 在API网关控制台选择“开放API > API管理”,单击API的名称进入“调用信息”页面,可获取API的“域名”、“请求方法”和“请求路径”,以及API的基本信息。 获取API的认证信息
在弹窗中配置策略信息。 表1 绑定访问控制策略 参数 说明 动作 选择访问控制的动作。 允许:表示仅允许指定IP地址的客户端调用API。 禁止:表示禁止指定IP地址的客户端调用API。 IP地址 单击“增加IP地址”,添加允许或禁止调用API的客户端IP地址或IP地址段。 策略配置完成后,单击“确定”。
自定义认证身份来源错误 401 前端自定义认证的身份来源信息缺失或不合法错误 第三方认证配置错误 500 第三方认证方异常,通信失败、返回异常响应等错误 第三方认证失败 401 第三方认证方返回认证失败 第三方认证身份来源错误 401 第三方认证的身份来源信息缺失 认证失败 401 认证失败,IAM或APP认证校验失败
String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1:可用 2:不可用 port Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id String 后端云服务器的编号。
一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。 父主题: 开放API
String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1:可用 2:不可用 port Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id String 后端云服务器的编号。
否 String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。 status 否 Integer 后端服务器状态 1:可用 2:不可用 port 否 Integer 后端服务器端口 最小值:0 最大值:65535 ecs_id 否 String
2:加权最少连接(wleastconn) 3:源地址哈希(source) 4:URI哈希(uri) 缺省值:1 member_type String VPC通道的成员类型。 ip ecs 缺省值:ecs type Integer vpc通道类型,默认为服务器类型。 2:服务器类型 3:微服务类型 当v
Not Implemented 请求未完成。服务器不支持所请求的功能。 502 Bad Gateway 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Service Unavailable 由于服务器临时维护或者过载,服务器当前无法处理请求。 504 Gateway Timeout
跨域资源共享”。 在“创建策略”弹窗中,配置策略信息。 表1 跨域资源共享策略配置 参数 说明 策略名称 填写策略的名称,根据业务规划自定义。建议您按照一定的命名规则填写策略名称,方便您快速识别和查找。 策略类型 固定为“跨域资源共享”。 描述 填写策略的描述信息。 策略内容 策略的配置内容,支持表单配置和脚本配置两种方式。
查看或编辑APIG的API信息 API列表支持查看当前实例下所有的API,包含URL、运行环境、安全认证等信息。 操作步骤 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 您可以管理当前实例下的所有API,支持编辑、发布、调试等操作。 在左侧导航栏选择“API管理
云商店订购信息查询 查询已购买的API分组列表 查询分组详情 查询已购买的API列表 父主题: 共享版API(仅存量用户使用)
API名称 purchase_id String 订购关系编号 remark String API描述 req_uri String API的访问地址 响应消息样例: { "total": 3, "size": 3, "apis": [{ "id": "cb498965-8ac