检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
自定义认证 创建自定义认证 删除自定义认证 父主题: 共享版操作指导(仅存量用户使用)
API的响应码如何定义? API响应码分两种类型。 一种是网关响应码。当请求到达网关时,由于API的流量控制、访问控制策略以及认证失败,网关直接返回的响应信息。有关网关响应的详细指导,请参考自定义API的错误响应信息。 一种是后端服务响应。响应信息由后端API服务(即API的提供者)定义,API网关只做透传。
define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间 type 否 String 导出的API定义的格式:json/yaml,默认为json
SSL证书绑定域名 功能介绍 SSL证书绑定域名。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certifi
删除实例指定的自定义入方向端口 功能介绍 删除实例指定的自定义入方向端口,不包含默认端口80和443。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/custom-ingres
define 否 String 导出API的定义范围: base:基础定义 full:全量定义 all:扩展定义 默认为base version 否 String 导出的API定义版本,默认为当前时间 type 否 String 导出的API定义的格式:json/yaml,默认为json
IngressPortInfo objects 实例自定义入方向端口列表。 表5 IngressPortInfo 参数 参数类型 描述 protocol String 实例自定义入方向端口协议。 HTTP:实例自定义入方向端口使用HTTP协议。 HTTPS:实例自定义入方向端口使用HTTPS协议。 ingress_port
总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、“_”、“-”组成,且只能以英文开头。 说明: 需要服从URI规范。 timeout 否 Integer API网关请求后端服务的超时时间,最大60000,最小为1 单位:毫秒
查询实例指定的自定义入方向端口绑定的域名信息 功能介绍 查询实例指定的自定义入方向端口绑定的域名信息。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/apigw/instances/{instance_id}/custom-ingress-p
APP授权管理 环境管理 环境变量管理 流控策略管理 API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理 VPC通道管理 监控信息查询 OpenAPI接口 自定义认证管理
swaggerImportApiToExistGroup 导出全部自定义后端 Swagger SwaggerExportLdApi 导入自定义后端 Swagger SwaggerImportLdApi 创建自定义认证 Authorizer createAuthorizer 删除自定义认证 Authorizer deleteAuthorizer
自定义认证管理 创建自定义认证 修改自定义认证 删除自定义认证 查看自定义认证详情 查询自定义认证列表 父主题: 共享版API(仅存量用户使用)
应用访问次数限制。 ip-limit 否 Number 源IP访问次数限制。 interval 是 Number 流控策略时间周期。 unit 是 String 流控策略时间周期单位,支持SECOND、MINUTE、HOUR、DAY。 shared 否 Boolean 是否共享流控策略。
x-apigateway-cors 含义:API网关定义的API请求是否支持跨域。 作用域:Operation Object(2.0)/Operation Object(3.0) 示例: paths: '/path': get: x-apigateway-cors:
缺省值:V1。 retry_attempts 否 Number 重试次数。 timeout 否 Number 超时时间。 ttl 否 Number 缓存时间。 type 是 String 自定义认证类型。 FRONTEND:前端 BACKEND:后端 表2 Identity 参数 是否必选 类型
APIG的API设计文件扩展定义 x-apigateway-auth-type x-apigateway-request-type x-apigateway-match-mode x-apigateway-cors x-apigateway-is-send-fg-body-base64
专享版API(V1)(待下线) 使用限制 API分组管理(待下线) API管理(待下线) APP管理(待下线) APP授权管理(待下线) 环境管理(待下线) 环境变量管理(待下线) 流控策略管理(待下线) API绑定流控策略(待下线) 设置特殊流控(待下线) ACL策略管理(待下线) API绑定ACL策略(待下线)
总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、“_”、“-”组成,且只能以英文开头。 说明: 需要服从URI规范。 timeout 否 Integer API网关请求后端服务的超时时间,最大60000,最小为1 单位:毫秒
x-apigateway-backend.functionEndpoints 含义:API网关定义的FUNCTION类型API后端服务定义。 作用域:x-apigateway-backend 示例: paths: '/users/{userId}': get:
tUserInfo/{userId},支持 * / %- _ .等特殊字符,总长度不超过512,且满足URI规范。 支持环境变量,使用环境变量时,每个变量名的长度为3 ~ 32位的字符串,字符串由英文字母、数字、中划线、下划线组成,且只能以英文开头。 说明: 需要服从URI规范。