检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 env_id 是 String 绑定API的环境编码。 api_ids 是 Array of strings 绑定的API编码列表。 数组长度:1 - 500 响应参数
类型 控制访问API的类型。 IP地址:限制调用API的IP地址。 账号名:仅适用IAM认证类型的API,限制调用API的账号名。仅支持配置账号名,对账号名及账号名下的IAM用户名做限制,不支持配置IAM用户名。 可以配置单账号名或多账号名,多账号名以英文格式下的逗号“,”隔开,账号名支持除英文格式下“
pi_limits”的参数运行值。 策略和API本身相互独立,只有为API绑定策略后,策略才对API生效。为API绑定策略时需指定发布环境,策略只对指定环境上的API生效。 策略的绑定、解绑、更新会实时生效,不需要重新发布API。 API的下线操作不影响策略的绑定关系,再次发布后仍然会带有下线前绑定的策略。
查询编排规则绑定的API 功能介绍 查询指定插件下绑定的API信息 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instan
查询插件下绑定的API 功能介绍 查询指定插件下绑定的API信息。 用于查询指定插件下已经绑定的API列表信息 支持分页返回 支持API名称模糊查询 绑定关系列表中返回的API在对应的环境中可能已经下线 调用方法 请参见如何调用API。 URI GET /v2/{project_
aes-256-cfb Key 根据选择的密钥类型,填写不同的密钥信息。 HMAC:填写APP认证所使用密钥对的Key。 Basic Auth:填写basic认证所使用的用户名。 AES:填写AES认证所使用的密钥key。 Public Key:填写public_key认证所使用的公钥。 Secret
导出APIG的API APIG支持把创建的API以JSON、YAML、YML文件的格式导出,支持导出单个API和批量导出API。 导出API 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。单击分组名称然后单击“导出”。
配置API的跨域资源共享 出于安全性考虑,浏览器会限制从页面脚本内发起的跨域请求,此时页面只能访问当前域的资源。CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参见跨域调用APIG开放的API。 跨域资源共享策略为跨域访问
配置API的断路器 断路器是API网关在后端服务出现性能问题时保护系统的内置机制。当API的后端服务出现连续N次超时或者时延较高的情况下,会触发断路器的降级机制,向API调用方返回固定错误或者将请求转发到指定的降级后端。当后端服务恢复正常后,断路器关闭,请求恢复正常。 如果此策略
高精度流控:高并发场景下实例内部会有一定的性能损耗,适用于并发量较小的场景。 高性能流控:高并发场景下实例内部性能损耗较小,单位时间内会偶现较小的误差值,适用于并发量较大的场景。 单机流控:实例的每个节点各自进行流控,高并发场景下实例内部性能损耗最小,单位时间内会存在一定的误差值,适用于并发量更大的场景。 策略生效范围
认证的API。 方案优势 在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。 约束与限制 API网关支持的自定义认证依赖于函数工作流服务,创建自定义认证前,需要先创建函数。 操作流程 创建函数 创建自定义的前端函数,使用函数服务开发自定义认证。
group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name
否 String 健康检查时的目标路径。protocol = http或https时必选 method 否 String 健康检查时的请求方法 缺省值:GET port 否 Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 如果此端口存在非0值,则使用此端口进行健康检查。
否 String 健康检查时的目标路径。protocol = http或https时必选 method 否 String 健康检查时的请求方法 缺省值:GET port 否 Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 如果此端口存在非0值,则使用此端口进行健康检查。
查询API下绑定的插件 功能介绍 查询指定API下绑定的插件信息。 用于查询指定API下已经绑定的插件列表信息 支持分页返回 支持插件名称模糊查询 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instanc
删除APP的访问控制 功能介绍 删除凭据的访问控制信息。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选
查询实例指定的自定义入方向端口绑定的域名信息 功能介绍 查询实例指定的自定义入方向端口绑定的域名信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-p
设置APP的访问控制 功能介绍 设置凭据的访问控制。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-acl 表1 路径参数 参数 是否必选 参数类型
group_id String API所属分组的编号 group_name String API所属分组的名称 run_env_name String 发布的环境名 run_env_id String 发布的环境id publish_id String API的发布记录编号 signature_name
查看API详情 功能介绍 查看指定的API的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/apis/{id} URI中的参数说明如下表所示。 表2 参数说明 名称