检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.
hmac类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母或数字开头,8 ~ 32字符。未填写时后台自动生成。 basic类型的签名密钥key:支持英文,数字,下划线,中划线,且只能以英文字母开头,4 ~ 32字符。未填写时后台自动生成。 public_key类型的签名密钥key:支持英文,数字
在实际的生产中,API提供者可能有多个环境,如开发环境、测试环境、生产环境等,用户可以自由将API发布到某个环境,供调用者调用。对于不同的环境,API的版本、请求地址甚至于包括请求消息等均有可能不同。如:某个API,v1.0的版本为稳定版本,发布到了生产环境供生产使用,同时,该API正处于迭代中,v1.
SDK概述 本文介绍了API网关提供的开放API的SDK语言版本,列举了最新版本SDK的获取地址。 SDK列表 提供了API网关支持的SDK列表,您可以在GitHub仓库查看SDK更新历史、获取安装包以及查看指导文档。查看接口请参考“ApigClient”/“apig_client”文件。
API网关有哪些配额,是否可以调整? 流控策略怎么设置? APP认证和IAM认证有demo吗? AK SK鉴权如何使用? 有没有API导入示例? API的后端地址是否可以绑定为ELB地址? 如何创建API? 更多 开放API API的响应码如何定义? APIG是否支持多后端节点方案? API网关如何开放部署在华为云上的服务?
表2 自定义认证参数说明 参数 说明 认证名称 填写您自定义的认证名称,用于区分不同的自定义认证。支持中文、英文、数字、下划线,只能以中文或英文开头,长度为3~64个字符。 类型 创建后端自定义认证时,选择“后端”。 函数地址 选择用于后端自定义认证的函数后端,仅可以选择状态为“已部署”的函数后端。
法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能,与服务提供的SDK不同,使用时请注意。 客户端必须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关除了校验时间格式外,还会校验该时间值与网关收到请求的时间差,如果时
实例绑定的弹性IP地址 charging_mode Integer 实例计费方式: 0:按需计费 1:包周期计费 cbc_metadata String 包周期计费订单编号 loadbalancer_provider String 实例使用的负载均衡器类型 lvs Linux虚拟服务器 elb
调用API(浏览器)示例 由于浏览器限制从页面脚本内发起跨域请求,因此浏览器访问API前需要在API网关控制台上创建一个跨域共享策略,允许浏览器向跨域服务器发送XMLHttpRequest请求,并为跨域共享策略绑定API。 创建策略请参考跨域共享策略说明。 图8 创建跨域共享策略示例 在html中引入signer
Java、Go、Python、C#、JavaScript、PHP、C++、C、Android进行签名和访问。 客户端须注意本地时间与时钟服务器的同步,避免请求消息头X-Sdk-Date的值出现较大误差。 API网关(即API管理)除了校验时间格式外,还会校验该时间值与网关收到请求
API分组”,进入到API分组信息页面。 单击“创建分组”,弹出“创建分组”对话框。填写如表1所示信息。 表1 分组信息表 信息项 描述 分组名称 API分组名称,用于将API接口进行分组管理。 描述 对分组的介绍。 完成分组信息填写后,单击“确定”,创建API分组。 创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。
略: 流控控制 流量控制可限制单位时间内API的被调用次数,保护后端服务。 访问控制 访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 签名密钥 签名密钥用于后端服务验证API网关的身份,在API网关请求后端服务时,保障后端服务的安全。
SL_DOMAIN String API分组的子域名,由API网关分配,用户不可填写和修改 R - SL_DOMAINS Array of strings API分组的子域名列表,由API网关分配,用户不可填写和修改 R - PROJECT_ID String 创建该API分组的租户编号,即API分组的所有者
范围为1024~49151,需为实例已开放的HTTP协议的自定义入方向端口。 当创建域名时,该参数未填表示用默认80端口;如果填写该参数,则必须同时填写https_port;如果要http_port和https_port同时使用默认端口,则两个参数都不填。 当修改域名时,该参数未填表示不修改该端口。
API策略”。 单击“编排规则管理”页签。 单击“创建编排规则”,根据下表参数说明,配置编排规则。 表1 编排规则配置 参数 说明 规则名称 填写编排规则的名称,根据规划自定义。支持英文、数字、下划线,且只能以英文开头,长度为3~64个字符。 编排策略 选择编排策略。 list:列表中的值映射成另外的值。
表2 自定义认证参数说明 参数 说明 认证名称 填写自定义的认证名称,用于区分不同的自定义认证。支持中文、英文、数字、下划线,只能以中文或英文开头,长度为3~64个字符。 类型 创建前端自定义认证时,选择“前端”。 函数地址 选择用于前端自定义认证的函数后端,仅可以选择状态为“已部署”的函数后端。
根据实际业务在左侧导航栏上方选择实例。 在左侧导航栏选择“API管理 > API策略”。 单击“环境管理”页签。 单击“创建环境”,根据下表参数说明,填写环境信息。 表1 环境信息 参数 说明 环境名称 API环境名称。支持英文,数字,下划线,且只能以英文开头,长度为3-64个字符。 描述 环境描述信息。长度为1-255个字符。
已创建API分组。 创建环境 进入共享版控制台。 选择“开放API > 环境管理”,进入到环境管理信息页面。 单击“创建环境”,弹出“创建环境”对话框。填写如表1所示信息。 图2 创建环境 表1 环境信息 信息项 描述 环境名称 API环境名称。 描述 环境描述信息。 单击“确定”,创建环境。
支持英文,数字,下划线,中划线,且只能以数字或英文字母开头,8 ~ 32字符。 未填写时后台自动生成。 sign_secret 否 String 签名密钥的密钥。 支持英文,数字,下划线,中划线,!,@,#,$,%,且只能以数字或英文字母开头,16 ~ 64字符。 未填写时后台自动生成。 请求消息样例: { "name":
IDEA,选择菜单“File > New > Project”。 弹出“New Project”对话框,“Name”填写SDK压缩包内文件夹的名称,“Location”填写该文件夹的解压路径,“Language”选择“Go”,单击“Create”。 图2 Go 完成工程创建后,目录结构如下。