创建HTTP网关策略

基本信息

创建HTTP网关策略

请求路径

POST /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/httpdomains

Body请求参数

{
  "service_id": "string",
  "container_port": 0,
  "certificate_id": 0,
  "domain_name": "string",
  "domain_cookie": "string",
  "domain_header": "string",
  "the_weight": 0,
  "domain_path": "/",
  "rule_extensions": [],
  "whether_open": false,
  "auto_ssl": false,
  "auto_ssl_config": "string",
  "configuration": {
    "proxy_body_size": 0,
    "proxy_buffer_numbers": 4,
    "proxy_buffer_size": 4,
    "proxy_buffering": "off",
    "proxy_connect_timeout": 75,
    "proxy_read_timeout": 60,
    "proxy_send_timeout": 60,
    "set_headers": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

请求参数

名称	位置	类型	必选	中文名	说明
app_id	path	integer	是		应用ID
team_id	path	string	是		none
region_name	path	string	是		none
body	body	Http	否	Http	none

返回示例

返回结果

状态码	状态码含义	说明	数据模型
200	OK	成功	HTTPGatewayRule

模型

Http

{
  "service_id": "string",
  "container_port": 0,
  "certificate_id": 0,
  "domain_name": "string",
  "domain_cookie": "string",
  "domain_header": "string",
  "the_weight": 0,
  "domain_path": "/",
  "rule_extensions": [],
  "whether_open": false,
  "auto_ssl": false,
  "auto_ssl_config": "string",
  "configuration": {
    "proxy_body_size": 0,
    "proxy_buffer_numbers": 4,
    "proxy_buffer_size": 4,
    "proxy_buffering": "off",
    "proxy_connect_timeout": 75,
    "proxy_read_timeout": 60,
    "proxy_send_timeout": 60,
    "set_headers": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

属性

名称	类型	必选	约束	中文名	说明
service_id	string	true	none	Service id	应用组件id
container_port	integer	true	none	Container port	绑定端口
certificate_id	integer	false	none	Certificate id	证书id
domain_name	string	true	none	Domain name	域名
domain_cookie	string	false	none	Domain cookie	域名cookie
domain_header	string	false	none	Domain header	域名header
the_weight	integer	false	none	The weight	none
domain_path	string	false	none	Domain path	域名路径
rule_extensions	[string]	false	none		规则扩展
whether_open	boolean	false	none	Whether open	是否开放
auto_ssl	boolean	false	none	Auto ssl	是否自动匹配证书，升级为https，如果开启，由外部服务完成升级
auto_ssl_config	string	false	none	Auto ssl config	自动分发证书配置
configuration	Configuration	false	none		高级参数配置

HTTPGatewayRule

{
  "ID": 0,
  "rule_extensions": [
    "string"
  ],
  "http_rule_id": "string",
  "region_id": "string",
  "tenant_id": "string",
  "service_id": "string",
  "service_name": "string",
  "domain_name": "string",
  "container_port": -2147483648,
  "protocol": "string",
  "certificate_id": -2147483648,
  "domain_type": "string",
  "service_alias": "string",
  "is_senior": true,
  "domain_path": "string",
  "domain_cookie": "string",
  "domain_heander": "string",
  "type": -2147483648,
  "the_weight": -2147483648,
  "is_outer_service": true,
  "auto_ssl": true,
  "auto_ssl_config": "string",
  "path_rewrite": true,
  "rewrites": "string"
}

属性

名称	类型	必选	约束	中文名	说明
ID	integer	false	read-only	ID	none
rule_extensions	[string]	false	read-only		none
http_rule_id	string	true	none	Http rule id	http_rule_id
region_id	string	true	none	Region id	region id
tenant_id	string	true	none	Tenant id	租户id
service_id	string	true	none	Service id	组件id
service_name	string	true	none	Service name	组件名
domain_name	string	true	none	Domain name	域名
container_port	integer	false	none	Container port	容器端口
protocol	string	false	none	Protocol	域名类型 http https httptphttps httpandhttps
certificate_id	integer	false	none	Certificate id	证书ID
domain_type	string	false	none	Domain type	组件域名类型
service_alias	string	false	none	Service alias	组件别名
is_senior	boolean	false	none	Is senior	是否有高级路由
domain_path	string	false	none	Domain path	域名path
domain_cookie	string	false	none	Domain cookie	域名cookie
domain_heander	string	false	none	Domain heander	域名heander
type	integer	false	none	Type	类型（默认：0， 自定义：1）
the_weight	integer	false	none	The weight	权重
is_outer_service	boolean	false	none	Is outer service	是否已开启对外端口
auto_ssl	boolean	false	none	Auto ssl	是否自动匹配证书，升级为https，如果开启，由外部服务完成升级
auto_ssl_config	string¦null	false	none	Auto ssl config	自动分发证书配置
path_rewrite	boolean	false	none	Path rewrite	是否开启简单路由重写
rewrites	string	false	none	Rewrites	复杂路由重写配置