检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 分组的编号
对象模型 API需要绑定ACL策略,ACL策略才能够对API起到保护作用。本节介绍ACL策略与API的绑定关系的对象模型,如表1所示。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。
API分组是同一种业务API的集合,API开发者以API分组为单位,管理分组内的所有API。 环境 为了方便管理API的生命周期,API网关定义了API受限使用范围,这个受限使用的范围,称为环境,例如API的测试环境,开发环境等。 环境定义了API生命周期管理过程中的不同状态,API可以被发布到不同的自定义环境中。
符合条件的API总数 size Integer 本次查询返回的列表长度 apis 字典数据类型 本次查询到的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 group_id String API所属分组的编号
专享版API(V2) 专享版-API分组管理 专享版-环境管理 专享版-环境变量管理 专享版-流控策略管理 专享版-API管理 专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理
APIG最佳实践汇总 本文汇总了基于API网关服务(APIG,APIGateway)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松构建基于APIG的业务。 表1 APIG最佳实践一览表 最佳实践 说明 使用APIG专享版开放云容器引擎CCE工作负载 云容器引擎(Cloud
专享版-API绑定ACL策略 将API与ACL策略进行绑定 解除API与ACL策略的绑定 批量解除API与ACL策略的绑定 查看ACL策略绑定的API列表 查看ACL策略未绑定的API列表 查看API绑定的ACL策略列表 父主题: 专享版API(V2)
专享版-API分组管理 创建API分组 修改API分组 删除API分组 查询分组详情 查询分组列表 校验API分组名称是否存在 父主题: 专享版API(V2)
解除绑定插件的API 功能介绍 解除绑定在插件上的API。 解绑及时生效 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/detach 表1 路径参数
安全 责任共担 身份认证与访问控制 数据保护技术 审计与日志 监控安全风险 认证证书
错误码 当您调用API时,如果遇到“APIGW”开头的错误码,请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 204 APIG.0000 Successful 请求成功 无 400 APIC.7211 Parameter
ratelimit_api_limits API全局默认流控值,默认值为200次/秒。API未绑定流控策略时,执行此默认流控;API绑定流控策略时,则执行绑定的流控策略。流控策略的API流量限制值不能超过API全局默认流控值。 request_body_size API请求中允许携带的
功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
解除绑定API的插件 功能介绍 解除绑定在API上的插件。 解绑及时生效 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id}/plugins/detach 表1
云商店订购信息查询 查询已购买的API分组列表 查询分组详情 查询已购买的API列表 父主题: 共享版API(仅存量用户使用)
Integer 满足查询条件的API总数 size Integer 本次查询返回的API个数 apis 字典数据类型 本次查询返回的API列表 表4 apis参数说明 参数 类型 说明 id String API编号 name String API名称 purchase_id String
String 解除绑定失败的错误码 error_msg String 解除绑定失败的错误信息 api_id String 解除绑定失败的API的ID api_name String 解除绑定失败的API的名称 响应消息样例: { "failure": [{ "bind_id": "
将API与ACL策略进行绑定 功能介绍 将API与ACL策略进行绑定。 同一个API发布到不同的环境可以绑定不同的ACL策略;一个API在发布到特定环境后只能绑定一个同一种类型的ACL策略。 URI HTTPS请求方法以及URI如下表所示。 表1 HTTPS请求方法以及URI 请求方法
API调用对请求的响应消息体限制 API调用对请求的响应体大小没有限制。 API调用对请求的请求体大小有限制。详细指导请参考request_body_size。 父主题: 调用API
配置API的后端自定义认证 如果您需要把自己的认证系统用于API调用的认证鉴权,可以使用自定义认证来实现。 自定义认证包括前端和后端两种类型: 前端自定义认证:指APIG使用自定义的认证函数,对收到的API请求进行安全认证。 后端自定义认证:指API的后端服务使用自定义的认证函数