检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
info参数说明 名称 是否必选 参数类型 说明 title 是 String API分组名称 version 是 String 版本号,用户输入自定义版本号或者使用默认的当前时间 description 否 String 分组描述信息 表6 paths参数说明 名称 是否必选 参数类型
修改变量 功能介绍 修改环境变量。环境变量引用位置为api的后端服务地址时,修改对应环境变量会将使用该变量的所有api重新发布。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/env-var
批量修改后端服务器状态不可用 功能介绍 批量修改后端服务器状态不可用。 引用负载通道类型的负载通道不支持修改后端服务器状态不可用。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-ch
的DOMAIN对应的acl_value的值为租户名称,而非“www.exampleDomain.com”之类的网络域名。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/acls 表1
APP创建成功后,还不能访问API,如果想要访问某个环境上的API,需要将该API在该环境上授权给APP。授权成功后,APP即可访问该环境上的这个API。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/app-auths
功能介绍 为实例配置需要的特性。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/features
求既可以选择使用Key和Secret做签名和校验,也可以选择使用AppCode进行简易认证。 约束与限制 为了确保安全,简易认证仅支持HTTPS或GRPCS方式调用API,不支持HTTP。 每个凭据最多可创建5个AppCode。 生成AppCode 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。
功能介绍 APP即应用,是一个可以访问API的身份标识。将API授权给APP后,APP即可调用API。 创建一个APP。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/apps 表1
提供用户导出API定义的接口。 导出指定分组指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/openapi?env_id={0}
查询租户配置详情 功能介绍 查询某个租户的配置项及其配置值。 URI 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/config/project[?page_size, page_no, config_id, config_name]
查询自定义认证列表 功能介绍 查询自定义认证列表 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/authorizers[?page_size, page_no, id, name
的一部分。您可以自定义HTTP响应头,在返回的API响应中指定您配置的响应头。 如果此策略在当前实例中不支持,请联系技术支持升级实例到最新版本。 策略参数会明文展示,为防止信息泄露,请谨慎配置。 约束与限制 同一个环境中,一个API只能被一个HTTP响应头策略绑定,但一个HTTP响应头策略可以绑定多个API。
查询自定义认证列表 功能介绍 查询自定义认证列表 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/authorizers[
basic类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。 public_key类型开启实例配置public_key才可使用,实例特性配置详情请参考“附录 > 实例支持的APIG特性”,如确认实例不存在public_key配置可联系技术工程师开启。 aes类型需要实例升级到对应版本,如果不存在可联系技术工程师升级。
成本管理 成本优化 API网关(APIG)专享版提供基础版、专业版、企业版、铂金版等多个实例规格版本,每个规格对应不同的官网价。不同规格差异体现为每秒最大请求数、带宽、内网每秒新建连接数等,详情请参考产品规格。 用户可以根据自己的业务场景选择合适的APIG专享版规格,在此做如下推荐:
将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings
根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/instances/{instance_id}/throttles
能会影响相当一部分应用和用户。请确保已经告知用户,或者确认需要强制下线。 环境上存在已发布的API时,该环境不能被删除。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_id}
使用APIG专享版实现http到https自动重定向操作流程 开启重定向 开启重定向功能的API的前端请求协议必须为“HTTPS”或“HTTP&HTTPS”。 验证重定向 验证重定向功能是否生效。 父主题: 使用APIG专享版实现http到https自动重定向
apig:instances:update - √ √ 查看API网关专享版实例 GET /v2/{project_id}/apigw/instances/{instance_id} apig:instances:get - √ √ 查看API网关专享版实例列表 GET /v2/{pro