检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
global:全局证书 instance:实例证书 instance_id String 实例编码 type为global时,缺省为common type为instance时,为实例编码 project_id String 租户项目编号 create_time String 创建时间
包括签名密钥的绑定和解除绑定接口,查询签名密钥绑定/未绑定API列表接口。 域名管理 包括域名的绑定、解绑和证书的绑定、删除接口。 VPC通道管理 包括创建VPC通道、更新VPC通道、删除VPC通道、查看VPC通道详情和列表、添加和删除云服务器、查看云服务器列表。 监控信息查询 包括API/API分组的统计信息查询接口。
请求Body参数 参数 是否必选 参数类型 描述 sl_domain_access_enabled 是 Boolean 设置调试域名是否可以访问,true为可以访问,false为禁止访问 缺省值:true 响应参数 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code
API。 IP地址 仅当“类型”为“IP地址”时需要配置。 输入允许或者禁止访问API的IP地址,或IP地址范围。 说明: 允许或禁止访问的IP地址条数,分别可以配置最多100条。 账号名 仅当“类型”为“账号名”时需要配置。 输入允许或者禁止访问API的账号名,多个账号名之间使用英文逗号“
对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例(云服务器) 删除后端实例(云服务器) 查看后端实例列表(云服务器列表) 父主题: 共享版API(仅存量用户使用)
对象模型 创建VPC通道 更新VPC通道 删除VPC通道 查看VPC通道详情 查看VPC通道列表 添加后端实例(云服务器) 删除后端实例(云服务器) 查看后端实例列表(云服务器列表) 父主题: 专享版API(V1)(待下线)
调用API获取项目ID 项目ID还可通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为IAM的终端节点,可以从地区与终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下
bound_domains Array of UrlDomainRefInfo objects 已绑定域名集合 表5 UrlDomainRefInfo 参数 参数类型 描述 url_domain String 自定义域名 id String 自定义域名的编号 status Integer CNAME解析状态
如果API分组中的API支持HTTPS请求协议,需要为独立域名添加SSL证书。反之,跳过此步骤。 配置API的调用域名 在开放API前,您需要为API分组绑定一个独立域名,供API调用者访问API使用。 在绑定独立域名前,您可以使用系统为API分配的调试域名进行API调试,每天最多可以访问调试域名1000次。系统自动
object 编排后的参数配置,isPreprocessing为false时必填。 is_preprocessing Boolean 是否为预处理策略,预处理策略只会生成临时参数作为后面参数编排规则的入参标记。当为预处理策略时,该编排规则不能作为除default之外的最后一个编排规则。
分页显示查询结果 查询资源列表时(例如,查询API列表),系统支持分页显示查询结果。 在url后面拼接如下参数: page_size:每页查询多少条数据,如果不指定,默认20,最大值500。 page_no:需要查询的页码。 示例: GET /v1.0/apigw/apis?pa
导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw/i
详情参考调试API。 可以使用分组调试域名进行API功能测试,详情参考调用API。 验证完毕后进行切流,切流目前主要存在以下几种场景。 使用独立域名从公网访问的场景 需要将原来自定义域名的Cname记录从共享版分组子域名更改为专享版的实例域名{instance-id}.apic.{region-id}
您需要使用独立域名/调试域名访问,使用调试域名访问时存在单日访问次数限制。可在创建API分组后,为分组绑定独立域名,独立域名需要解析到实例的弹性IP地址。 例如您有一个API,请求协议为HTTPS,Path为/apidemo,开启了公网访问,并为分组绑定了独立域名后,可使用htt
异步导出API 功能介绍 导出分组下API的定义信息。导出文件内容符合swagger标准规范,API网关自定义扩展字段请参考《API网关用户指南》的“导入导出API:扩展定义”章节。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/apigw
载通道”创建。 后端服务地址(可选) 仅在不使用负载通道时,需要设置。 填写鉴权服务的访问地址,格式:“主机:端口”。主机为鉴权服务的访问IP地址/域名,未指定端口时,HTTP协议默认使用80端口,HTTPS协议默认使用443端口。 目前仅支持IPv4地址。 路径 鉴权服务的路径,即服务的url。
情况,识别可能影响业务的潜在风险。 安全防护 域名访问认证支持TLS1.1、TLS1.2防护,支持mTLS双向认证。 访问控制策略主要用来控制访问API的IP地址和账户,您可以通过设置IP地址或账户的黑白名单来拒绝/允许某个IP地址或账户访问API。 断路器策略是API网关在后端
解绑域名 功能介绍 如果API分组不再需要绑定某个自定义域名,则可以为此API分组解绑此域名。 调用方法 请参见如何调用API。 URI DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group
后,会对环境变量的值进行替换,如:定义的API的URL为:https://#address#:8080,环境变量address在RELEASE环境上的值为:192.168.1.5,则API发布到RELEASE环境后的真实的URL为:https://192.168.1.5:8080。
集群的容器网段,否则导入后调用API会出现失败场景。 导入后会生成相应的API以及微服务类型的负载通道,负载通道会监测工作负载下所有实例的地址变化,并更新到负载通道中。 前提条件 已创建CCE工作负载。 导入CCE工作负载 进入API网关控制台页面。 根据实际业务在左侧导航栏上方选择实例。