检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。 配置API的调用域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。系统自
包括APP授权、解除授权,查看APP已绑定/未绑定的API列表,查看API已绑定的APP列表。 概要查询 包括查询API概况、API分组概况、APP概况。 域名管理 包括域名的绑定、修改、解绑。域名证书的绑定、删除、查看。 ACL策略管理 包括ACL策略的创建、修改、删除、批量删除,查看ACL策略详情、查询ACL策略列表。
使用APIG专享版跨VPC开放后端服务操作流程 创建VPC 创建两个VPC,VPC1为API网关所在VPC,VPC2为后端应用所在VPC。 创建实例 在VPC1上创建API专享版实例。 创建弹性负载均衡 在VPC2上创建弹性负载均衡。 创建对等连接 创建VPC Peering对等连接,打通VPC1和VPC2。
API分组是API的管理单元,一个API分组等同于一个服务入口,创建API分组时,返回一个子域名作为访问入口。建议一个API分组下的API具有一定的相关性。 专享版API网关已经陆续开放V2版本的接口,请优先使用V2版本接口管理您的API。 URI HTTP/HTTPS请求方法以及URI如下表所示。
environment. 404 API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径和创建的API是否一致;检查API是否发布,如果发布到非生产环境,检查请求X-Stage头是否为发布的环境名;检查调用API使用的域名是否已经绑定到API所在的分组。 APIG.0101 The
常。 可以使用调试功能来测试API功能是否正常,详情参考调试API。 可以使用分组调试域名进行API功能测试,详情参考调用API。 验证完毕后进行切流,切流目前主要存在以下几种场景。 使用独立域名从公网访问的场景 需要将原来自定义域名的Cname记录从共享版分组子域名更改为专享版的实例域名{instance-id}
UrlDomainsResp objects 分组上绑定的独立域名列表 表5 UrlDomainsResp 名称 类型 说明 id String 域名编号 domain String 访问域名 cname_status Integer 域名cname状态: 1:未解析 2:解析中 3:解析成功
创建API 开启跨域访问 调试API 授权API 发布API 下线API 删除API 导入API 导出API 父主题: 共享版操作指导(仅存量用户使用)
使用IAM认证调用API Token认证 AK/SK认证
持Java Development Kit 17或以上版本。 获取SDK 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本,获取“ApiGateway-java-sdk.zip”压缩包,解压后目录结构如下: 名称
默认值1 该字段暂时废弃 R - SL_DOMAIN String API分组的子域名,由API网关分配,用户不可填写和修改 R - SL_DOMAINS Array of strings API分组的子域名列表,由API网关分配,用户不可填写和修改 R - PROJECT_ID String
请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载JavaScript SDK的最新版本,并解压。在浏览器中打开demo.html,页面如下图所示。 填入Key、Secret、方法名、请求协议、域名和url。 1 2 3 4 5 6 //
对象模型 API发布后,如果不想API被某些IP地址访问到,可以将这些IP地址加入黑名单,或者想API被某些特性的IP地址访问到,也可以将这些IP地址加入白名单。这样可以提高API的访问安全性,保护API免受攻击。本节介绍API的黑白名单(ACL策略)管理的对象模型,如表1 ACL策略对象模型所示。
environment. 404 API不存在或未发布到环境 检查调用API所使用的域名、请求方法、路径是否正确。 检查API是否发布。 检查域名解析是否正确。 检查API是否使用OPTIONS跨域请求,如果使用OPTIONS跨域请求,请在API中开启CORS。 具体操作请参见常见问题。
IDEA中安装Go插件,如果未安装,请按照图1所示安装。 图1 安装Go插件 获取SDK 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本,获取“ApiGateway-go-sdk.zip”压缩包,解压后目录结构如下: 名称 说明
IDEA中安装PHP插件,如果未安装,请按照图1所示安装。 图1 安装PHP插件 获取SDK 请在API网关控制台选择“帮助中心”,在“SDK使用指引”页签中下载对应语言所使用SDK。 或直接下载SDK的最新版本,获取“ApiGateway-php-sdk.zip”压缩包,解压后目录结构如下: 名称
构造规范请求。 将待发送的请求内容按照与API网关(即API管理)后台约定的规则组装,确保客户端签名、API网关后台认证时使用的请求内容一致。 使用规范请求和其他信息创建待签字符串。 使用AK/SK和待签字符串计算签名。 将生成的签名信息作为请求消息头添加到HTTP请求中,或者作为查询字符串参数添加到HTTP请求中。
创建VPC通道 功能介绍 在API网关中创建连接私有VPC资源的通道,并在创建API时将后端节点配置为使用这些VPC通道,以便API网关直接访问私有VPC资源。 每个用户最多创建30个VPC通道。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
创建时间:终端节点的创建时间。 操作:终端节点服务对终端节点的连接审批,可选择“接受”或“拒绝”。 须知: 如您仍有业务通过该连接进行访问,拒绝已建立的连接可能导致业务受损,请谨慎操作。 权限管理 权限管理用于控制是否允许跨租户的终端节点进行访问。可以设置允许连接该终端节点服务的授权账号ID,将授权账号ID添加至终端节点服务的白名单中。
专享版-SSL证书管理 获取SSL证书列表 创建SSL证书 域名绑定SSL证书 域名解绑SSL证书 查看证书详情 删除SSL证书 修改SSL证书 SSL证书绑定域名 SSL证书解绑域名 获取SSL证书已绑定域名列表 父主题: 专享版API(V2)