Skip to main content

Get the list of enterprise application http access policies

Basic Information

Get the list of enterprise application http access policies

请求路径
GET /openapi/v1/httpdomains

request parameters

nameLocationtyperequiredChinese nameillustrate
auto_sslquerystringnoThe query condition, whether it is a policy that needs to automatically match the certificate

return result

status codeStatus code meaningillustratedata model
200OKsuccessInline

return data structure

Status code 200

nametyperequiredconstraintChinese nameillustrate
anonymousEnterpriseHTTPGatewayRulefalsenonenone
» IDintegerfalseread-onlyIDnone
» region_namestringtruenoneRegion nameID of the cluster to which it belongs
» team_namestringtruenoneTeam nameUnique team name
» app_idintegertruenoneApp idApp ID
» auto_ssl_configstringtruenoneAuto ssl configautomatic issuance method
» http_rule_idstringtruenoneHttp rule idhttp_rule_id
» region_idstringtruenoneRegion idregion id
» tenant_idstringtruenoneTenant idtenant id
» service_idstringtruenoneService idcomponent id
» service_namestringtruenoneService namecomponent name
» domain_namestringtruenoneDomain namedomain name
» container_portintegerfalsenoneContainer portcontainer port
» protocolstringfalsenoneProtocolDomain type http https httptp https http and https
» certificate_idintegerfalsenoneCertificate idCertificate ID
» domain_typestringfalsenoneDomain typeComponent domain name type
» service_aliasstringfalsenoneService aliascomponent alias
» is_seniorbooleanfalsenoneIs seniorIs there an advanced route
» domain_pathstringfalsenoneDomain pathdomain name path
» domain_cookiestringfalsenoneDomain cookiesdomain cookie
» domain_heanderstringfalsenoneDomain heanderdomain name heander
» typeintegerfalsenoneTypeType (default:0, custom:1)
» the_weightintegerfalsenoneThe weightWeights
» rule_extensionsstringfalsenoneRule extensionsextensions
» is_outer_servicebooleanfalsenoneIs outer serviceWhether the external port has been opened
» auto_sslbooleanfalsenoneAuto sslWhether to automatically match the certificate and upgrade to https, if enabled, the upgrade will be completed by an external service
» path_rewritebooleanfalsenonePath rewriteWhether to enable simple route rewriting
» rewritesstringfalsenoneRewritesComplex route rewrite configuration

Model

EnterpriseHTTPGatewayRule

{
"ID": 0,
"region_name": "string",
"team_name": "string",
"app_id": 0,
"auto_ssl_config": "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,
"rule_extensions": "string",
" is_outer_service": true,
"auto_ssl": true,
"path_rewrite": true,
"rewrites": "string"
}

Attributes

nametyperequiredconstraintChinese nameillustrate
IDintegerfalseread-onlyIDnone
region_namestringtruenoneRegion nameID of the cluster to which it belongs
team_namestringtruenoneTeam nameUnique team name
app_idintegertruenoneApp idApp ID
auto_ssl_configstringtruenoneAuto ssl configautomatic issuance method
http_rule_idstringtruenoneHttp rule idhttp_rule_id
region_idstringtruenoneRegion idregion id
tenant_idstringtruenoneTenant idtenant id
service_idstringtruenoneService idcomponent id
service_namestringtruenoneService namecomponent name
domain_namestringtruenoneDomain namedomain name
container_portintegerfalsenoneContainer portcontainer port
protocolstringfalsenoneProtocolDomain type http https httptp https http and https
certificate_idintegerfalsenoneCertificate idCertificate ID
domain_typestringfalsenoneDomain typeComponent domain name type
service_aliasstringfalsenoneService aliascomponent alias
is_seniorbooleanfalsenoneIs seniorIs there an advanced route
domain_pathstringfalsenoneDomain pathdomain name path
domain_cookiestringfalsenoneDomain cookiesdomain cookie
domain_heanderstringfalsenoneDomain heanderdomain name heander
typeintegerfalsenoneTypeType (default:0, custom:1)
the_weightintegerfalsenoneThe weightWeights
rule_extensionsstringfalsenoneRule extensionsextensions
is_outer_servicebooleanfalsenoneIs outer serviceWhether the external port has been opened
auto_sslbooleanfalsenoneAuto sslWhether to automatically match the certificate and upgrade to https, if enabled, the upgrade will be completed by an external service
path_rewritebooleanfalsenonePath rewriteWhether to enable simple route rewriting
rewritesstringfalsenoneRewritesComplex route rewrite configuration