检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
Boolean 是否备用节点。 开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能,如果不支持请联系技术支持。 缺省值:false member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 否
断路器策略是API网关在后端服务出现性能问题时保护系统的机制,支持通过熔断降级的方式保护后端服务。 身份认证策略支持通过AKSK、Token等多种方式进行服务认证,支持用户通过函数自定义API访问认证逻辑,支持对后端服务进行证书校验,支持签名密钥用于后端服务验证API网关的身份。 VPC通道(负载通道)
HTTP查询请求,称为预检请求。浏览器询问服务器,当前页面所在的源是否在服务器的许可名单之中,以及可以使用哪些HTTP请求方法和头信息字段。预检通过后,浏览器向服务器发送简单请求。 开启跨域访问 API网关默认不开启跨域访问,如果您需要开启,请参考以下说明完成跨域配置。 简单请求的跨域访问
Integer 是否包含特殊流控配置: 1:包含 2:不包含 type Integer 流控策略的类型,取值如下: 1 独享 2 共享 bind_num Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控: TRUE
Integer 是否包含特殊流控配置: 1:包含 2:不包含 type Integer 流控策略的类型,取值如下: 1 独享 2 共享 bind_num Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控: TRUE
Boolean 是否备用节点。 开启后对应后端服务为备用节点,仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能,如果不支持请联系技术支持。 缺省值:false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
工作负载类型的介绍请参考工作负载概述。 服务标识名 选择工作负载的Pod标签,通过Pod标签指定某个工作负载。服务标识名为Pod标签的键,服务标识值为Pod标签的值。 Pod标签相关内容指导,请参考设置标签与注解。 服务标识值 标签 选择工作负载的Pod标签。如果服务标识名和服务标识值不唯一,且不能
表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。 instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 表2 Query参数 参数 是否必选 参数类型 描述 offset
删除自定义认证 操作场景 当自定义的认证已不再需要时,可以删除自定义认证。 自定义认证依赖函数工作流服务。如果当前Region没有上线函数工作流服务,则不支持使用自定义认证。 已在API中使用的自定义认证无法被删除。 前提条件 已创建自定义认证。 操作步骤 进入共享版控制台。 在“开放API
身份认证,您只需要按照API提供者提供的接口说明,封装规范的HTTP请求,发送给API网关即可。 无认证方式下,API网关把请求内容透传给后端服务。因此,如果您希望在API后端服务进行鉴权,可以使用“无认证”方式,API调用方传递鉴权所需字段给后端服务,由后端服务进行鉴权。 父主题:
请求进行加密签名,可标识发送方,并防止请求被修改。 发送API请求时,需要将当前时间置于请求消息头的X-Sdk-Date,将签名信息置于请求消息头的Authorization。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网
certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数
”。 单击“完成”,完成创建API。 调试API 为了方便观察,在创建策略后端时后端服务类型选择“Mock”,并且设置Mock返回结果。如果策略后端的后端服务类型为其他,可以观察对应的后端地址是否被成功访问。 在“API运行”页面单击“调试”,调试已创建的API。 响应结果中显示“200
环境是指API的受限使用范围,API只有在发布到环境后,才能被调用。API可以被发布到不同的自定义环境中,如开发环境、测试环境等。RELEASE是系统默认的发布环境,也是正式发布环境。 环境变量是指在环境上创建的一种变量,该变量固定在环境上。如果API的后端服务信息中定义了环境变量,则需要在环境中添加对应的变量
Integer 是否包含特殊流控配置: 1:包含 2:不包含 type Integer 流控策略的类型,取值如下: 1 独享 2 共享 bind_num Integer 流控绑定的API数量 enable_adaptive_control String 是否开启动态流控: TRUE
Administrator API网关服务的管理员权限。拥有该权限的用户可以使用API网关服务的所有功能。 系统角色 如果在操作过程中涉及其他服务资源的创建、删除、变更等,则还需要在同项目中勾选对应服务的Administrator权限。 APIG FullAccess API网关服务所有权限。拥有该权
后端自定义认证:当不同的后端服务使用不同的认证系统时,导致您需要为不同的认证系统定制化开发API,而APIG通过自定义认证功能,将多种认证系统集成,简化API开发的复杂度。您只需要在APIG中创建自定义的函数认证,APIG通过此函数对接后端认证系统,获取后端服务的访问授权。 自定义认证
API分组管理 创建API分组 绑定域名 删除分组 新增网关响应 父主题: 共享版操作指导(仅存量用户使用)
授权 功能介绍 APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法