检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API发布到RELEASE环境可以正常访问,发布到非RELEASE环境无法访问如何处理? API发布到非RELEASE环境无法访问时,添加x-stage请求消息头后即可访问。 例如: r.Header.Add("x-stage", "RELEASE") 您也可以参考快速开放并调用API
发布API 功能介绍 将一个指定的API发布到一个指定的环境,API只有发布后,才能够被调用,且只能在该环境上才能被调用。未发布的API无法被调用。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI 请求方法 URI POST
开放API 开放API流程 创建API分组 添加API的SSL证书 配置API的调用域名 创建API的负载通道(可选) 创建API 调试APIG创建的API 配置API的发布环境和环境变量(可选) 发布APIG创建的API
同VPC内使用独立域名从内网访问的场景 需要将原来的自定义域名的Cname记录从共享版分组子域名更改为专享版实例的实例域名{instance-id}.apic.{region-id}.huaweicloudapis.com。
子域名:API分组创建后,系统为分组自动分配一个内部测试用的调试域名,此调试域名每天最多可以访问1000次。 路径:接口请求路径。此处填写“/hello”。 网关响应 API网关未能成功处理API请求,从而产生的错误响应。此处默认“default”。
表4 共享版与专享版API网关功能差异 规格分类 规格描述 共享版 专享版 基本功能 精细化流控 √ √ IP&用户访问控制 √ √ 安全认证 √ √ API生命周期管理 √ √ 自定义域名 √ √ Swagger导入导出 √ √ 支持VPC通道(负载通道) √ √ API参数编排
API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains Array of UrlDomainsResp objects 分组上绑定的独立域名列表
子域名:所在分组的调试域名。 路径:API的请求路径。请求路径可以包含请求参数,请求参数使用{}标识,例如/a/{b},也可以通过配置“+”号做前缀匹配,例如:/a/{b+}。注意,请求路径中的字母区分大小写。 网关响应 网关响应指未能成功处理API请求,从而产生的错误响应。
需修改域名的IP,必须使用高防IP。 需依赖公网DNS进行域名切换。 业务带宽需收费。 域名切换有短暂时间间隔,可能会导致网络中断。 父主题: 使用DDoS防护服务为APIG抵御DDoS攻击
Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer 流控时长内分组下的API
ApiGroup createDomainBinding 修改安全传输协议 ApiGroup modifySecureTransmission 解绑域名 ApiGroup relieveDomainBinding 添加域名证书 ApiGroup addDomainCertificate
默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains Array of UrlDomainsResp objects 分组上绑定的独立域名列表 on_sell_status
sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits
对API的修改是否需要重新发布? 需要。 API发布后,如果再次编辑API参数,需要重新发布才能将修改后的信息同步到环境中。 关于API重新发布的详细指导,请参考发布API。 父主题: 发布API
sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits
id 是 String 分组的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名 register_time Timestamp
未提供时根据mode的取值使用如下默认值: DEVELOPER API分组的子域名 MARKET 云商店为API分组分配的域名 CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码
未提供时根据mode的取值使用如下默认值: DEVELOPER API分组的子域名 MARKET 云商店为API分组分配的域名 CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码
流控时长内分组下的API的总访问次数限制,默认不限,请根据服务的负载能力自行设置 time_interval Integer 流控时长 time_unit String 流控的时间单位 url_domains Array of UrlDomainsResp objects 分组上绑定的独立域名列表
"name": "api_group_001", "remark": "分组001" } 响应消息 表4 参数说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名