检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
删除API 操作场景 已发布的API不再提供服务,可以将API删除。 该操作将导致此API无法被访问,可能会影响正在使用此API的应用或者用户,请确保已经告知用户。 已上架云商店的API,无法被删除。 已发布的API,需要先下线API,再删除。 操作步骤 进入共享版控制台。 单击“开放API
选择API的发布环境,并填写发布说明。 单击“确定”,API发布成功后,发布按钮左上角的红色感叹号消失。 验证 使用接口测试工具调用已创建的API,或者在客户端调用已创建的API。 填写API所属分组的调试域名。 导入服务端的proto文件。 此处的proto文件如下: syntax = "proto3";
override:当API信息定义冲突时,override会覆盖原有API信息 缺省值:merge file_name 是 File 导入Api的请求体,json或yaml格式的文件 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 success Array of Success objects
检查共享版当前使用情况,以及专享版实例规格,确定是否可以迁移。 创建专享版实例 根据检查结果,购买满足共享版需求的专享版实例。 申请迁移 联系技术支持工程师或者客户经理,申请迁移共享版。 验证和切流 验证迁移结果,并实施最终切流。 实施步骤 迁移前检查 查看用户是否使用云商店功能。 登录API网关
API的编号,即:需要进行发布或下线的API的编号 remark 否 String 对发布动作的简述。字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 publish_id String 发布记录的ID
API分组ID。必须指定apis或group_id。 remark 否 String 对本次发布的描述信息 字符长度不超过255 说明: 中文字符必须为UTF-8或者unicode编码。 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 success Array of PublishResp
云审计服务支持的APIG操作列表 开通云审计服务 如果您需要收集、记录或者查询API网关服务的操作日志,用于支撑安全分析、审计、问题定位等常见应用场景时,那么需要先开通云审计服务。 云审计服务包含以下功能: 记录审计日志 审计日志查询 审计日志转储 事件文件加密 关键操作通知 查看关键操作列表
攻击类型。 方案架构 方案优势 所有Region都可以配置。 可指定保底带宽和弹性带宽。 约束与限制 对接高防后,如果开启了WEB基础防护或者CC防护,APIG将无法透传真实源IP。 需修改域名的IP,必须使用高防IP。 需依赖公网DNS进行域名切换。 业务带宽需收费。 域名切换有短暂时间间隔,可能会导致网络中断。
CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
是 String ACL策略名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头,3 ~ 64字符。 说明: 中文字符必须为UTF-8或者unicode编码。 acl_type 是 String 类型 PERMIT (白名单类型) DENY (黑名单类型) acl_value
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
描述 name 是 String 签名密钥的名称。支持汉字,英文,数字,下划线,且只能以英文和汉字开头。 说明: 中文字符必须为UTF-8或者unicode编码。 最小长度:3 最大长度:64 sign_type 否 String 签名密钥类型: hmac basic public_key
name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容 private_key 是 String 证书私钥 type 否
CONSUMER API分组的子域名 path 是 String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 字典数据类型 查询参数,每个参数值为字符串数组,每个参数名称有如下约束: 英文字母、数字、点、下划线、中连线组成
name 是 String 证书名称。支持中文,英文字母,数字,下划线,且只能以英文或汉字开头,4~50个字符。 说明: 中文字符必须为UTF-8或者unicode编码。 cert_content 是 String 证书内容 private_key 是 String 证书私钥 type 否
使用API网关服务时,您的账户可用额度小于待结算的账单,即被判定为账户欠费。欠费后,可能会影响服务资源的正常运行,请及时充值。 欠费原因 在按需计费模式下账户的余额不足。或者在包年/包月模式,带宽按需计费模式下账户的余额不足。 欠费影响 按需计费时,实例按秒计费,每一个小时整点结算一次费用(以GMT+08:00
参数 说明 分组名称 API分组名称,用于将API接口进行分组管理。 支持中文、英文、数字、中划线、下划线、点、斜杠、中英文格式下的小括号和冒号、中文格式下的顿号,且只能以英文、汉字或数字开头,长度为3~255个字符。 描述 对分组的介绍。长度为0~1000个字符。 单击“确定”,创建完成。
信息或是API拥有者。 path 是 String API的请求路径,需以"/"开头,最大长度1024 说明: 须符合路径规范,百分号编码格式可被正确解码 query 否 Map<String,Array<String>> 查询参数,每个参数值为字符串数组,每个参数名称有如下约束:
参数名称 当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。 填写编排后的参数名称。支持英文、数字、中划线,且只能以英文开头,长度为1~128个字符。 参数类型 当“是否预处理策略”开关关闭或者“编排策略”选择“none_value”或“default”时需要配置。