检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
缺省值:false member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。
这种场景,推荐考虑使用对象存储服务。 专享版:API每次最大可以转发Body体为12MB的请求包。请求body体超过12M时,根据业务需求,请在“实例概览”的配置参数中修改“request_body_size”参数。
绑定域名 功能介绍 用户自定义的域名,需要增加A记录才能生效,具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 调用方法 请参见如何调用API。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
表5 Mock类型定义后端服务 参数 配置说明 后端服务类型 选择后端服务类型,此处选择“Mock”,实际请求不会调用到后端服务,通常用于后端服务没有搭建好的API联调环境。如果已有搭建好的后端服务,根据实际需要配置其他后端服务类型,操作详情请参考创建API。
服务标识名 选择工作负载的Pod标签,通过Pod标签指定某个工作负载。服务标识名为Pod标签的键,服务标识值为Pod标签的值。 Pod标签相关内容指导,请参考设置标签与注解。 服务标识值 标签 选择工作负载的Pod标签。
配置API认证凭据的配额控制 凭据配额可限制单位时间内凭据调用API的总次数,保护后端服务。您可以创建凭据配额策略,对绑定策略的凭据进行调用次数限制。 凭据配额策略和凭据本身是相互独立的,只有将凭据绑定凭据配额策略后,凭据配额策略才对凭据生效。
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。
您可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 后续操作 API调试成功后,您可以将API发布到环境,以便API调用者调用。或者出于API的安全性考虑,为API添加策略。 父主题: 开放API
新建变量 功能介绍 将API发布到不同的环境后,对于不同的环境,可能会有不同的环境变量,比如,API的服务部署地址,请求的版本号等。
为了安全起见,在服务器上使用curl命令调用接口查询信息后,需要清理历史操作记录,包括但不限于“~/.bash_history”、“/var/log/messages”(如有)。 URI HTTP/HTTPS请求方法以及URI如下表所示。
通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
$remote_addr代表客户端的IP,它的值是服务端根据客户端的IP指定的,当客户端访问APIG时,如果中间没有任何代理,那么就会把remote_addr设为客户端IP;如果使用了某个代理,那么客户端会先访问这个代理,然后再由这个代理转发到APIG,这样就会把remote_addr
创建API的负载通道(可选) 如果需要访问指定服务器中已部署的后端服务,可通过创建负载通道来实现。反之,跳过此步骤。 创建API 把已有后端服务封装为标准RESTFul API或GRPC API,并对外开放。 API创建成功后,您可根据业务需求配置API策略,管理API等。
创建流控策略 功能介绍 当API上线后,系统会默认给每个API提供一个流控策略,API提供者可以根据自身API的服务能力及负载情况变更这个流控策略。 流控策略即限制API在一定长度的时间内,能够允许被访问的最大次数。 URI HTTP/HTTPS请求方法以及URI如下表所示。
创建API分组 功能介绍 API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 调用方法 请参见如何调用API。
下线API 操作场景 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。
CORS允许浏览器向跨域服务器发送XMLHttpRequest请求,从而实现跨域访问。更多跨域访问的说明请参见跨域调用APIG开放的API。 跨域资源共享策略为跨域访问提供指定预检请求头和响应头、自动创建跨域预检请求API的扩展能力,可快速、灵活的实现API的跨域访问。
下线APIG的API 已发布的API因为其他原因需要暂停对外提供服务,可以暂时将API从相关环境中下线。 该操作将导致此API在指定的环境无法被访问,请确保已经告知使用此API的用户。 前提条件 已创建API分组和分组内的API。 API已发布到该环境。
缺省值:false member_group_name 否 String 后端服务器组名称。为后端服务地址选择服务器组,便于统一修改对应服务器组的后端地址。