检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
正常响应示例,描述API的正常返回信息 表11 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
、应用(凭据)的请求频率和源IP的请求频率的管控,用于保障后端服务的稳定运行。 针对API调用path、query、header等参数精细化配置不同的流量的限制。 流量控制的时间单位可以是秒、分钟、小时或天。 针对特殊的应用(凭据)和租户设置特殊的流控限制。 监控告警 提供实时、
查看APIG的监控指标 云监控对API网关的运行状态进行日常监控,可以通过控制台直观的查看API网关各项监控指标。 查看单个API的监控指标 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API分组”。 单击分组名称,进入“分组信息”页面。
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。
API管理(待下线) APP管理(待下线) APP授权管理(待下线) 环境管理(待下线) 环境变量管理(待下线) 流控策略管理(待下线) API绑定流控策略(待下线) 设置特殊流控(待下线) ACL策略管理(待下线) API绑定ACL策略(待下线) 概要查询(待下线) 签名密钥管理(待下线)
URE: 前端自定义认证的身份来源信息缺失或不合法错误 BACKEND_UNAVAILABLE: 后端不可用,网络不可达错误 BACKEND_TIMEOUT: 后端超时,与后端的网络交互超过预配置的时间错误 THROTTLED: API调用次数超出所配置的流量策略阈值 UNAUTHORIZED:
完成企业内部系统的解耦及前后端分离。同时,复用已有能力,避免重复开发造成的资源浪费。 企业能力开放 当今企业面临巨大的挑战,企业的发展需要依赖外部合作伙伴的能力,典型的例子如使用第三方平台支付、合作方账户登录等。通过API网关将企业内部服务能力以标准API的形式开放给合作伙伴,与
Integer 流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains 字典数据类型 分组上绑定的独立域名列表 on_sell_status
查看分组详情 功能介绍 查询指定分组的详细信息。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/api-groups/{id} URI中的参数说明如下表所示。 表2 参数说明
绑定流控策略 功能介绍 将流控策略应用于API,则所有对该API的访问将会受到该流控策略的限制。当一定时间内的访问次数超过流控策略设置的API最大访问次数限制后,后续的访问将会被拒绝,从而能够较好的保护后端API免受异常流量的冲击,保障服务的稳定运行。 为指定的API绑定流控策略,绑定时,需要指定在哪个环境上生效。
工作负载中的实例地址,动态监测工作负载下实例IP地址变化。开放API时使用负载通道访问后端服务,通过API的形式将云容器应用的服务能力开放出来。 方式二 一键式导入CCE工作负载,自动生成API和负载通道,API与相应生成的负载通道绑定,动态监测工作负载下实例IP地址变化。通过A
对象模型 本节介绍API及后端服务的对象模型。 “操作类型”用于描述字段的属性,表示对应字段的值可进行的操作: C:创建;U:更新;R:读取。 “是否必选”列表示对于“操作类型”为“C”的创建操作,对应字段是否为必选字段。 表1 API对象模型 参数 类型 说明 操作类型 是否必选
导入成功的API编号id、API请求方法method、API请求路径path、导入行为action(枚举值,update表示更新API,create表示新建API)。failure数组元素中包括4个字段,API请求方法method、API请求路径path、导入失败的错误码err
String 分组版本 V1:全局分组 V2:应用级分组 V2暂不支持,默认为V1 roma_app_id String 分组归属的集成应用编号。 分组版本V2时必填。 暂不支持 roma_app_name String 分组归属的集成应用名称 暂不支持 表5 UrlDomain 参数
正常响应示例,描述API的正常返回信息 表10 security参数说明 名称 是否必选 参数类型 说明 apig-auth-type 否 Object API的认证类型对象数组定义,为空数组 apig-auth-type支持: APP认证: apig-auth-app IAM认证:apig-auth-iam
解除API与ACL策略的绑定 功能介绍 解除某条API与ACL策略的绑定关系 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/{acl_bindings_id}
对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
I在指定的环境无法被访问,请确保已经告知使用此API的用户后,选择待下线的API,单击“下线”即可。 查看API的发布历史 在“API运行”页面,选择待查看发布历史的API。 单击“更多 > 发布历史”。 在版本所在行,单击“查看版本”,弹出此版本详细信息对话框。 查看API基本
查看ACL策略详情 功能介绍 查询指定ACL策略的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1.0/apigw/acls/{id} URI中的参数说明如下表所示。 表2 参数说明
查看ACL策略详情 功能介绍 查询指定ACL策略的详情。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI GET /v1/{project_id}/apigw/instances/{instance_id}/acls/{id}