检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如果您需要对您所拥有的API网关服务进行精细的权限管理,您可以使用统一身份认证服务(Identity and Access Management,简称IAM)。 如果华为云账号已经能满足您的要求,不需要创建独立的IAM用户,您可以跳过本章节,不影响您使用API网关服务的其它功能。 仅API网关专享版支持精细的细粒度授权。
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
请求方法:接口调用方式,此处选择“GET”。 请求协议:选择API请求协议,此处选择“HTTPS”。 子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。 路径:接口请求路径。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。
专享版-实例自定义入方向端口管理 查询实例指定的自定义入方向端口绑定的域名信息 查询实例的自定义入方向端口列表 新增实例的自定义入方向端口 删除实例指定的自定义入方向端口 父主题: 专享版API(V2)
API绑定流控策略 设置特殊流控 ACL策略管理 API绑定ACL策略 云商店订购信息查询 配置管理 概要查询 签名密钥管理 签名密钥绑定关系管理 域名管理 VPC通道管理 监控信息查询 OpenAPI接口 自定义认证管理
400 非法请求 检查请求是否合法。 APIG.0605 Domain name resolution failed. 500 域名解析失败 检查域名拼写,以及域名是否绑定了正确的后端地址。 APIG.0606 Failed to load the API configurations
发布的环境id publish_id String 发布记录的编号 sl_domain String 分组的二级域名 sl_domains Array of strings 系统默认分配的子域名列表 req_params Array of ReqParam objects API的请求参数列表
设置特殊流控(待下线) ACL策略管理(待下线) API绑定ACL策略(待下线) 概要查询(待下线) 签名密钥管理(待下线) 签名密钥绑定关系管理(待下线) 域名管理(待下线) VPC通道管理(待下线) API导入导出(待下线) 自定义认证管理(待下线)
type为instance时,为实例编码 project_id String 租户项目编号 common_name String 域名 san Array of strings san扩展域名 not_after String 有效期到 signature_algorithm String 签名算法 create_time
获取SSL证书已绑定域名列表 GET /v2/{project_id}/apigw/certificates/{certificate_id}/attached-domains apig:certificate:listBoundDomain - √ × SSL证书绑定域名 POST /
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
'com.squareup.okhttp3:okhttp:3.14.3' } 创建request,输入AppKey和AppSecret,并指定域名、方法名、请求uri和body。 本示例以AK和SK保存在环境变量中为例,运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_
是 boolean 是否支持开启跨域请求的标识。 true:支持。 false:不支持。 开启跨域访问的API请求,响应会增加如下头域: 头域名称 头域值 描述 Access-Control-Max-Age 172800 预检响应最大缓存时间。 单位:s。 Access-Control-Allow-Origin
timeout: 30000 表1 参数说明 参数 是否必选 类型 说明 address 是 Array 后端服务地址,格式为:<域名或IP>:[port]。 scheme 是 String 后端请求协议定义,支持http、https。 method 是 String 后
失败返回示例,描述API的异常返回信息 response_id String 分组自定义响应ID sl_domain String 分组的子域名 sl_domains Array of strings 分组的子域名列表 version_id String 版本编号 publish_time Timestamp 版本发布时间
专享版-签名密钥管理 专享版-签名密钥绑定关系管理 专享版-API绑定流控策略 专享版-设置特殊流控 专享版-APP授权管理 专享版-概要查询 专享版-域名管理 专享版-ACL策略管理 专享版-API绑定ACL策略 专享版-自定义认证管理 专享版-OpenAPI接口 专享版-VPC通道管理 专享版-监控信息查询
业务后端的情况下,便于对请求内容进行具体的分析和统计。 约束与限制 同一个环境中,一个API只能被一个流量镜像策略绑定,但一个流量镜像策略可以绑定多个API。 镜像请求返回的响应会被忽略。 镜像请求的请求体大小受实例参数“request_body_size”控制,默认请求体大小为
址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 访问控制策略和API本身是相互独立的,只有将访问控制策略绑定API后,访问控制策略才对绑定的API生效。 同一个环境中一个API只能被一个访问控制策略绑定,一个访问控制策略可以绑定多个API。
type为instance时,为实例编码 project_id String 租户项目编号 common_name String 域名 san Array of strings san扩展域名 not_after String 有效期到 signature_algorithm String 签名算法 create_time
支持的监控指标 功能说明 本节定义了API网关服务上报云监控服务的监控指标的命名空间,监控指标列表和维度定义,用户可以通过云监控服务提供管理控制台或API接口来检索API网关服务产生的监控指标和告警信息。 命名空间 共享版:SYS.APIG API网关监控指标 表1 API网关共享版支持的监控指标