创建 Ingress

最近更新时间:2018-07-05 19:05:31

接口描述

本接口(CreateIngress)用于创建 Ingress。

接口请求域名:

ccs.api.qcloud.com

输入参数

以下请求参数列表仅列出了接口请求参数,其它参数见 公共请求参数

参数名称 描述 类型 必选
clusterId 集群 ID,请填写 查询集群列表 接口中返回的 clusterId 字段 String
ingressName Ingress 名称 String
ingressDesc Ingress 描述 String
certId SSL 证书 ID String
rules 转发规则 Object Array
namespace 命名空间,请填写 查询集群命名空间 接口中返回的 namespaces 字段,默认为 default String
unSubnetId 内网 Ingress 所属的 Subnet ID String
internetChargeType TRAFFIC_POSTPAID_BY_HOUR 或者 BANDWIDTH_POSTPAID_BY_HOUR String
internetMaxBandwidthOut 带宽上限,必须大于 0 Int

rules 参数详细说明:

字段 描述 类型 必选
url 应用型负载均衡监听器转发规则的路径。长度限制为:1 ~ 80。使用格式有两种:无修饰符格式,有修饰符格式。修饰符可以使用的有:~~\*^~= ,其中:
  • ~表示接下来的表达式为大小写敏感的正则表达式
  • ~*修饰符表示大小写不敏感的正则表达式
  • ^~ 修饰符表示如果该表达式被认定为最佳匹配,那么不再进行以下的搜索匹配
  • =表示精确匹配,只有请求与该表达式完全相同才满足该转发
    非正则表达式可用的字符包括字母、数字、_-.=?/
  • String
    domain 应用型负载均衡监听器转发规则的域名。长度限制为:1 ~ 80。有三种使用格式:非正则表达式格式,通配符格式,正则表达式格式。
  • 非正则表达式格式只能使用字母、数字、-.
  • 通配符格式的使用,*只能在开头或者结尾。
  • 正则表达式以~开头,支持 Nginx 原生的正则表达式。
  • String
    protocol 应用型负载均衡监听器转发规则的协议类型 String
    serviceName 后端服务名称 String
    servicePort 后端服务端口 Int
    LoadBalancePort 应用型负载均衡开放端口 Int

    输出参数

    参数名称 描述 类型
    code 公共错误码。0 表示成功,其他值表示失败 Int
    codeDesc 业务错误码。成功时返回 Success,错误时返回具体业务错误原因 String
    message 模块错误信息描述,与接口相关 String

    示例

    输入

     https://domain/v2/index.php?Action=CreateIngress
      &clusterId=cls-xxxxx
      &namespace=default
      &ingressName=test
      &ingressDesc=test
      &其它公共参数
    

    输出

    {
        "data":{
            "code":0,
            "message":"",
            "codeDesc":"Success",
            "data":[
    
            ]
        },
        "message":"",
        "code":0
    }