跳到主要内容

更新访问策略

基本信息

更新访问策略

请求路径
PUT /openapi/v1/teams/{team_id}/regions/{region_name}/apps/{app_id}/domains/{rule_id}
Body请求参数
{
"service_id": "string",
"container_port": 0,
"certificate_id": 0,
"domain_name": "string",
"domain_cookie": "string",
"domain_header": "string",
"the_weight": 0,
"domain_path": "string",
"rule_extensions": [
"string"
],
"whether_open": true,
"auto_ssl": true,
"auto_ssl_config": "string"
}

请求参数

名称位置类型必选说明
app_idpathinteger应用ID
team_idpathstringnone
region_namepathstringnone
rule_idpathstringnone
bodybodyUpdatePostHTTPGatewayRulenone

返回结果

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

模型

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"
}

属性

名称类型必选约束中文名说明
IDintegerfalseread-onlyIDnone
rule_extensions[string]falseread-onlynone
http_rule_idstringtruenoneHttp rule idhttp_rule_id
region_idstringtruenoneRegion idregion id
tenant_idstringtruenoneTenant id租户id
service_idstringtruenoneService id组件id
service_namestringtruenoneService name组件名
domain_namestringtruenoneDomain name域名
container_portintegerfalsenoneContainer port容器端口
protocolstringfalsenoneProtocol域名类型 http https httptphttps httpandhttps
certificate_idintegerfalsenoneCertificate id证书ID
domain_typestringfalsenoneDomain type组件域名类型
service_aliasstringfalsenoneService alias组件别名
is_seniorbooleanfalsenoneIs senior是否有高级路由
domain_pathstringfalsenoneDomain path域名path
domain_cookiestringfalsenoneDomain cookie域名cookie
domain_heanderstringfalsenoneDomain heander域名heander
typeintegerfalsenoneType类型(默认:0, 自定义:1)
the_weightintegerfalsenoneThe weight权重
is_outer_servicebooleanfalsenoneIs outer service是否已开启对外端口
auto_sslbooleanfalsenoneAuto ssl是否自动匹配证书,升级为https,如果开启,由外部服务完成升级
auto_ssl_configstring¦nullfalsenoneAuto ssl config自动分发证书配置
path_rewritebooleanfalsenonePath rewrite是否开启简单路由重写
rewritesstringfalsenoneRewrites复杂路由重写配置

UpdatePostHTTPGatewayRule

{
"service_id": "string",
"container_port": 0,
"certificate_id": 0,
"domain_name": "string",
"domain_cookie": "string",
"domain_header": "string",
"the_weight": 0,
"domain_path": "string",
"rule_extensions": [
"string"
],
"whether_open": true,
"auto_ssl": true,
"auto_ssl_config": "string"
}

属性

名称类型必选约束中文名说明
service_idstringtruenoneService id应用组件id
container_portintegerfalsenoneContainer port绑定端口
certificate_idintegerfalsenoneCertificate id证书id
domain_namestringfalsenoneDomain name域名
domain_cookiestringfalsenoneDomain cookie域名cookie
domain_headerstringfalsenoneDomain header域名header
the_weightintegerfalsenoneThe weightnone
domain_pathstringfalsenoneDomain path域名路径
rule_extensions[string]falsenone规则扩展
whether_openbooleanfalsenoneWhether open是否开放
auto_sslbooleanfalsenoneAuto ssl是否自动匹配证书,升级为https,如果开启,由外部服务完成升级
auto_ssl_configstringfalsenoneAuto ssl config自动分发证书配置