检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
境中。 同一个API在每个环境中最多记录10条最新的发布历史。 前提条件 已创建API分组和分组内的API。 已创建环境。 发布API 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 通过以下任意一种方法,进入“发布API”页面。 在待发布的API所在行,单击“发布”。
API监控 支持的监控指标 创建告警规则 查看监控指标 父主题: 监控分析
在左侧导航栏选择“DDoS高防 > 域名接入”,单击“添加域名”。详情请参考配置防护域名。 填写域名信息。 添加用户网站的防护域名和域名绑定的证书。如果没有域名,请参考域名注册服务注册域名;证书可通过云证书管理服务申请。 填写的域名须备案,如果没有备案,请参考域名备案。 选择实例与线路。 选择已购买的实例,单击“提交并继续”。
API管理 创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
删除API 功能介绍 删除指定的API。 删除API时,会删除该API所有相关的资源信息或绑定关系,如API的发布记录,绑定的后端服务,对APP的授权信息等。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI
适用于将一份全新且完整的API导入到API网关。 导入API前,请注意以下事项: API网关中API分组和API的配额满足需求。 使用Swagger info或OpenAPI info的title作为API分组名称,新创建的API分组名称不能与已有的API分组名称重名。 导入的API定义中,如
创建API API提供者把API接口配置在API网关中,开放后端能力。创建API分以下步骤: 前端配置 支持配置前端定义、安全配置和请求参数。 后端配置 支持配置默认后端、策略后端和返回结果。 (可选)为API添加策略 支持配置传统策略和插件策略。 API网关服务基于REST的A
验证API服务。 如果需要修改API参数,请在右上角单击“编辑”,进入API编辑页面。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API创建流控策略、创建访问控制策略和创建并使用签名密钥。 父主题: API管理
TLS加密协议支持什么版本? API网关支持TLS 1.1及TLS 1.2版本,暂不支持TLS 1.0或TLS 1.3。 关于TLS版本的详细指导,请参考绑定域名。 父主题: API认证鉴权
API概览 API网关专享版接口的分类与说明如表1所示,API网关共享版接口的分类与说明如表2所示。 表1 专享版API概览 类型 说明 API分组管理 包括API分组的创建、修改、删除、查询详情和列表等接口。 环境管理 包括环境的创建、修改、删除和查询列表等接口。 环境变量管理
SSL证书管理 如果API分组中的API支持HTTPS请求协议,则在绑定独立域名后,还需为独立域名添加SSL证书。SSL证书是进行数据传输加密和身份证明的证书,支持单向认证和双向认证两种认证方式。 单向认证:客户端与服务端连接时,客户端需要验证所连接的服务端是否正确。 双向认证:
security参数说明 x-apigateway-access-control 否 Object API绑定的访问控制对象数组定义 x-apigateway-backend 否 Object API的后端信息,参考表 x-apigateway-backend参数说明 x-apigateway-backend-policies
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
或在左侧导航栏选择“API管理 > API列表”,单击“导出API”。 设置导出参数。 表1 导出API 参数 说明 API分组 选择待导出API所在的API分组。 运行环境 选择待导出API所在的环境。 API 默认导出API分组所在环境的所有的API,如果需要导出个别API,单击“自定义导出API”,勾选需要导出的API名称。
API安全 怎样保护API? 怎样保证API网关调用后端服务器的安全? 能否针对VPC通道(负载通道)内的ECS私有IP进行访问控制
status Integer API的状态 type Integer API类型 version String API版本 req_protocol String API访问协议 req_method String API请求方式 req_uri String API访问地址 auth_type
专享版:支持。 前端双向认证。在绑定独立域名时,选择带有CA证书的SSL证书,开启客户端认证即双向认证。 后端双向认证。在创建API时,配置双向认证,在API网关和后端服务间启用双向认证。配置请参考创建API中的“TLS双向认证”参数说明。 共享版:不支持,API网关仅做HTTPS的单向认证。
API流量控制 是否支持对请求并发次数做自定义控制? 每个子域名(调试域名)每天最多可以访问1000次,如果账号为企业账号,是否还有这个限制? API调用是否存在带宽限制 流量控制策略不生效怎么办? 父主题: API控制策略
批量导出API 功能介绍 按API ID列表批量导出指定分组、指定环境中发布的API的基础/全量/扩展Swagger定义。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 请求方法 URI POST /v1.0/apigw/openapi/apis?env_id
domain 否 String API的访问域名,未提供时根据mode的取值使用如下默认值: DEVELOPER API分组的子域名 MARKET 云商店为API分组分配的域名 CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024