检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
API可以绑定内网域名吗? 对于共享版,域名必须完成备案,并将其CNAME解析到API分组对应的子域名。不能将无法在公网访问的域名,或者将他人所有的域名绑定给API分组。 对于专享版,可以配置内网域名,域名不需要备案,并将A记录解析到实例的入口地址。 父主题: 开放API
每天最多可以访问1000次。 独立域名:您自定义的域名,最多可以添加5个独立域名,不限访问次数。API调用者通过访问独立域名来调用您开放的API。 前提条件 已有独立域名。可通过域名注册服务申请新的域名。 公网独立域名需要备案,未备案的独立域名无法被访问。备案时长需几个工作日,建议您提前进行备案。
group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 表3 参数说明 名称 类型 说明 common_name String 证书域名 san 字典数据类型 SAN域名 version String
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加CNAME类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
修改域名 功能介绍 修改绑定的域名所对应的配置信息。使用实例自定义入方向端口的特性时,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI PUT /v2/{project_id}/apigw/instances/{instance_
绑定域名 功能介绍 用户自定义的域名,需要CNAME到API分组的子域名上才能生效,具体方法请参见增加A类型记录集。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 URI HTTP/HTTPS请求方法以及URI如下表所示。 表1 HTTP/HTTPS请求方法以及URI
certificate/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 表3 参数说明
独立域名可分为内网域名和公网域名两种: 内网域名:部署在云服务平台内的业务系统,可以使用内网域名访问API。 公网域名:部署在云服务平台外的业务系统,可以使用公网域名访问API。 您也可以使用系统分配的调试域名(子域名)访问API分组内的API,该调试域名唯一且不可修改,每天最多可以访问1000次,仅适用于内部测试使用。
绑定域名 功能介绍 用户自定义的域名,需要增加A记录才能生效,具体方法请参见《云解析服务用户指南》的“添加A类型记录集”章节。 每个API分组下最多可绑定5个域名。绑定域名后,用户可通过自定义域名调用API。 调用方法 请参见如何调用API。 URI POST /v2/{proj
instance_id 是 String 实例ID,在API网关控制台的“实例信息”中获取。 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 certificate_id 是 String 证书的编号 请求参数 表2 请求Header参数 参数 是否必选
SSL证书绑定域名 功能介绍 SSL证书绑定域名。使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/certifi
关闭实例公网出口 功能介绍 关闭实例公网出口 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eip 表1 路径参数 参数 是否必选 参数类型 描述 project_id
域名管理 对象模型 绑定域名 解绑域名 绑定域名证书 删除域名证书 查看域名证书 父主题: 共享版API(仅存量用户使用)
参数说明 名称 类型 说明 id String 自定义域名的编号 url_domain String 自定义域名 status Integer 解析状态值 ssl_id String 证书的编号 ssl_name String 证书的名称 响应消息样例: { "id": " b9b
group_id}/domains/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 id 是 String 域名的编号 group_id 是 String 分组的编号 请求消息 无 响应消息 无 状态码 表3 返回消息说明 状态码 说明 204
certificate/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 group_id 是 String 分组的编号 domain_id 是 String 域名的编号 id 是 String 证书的编号 请求消息 无 响应消息 无 状态码 表3
绑定域名证书 功能介绍 如果创建API时,“定义API请求”使用HTTPS请求协议,那么在独立域名中需要添加SSL证书。 使用实例自定义入方向端口的特性时,相同的域名会同时绑定证书,注意开启/关闭客户端校验会对相同域名的不同端口同时生效。 本章节主要介绍为特定域名绑定证书。 调用方法
API的后端服务报“Backend domain name resolution failed” APIG实例所在的VPC完成了内网域名解析,后端服务调用仍报“域名无法解析”错误。 可能原因 APIG实例所在的VPC与用户后端服务所在的VPC存在网络隔离,内网域名解析仅在用户后端服务所在的VPC下能够解析。
描述 对分组的介绍。 完成分组信息填写后,单击“确定”,创建API分组。 创建分组成功后,在“API分组”页面的列表中显示新创建的API分组。 API分组创建后,系统为分组自动分配一个内部测试用的子域名,此子域名每天最多可以访问1000次。 共享版中的API,分组子域名可公网访问。
API网关如何开放部署在华为云上的服务? 如果部署在华为云上的服务绑定了公网IP地址,在API网关中创建API时,使用公网IP地址:端口号作为后端服务地址。如果此服务已绑定域名,则优先使用域名作为后端服务地址。创建API的详细步骤请参见创建API。 如果部署在华为云上的服务无公网IP地址,则将此