检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查看关键操作列表 通过云审计服务,您可以记录与API网关相关的操作事件,便于日后的查询、审计和回溯。 表1 云审计服务支持的API Gateway操作列表 操作名称 资源类型 事件名称 创建API分组 ApiGroup createApiGroup 删除API分组 ApiGroup
新建一个华为IAM认证方式的API,在配置入参时为什么无法配置HEADER位置的x-auth-token? x-auth-token在API网关内部已经被定义了,如果您再次创建此参数名,容易导致冲突。 API网关控制台中已经限定您无法创建HEADER位置的x-auth-token,
API分组”。 单击分组名称。 在“API运行”页面,选择待授权的API,单击“更多 > 授权”。 单击“添加授权”。 选择API授权环境,查询并勾选凭据后,单击“确定”。在“授权历史”弹窗中展示已授权的凭据。 如果已授权的凭据需要解除授权,在凭据列表中凭据所在行单击“解除授权”。 后续操作
导出API 参数 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。 API定义范围 基础定义:包括API前端请
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。 操作步骤 进入API网关控制台页面。
配置API的插件策略 配置API的跨域资源共享 配置API的响应缓存 配置API的HTTP响应头 配置API的流量控制2.0 配置API的Kafka日志推送 配置API的断路器 配置API的第三方认证 配置API的流量镜像 父主题: 配置API策略
公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。 您也可以使用系统分配的调试域名(子域名)访问API分组内的API,该调试域名唯一且不可修改,每天最多可以访问1000次,仅适用于内部测试使用。 同一实例下的不同分组不能绑定相同的独立域名。 调试域名默认只能在与实例相同VPC内的服务器
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标
克隆APIG的API API网关支持克隆已创建的API,提高API创建效率。您在克隆API时需要自定义API名称和API前端路径。 克隆API暂不支持克隆绑定策略,如果需要绑定策略请手动操作。 前提条件 已创建API,如果未创建API,请通过APIG创建REST API。 操作步骤
取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 plugin_ids 是 Array of strings 绑定的插件编码列表。 数组长度:1 - 500 响应参数
调用已发布的API 调用API 响应消息头 错误码 父主题: 共享版操作指导(仅存量用户使用)
配置API的传统策略 配置API的流量控制 配置API的访问控制 配置API的后端服务签名校验 父主题: 配置API策略
获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 api_ids 是 Array of strings 绑定的API编码列表。 数组长度:1 - 500 响应参数
\"backend_sign_header\":\"back-header\"}" } app_auth_header 请求头中的APP认证的签名信息的头域可以由此处的配置项承载。 - 支持英文、数字、中划线、下划线,以英文开头,3-64个字符,可以为空,不能以x-apig、x-sdk开
LEASE环境,请求X-Stage头的值需要填写发布的环境名称。 API认证鉴权 如果使用APP认证,App Key和Secret是否正确。 API控制策略 访问控制策略是否设置正确。 是否超过了流量控制范围。系统默认的流控策略是单个API的访问不超过200次/秒,如果您未创建流
表1 编排规则配置 参数 说明 规则名称 填写编排规则的名称,根据规划自定义。 编排策略 选择编排策略。 list:列表中的值映射成另外的值。 range:范围中的值映射成另外的值。 hash:请求头的值经过哈希计算后直接映射为新的请求头。 hash_range:先用请求参数生成ha
API的响应码如何定义? API响应码分两种。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考网关响应。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
怎样保护API的调用安全? 使用身份认证 创建API时,为API调用增加身份认证,如使用IAM认证或API网关提供的APP认证,防止API被恶意调用。 设置访问控制策略 从IP地址(或地址区间)以及账号等不同维度,设置白名单/黑名单。 将API绑定流控策略,通过流控策略保护API。
查询实例指定的自定义入方向端口绑定的域名信息 功能介绍 查询实例指定的自定义入方向端口绑定的域名信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-p
在“API运行”页签,选择待调试的API,单击“调试”。 配置URL和API请求参数。 选择请求方法、请求协议、域名等,然后配置API请求参数。 域名可选调试域名或独立域名。当选择的独立域名为泛域名时,需要填写泛域名的子域名。 当独立域名为泛域名时,用户可以通过泛域名的所有子域名访问所绑定分组下的所有API。