检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如超出此数量,请分批导入,或提交配额修改工单,调整API单次导入上限。 可能原因2:参数错误,需要检查和修正。建议先在API网关控制台界面创建一个API,将其导出作为API文件的模板。 可能原因3:YAML文件格式问题,需要检查和修正。 可能原因4:本地proxy网络限制,更换网络环境。
如何将API服务上架到华为云商店上售卖? API服务上架到华为云商店,您需要按如下流程完成部署和配置: 完成API的创建、发布等工作 此部分操作在API网关服务中完成,您可以参考《API网关用户指南》。 其他相关操作包括“API分组”、“API管理”和“环境管理”等。 (可选)配置API的流量控制策略
功能,可以帮助您安全的控制华为云资源的访问。 通过IAM,您可以在华为云账号中给员工创建IAM用户,并使用策略来控制员工对API网关资源的访问范围。 如果华为云账号已经能满足您的需求,不需要创建独立的IAM用户进行权限管理,您可以跳过本章节,不影响您使用API网关服务的其它功能。
响应参数 状态码: 200 表4 响应Header参数 参数 参数类型 描述 x-request-id String 请求编号 表5 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 connections Array
配置DNS需要配置“/etc”目录下的resolv.conf文件,指定DNS服务器的IP地址。 内网DNS服务器的IP地址与您所位于的区域相关,您可通过内网DNS地址表获取内网DNS服务器的IP地址。 新增内网DNS服务器有两种方法。 方法一:修改虚拟私有云的子网信息 方法二:编辑“/etc/resolv.conf”文件
管理API概述 API创建完成后,您还可以进行以下相关操作管理API。 查看或编辑APIG的API信息:您可以通过查看API的基本信息来确认API的调用信息,通过编辑API的基本信息来更改服务信息。 配置API的自定义认证:您可以通过自定义认证来自定义认证系统。 配置API的参数
行简易的API认证。您可以根据业务需求选择其中一种进行认证,下文介绍具体两种认证方式的配置。 配置APIG的API认证凭据 在API网关中创建一个凭据,生成密钥对(Key、Secret),在调用API时,API网关服务根据密钥对进行身份核对,完成鉴权。Key唯一且不可重置,支持重置Secret。
前在API网关中创建。 导入API前,请确保API分组和API的配额满足需求。 操作步骤 进入共享版控制台。 单击“开放API > API管理”,进入到API管理信息页面。 单击“导入API”,进入“导入API”界面。 选择如表1所示参数。 图1 导入API 表1 导入API 参数名称
应用编号 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 响应参数 状态码: 200 表3 响应Body参数
额开关。 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 id String 编号 name String 名称 remark String 描述 creator String APP的创建者 USER:用户自行创建 MARKET:云商店分配 暂不支持MARKET
X-Sdk-Date Origin:此字段必选,表示请求消息所属源。 Access-Control-Request-Method:此字段必选,表示请求会使用哪些HTTP请求方法。 Access-Control-Request-Headers:此字段可选,表示请求会额外发送的头信息字段。 后端服务返回消息:无
sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String 描述 call_limits Integer
操作监控能力,帮助用户日常监控API网关的运行状态,可以通过控制台直观的查看API网关各项监控指标。 关于APIG支持的监控指标,以及如何创建监控告警规则等内容,请参见API监控。 父主题: 安全
I网关通过独立域名定位到此分组。 共享版中,不同分组下不能绑定相同的独立域名。 在绑定域名前,您需要理解以下2个概念: 子域名:API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名唯一且不可更改,每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加
128个字符。 响应参数 状态码: 201 表4 响应Body参数 参数 参数类型 描述 id String 编号 name String 名称 remark String 描述 creator String APP的创建者 USER:用户自行创建 MARKET:云商店分配 暂不支持MARKET
分组上绑定的独立域名列表 sl_domain_access_enabled Boolean 调试域名是否可以访问,true表示可以访问,false表示禁止访问 缺省值:true sl_domains Array of strings 系统默认分配的子域名列表 remark String
开启HTTPS、是否开启gzip等多种因素影响。下表是API网关处于30%CPU水位下的QPS参考值,参考场景为无认证和单机流控模式。 安全水位指能够在突发流量增长至双倍的情况下,API网关系统依然维持高吞吐量和低延迟性能。 表1 QPS性能参考 实例规格 基础版 专业版 企业版
足业务灰度发布、版本升级、回滚等需求。 环境变量 环境变量是指在环境上创建可管理的一种变量,该变量固定在环境上。当API发布到不同环境时,发布过程中变量标识会被相应环境的变量值替换,API本身定义不变。通过创建环境变量,实现同一个API,在不同环境中调用不同的后端服务。 精细流量控制
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
最大长度:255 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 create_time String 创建时间 name String 环境名称 remark String 描述信息 id String 环境id 状态码: 400 表5 响应Body参数 参数 参数类型