Get the list of enterprise application http access policies

Basic Information

Get the list of enterprise application http access policies

请求路径

  1. 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

  1. {
  2. "ID": 0,
  3. "region_name": "string",
  4. "team_name": "string",
  5. "app_id": 0,
  6. "auto_ssl_config": "string",
  7. "http_rule_id": "string" ,
  8. "region_id": "string",
  9. "tenant_id": "string",
  10. "service_id": "string",
  11. "service_name": "string",
  12. "domain_name": "string",
  13. "container_port" : -2147483648,
  14. "protocol": "string",
  15. "certificate_id": -2147483648,
  16. "domain_type": "string",
  17. "service_alias": "string",
  18. "is_senior": true,
  19. "domain_path" : "string",
  20. "domain_cookie": "string",
  21. "domain_heander": "string",
  22. "type": -2147483648,
  23. "the_weight": -2147483648,
  24. "rule_extensions": "string",
  25. " is_outer_service": true,
  26. "auto_ssl": true,
  27. "path_rewrite": true,
  28. "rewrites": "string"
  29. }

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