检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
env_id 是 String 需要授权的环境编号 app_ids 是 Array of strings APP的编号列表 api_ids 是 Array of strings API的编号列表,可以选择租户自己的API,也可以选择从云商店上购买的API。 响应参数 状态码: 201
签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。 签名密钥是由一对Key和Secret组成,签名密钥需要绑定到API才能生效。当签名密钥绑定API后,API网关向后端服务发送此API的请求时,会增加相应的签名信息,此时需要后端服务依照同样
URE: 前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE: 后端不可用,网络不可达错误 BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED:
删除APP Code 功能介绍 删除App Code,App Code删除后,将无法再通过简易认证访问对应的API。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{
String 导入成功的API编号 表6 Failure 参数 参数类型 描述 path String API请求路径 error_msg String 导入失败的错误信息 method String API请求方法 error_code String 导入失败的错误码 表7 Swagger
variable_name String 变量名,支持英文字母、数字、英文格式的下划线、中划线,必须以英文字母开头,3~32个字符。在API定义中等于#Name的值#部分(区分大小写),发布到环境里的API被变量值替换。 说明: 中文字符必须为UTF-8或者unicode编码。 id
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
String API所属分组的名称 api_type Integer API类型 sign_id String 签名密钥的编号 sign_name String 签名密钥的名称 sign_key String 签名密钥的key sign_secret String 签名密钥的密钥 env_id
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/a
、应用(凭据)的请求频率和源IP的请求频率的管控,用于保障后端服务的稳定运行。 针对API调用path、query、header等参数精细化配置不同的流量的限制。 流量控制的时间单位可以是秒、分钟、小时或天。 针对特殊的应用(凭据)和租户设置特殊的流控限制。 监控告警 提供实时、
将签名密钥绑定到API后,则API网关请求后端服务时就会使用这个签名密钥进行加密签名,后端服务可以校验这个签名来验证请求来源。 将指定的签名密钥绑定到一个或多个已发布的API上。同一个API发布到不同的环境可以绑定不同的签名密钥;一个API在发布到特定环境后只能绑定一个签名密钥。 调用方法 请参见如何调用API。 URI
call_limits Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 暂不支持 time_interval Integer 流控时长 暂不支持 time_unit String 流控的时间单位 暂不支持 is_default Integer
查询单个实例标签 功能介绍 查询单个实例的标签。 接口约束 使用策略授权用户时,需要包含apig:instanceTags:list、apig:instances:get的授权项才允许调用此接口 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
认证的API。 方案优势 在API网关提供的安全认证模式下,用户可根据业务需求,灵活实现自定义认证,保障API的安全性。 约束与限制 API网关支持的自定义认证依赖于函数工作流服务,创建自定义认证前,需要先创建函数。 操作流程 创建函数 创建自定义的前端函数,使用函数服务开发自定义认证。
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号 member_id 是 String 后端实例对象的编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述
API网关专享实例的基础版、专业版、企业版,以及铂金版分别需要3、5、6、7个私有地址。在铂金版的基础上,铂金版X依次增加4个私有地址。例如,铂金版x2需要11个私有地址,铂金版x4需要19个私有地址。请确保您选择的子网段有足够多的私有地址可用,私有地址可在虚拟私有云服务的控制台查询。
查看实例特性列表 功能介绍 查看实例特性列表。注意:实例不支持以下特性的需要联系技术支持升级实例版本。 支持配置的特性列表及特性配置示例请参考本手册中的“附录 > 实例支持的APIG特性”章节。 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/
dev:开发定义,包括未发布的api的前后端定义 缺省值:spec type 否 String 导出的API定义的格式 缺省值:json version 否 String 导出的API定义版本,默认为当前时间 apis 否 Array of strings 导出的API ID列表 响应参数
在APIG中创建VPC通道后端服务器组,VPC通道后端实例可以选择是否关联后端实例服务器组,以便管理后端服务器节点。 如果指定名称的后端服务器组已存在,则更新对应后端服务器组信息。如果请求体中包含多个重复名称的后端服务器定义,则使用第一个定义。 调用方法 请参见如何调用API。 URI POST /v2/{p
否 String 健康检查时的目标路径。protocol = http或https时必选 method 否 String 健康检查时的请求方法 缺省值:GET port 否 Integer 健康检查的目标端口,缺少或port = 0时为VPC中主机的端口号。 如果此端口存在非0值,则使用此端口进行健康检查。