管理节点路由

在 DC/OS 管理节点上运行的 Admin Router

有关 API 路由方式的详细信息，请参阅 DC/OS API 参考.

Show/Hide All

  • Proxy retrieves resources from another address.
  • File retrieves static files.
  • Lua executes Lua code to generate response.
  • Redirect redirects to another address.

  • Rewrite retrieves resources from another route.

  • [

    Root](#root)

    • DC/OS GUI

  • [

    Agent](#agent)

    Show/Hide

    • Proxy /(slave|agent)/(?<agentid>[0-9a-zA-Z-]+)(?<url>.+)

      API proxy to a specific agent node

      Rewrite:
      Regex:^/(slave|agent)/[0-9a-zA-Z-]+/.*$
      Replacement:$url
      Type:break
      Proxy:
      Path:$agentaddr:$agentport

  • [

    Authentication](#authentication)

    • File /acs/acl-schema.json

      Access Control List schema

      Path:/opt/mesosphere/active/acl-schema/etc/acl-schema.json

    • Proxy /acs/api/v1

      Access Control Service

      Path:http://$backend/acs/api/v1
      Server:127.0.0.1:8101
      Backend:DC/OS Identity and Access Manager (Bouncer)
      API Reference:

    • Proxy /acs/api/v1/auth/(login|logout|jwks|providers|oidc/callback|oidc/providers/?|saml/providers/?)

      Access Control Service (unauthenticated)

      Path:http://$backend~ ^/acs/api/v1/auth/(login|logout|jwks|providers|oidc/callback|oidc/providers/?|saml/providers/?)$
      Server:127.0.0.1:8101
      Backend:DC/OS Identity and Access Manager (Bouncer)
      API Reference:

    • Proxy /acs/api/v1/auth/saml/providers/[0-9a-zA-Z-]+/acs-callback

      Access Control Service SAML provider callback (unauthenticated)

      Path:http://$backend~ ^/acs/api/v1/auth/saml/providers/[0-9a-zA-Z-]+/acs-callback$
      Server:127.0.0.1:8101
      Backend:DC/OS Identity and Access Manager (Bouncer)
      API Reference:

    • Proxy

      Access Control List schema

      Path:http://$backend~ ^/acs/api/v1/users/(?<uid_path>.*)/permissions$
      Server:127.0.0.1:8101
      Backend:DC/OS Identity and Access Manager (Bouncer)
      API Reference:

    • Proxy /internal/acs/api/v1/

      Access Control Service policy query (unauthenticated, internal-only)

      Rewrite:
      Regex:^/internal/(.*)
      Replacement:/$1
      Type:break
      Proxy:
      Path:http://$backend/internal/acs/api/v1/
      Server:127.0.0.1:8101
      Backend:DC/OS Identity and Access Manager (Bouncer)
      API Reference:

  • [

    Capabilities](#capabilities)

    Show/Hide

    • Proxy /capabilities

      List of capabilities supported by DC/OS

      Path:$upstream_cosmos

  • [

    Certificate Authority](#certificate-authority)

    • Proxy /ca/api/v2/(newcert|newkey|sign)

      Certificate Signing Request (CSR)

      Rewrite:
      Regex:^/ca/api/v2/(.*)
      Replacement:/api/v1/cfssl/$1
      Type:break
      Proxy:
      Path:http://$backend~ /ca/api/v2/(newcert|newkey|sign)$
      Server:127.0.0.1:8888
      Backend:DC/OS Certificate Authority
      API Reference:

    • Proxy /ca/api/v2/bundle

      Retrieve certificate chain without root CA cert for provided certificate

      Rewrite:
      Regex:^/ca/api/v2/(.*)
      Replacement:/api/v1/cfssl/$1
      Type:break
      Proxy:
      Path:http://$backend= /ca/api/v2/bundle
      Server:127.0.0.1:8888
      Backend:DC/OS Certificate Authority
      API Reference:

    • Proxy /ca/api/v2/info

      Certificate and basic signing information

      Rewrite:
      Regex:^/ca/api/v2/(.*)
      Replacement:/api/v1/cfssl/$1
      Type:break
      Proxy:

    • File /ca/cacerts.jks

      Get CA public key Java Key Store file (unauthenticated)

      Path:/run/dcos/pki/CA/certs/cacerts.jks

  • [

    Cluster](#cluster)

    • Allow access to Cluster APIs

      Path:http://$backend
      Server:unix:/run/dcos/dcos-cluster-linker.sock
      Backend:DC/OS Cluster Linker
      API Reference:

  • CockroachDB](#cockroachdb)

    Show/Hide

    • Redirect /cockroachdb

      Redirect to the CockroachDB Admin UI

      Regex:^/cockroachdb$
      Replacement:$scheme://$http_host/cockroachdb/
      Type:permanent

    • Proxy /cockroachdb/

      The CockroachDB Admin UI

      Path:
      Server:127.0.0.1:8090
      Backend:CockroachDB
      API Reference:https://www.cockroachlabs.com/

  • [

    Cosmos](#cosmos)

    • Proxy /cosmos/service/

      Start a DC/OS service from a DC/OS package

      Rewrite:
      Regex:^/cosmos/(.*)
      Replacement:/$1
      Type:break
      Proxy:
      Path:$upstream_cosmos

  • [

    DC/OS Net](#dcos-net)

    Show/Hide

    • Proxy /navstar/lashup/key

      Path:
      Server:127.0.0.1:62080
      Backend:DC/OS Net

  • [

    Exhibitor](#exhibitor)

    Show/Hide

  • [

    Marathon](#marathon)

    • Rewrite /marathon/

      Rewrite:
      Regex:^/marathon/(.*)$
      Replacement:/service/marathon/$1
      Type:
      Deprecated:Use /service/marathon/

  • [

    Mesos](#mesos)

    Show/Hide

    • Proxy /mesos/

      Apache Mesos

      Rewrite:
      Regex:^/mesos/(.*)
      Replacement:/$1
      Type:break
      Proxy:
      Path:$upstream_mesos

  • [

    Mesos DNS](#mesos-dns)

    • Proxy /mesos_dns/

      Domain-based service discovery

      Path:http://$backend/
      Server:127.0.0.1:8123
      Backend:Mesos DNS
      API Reference:

  • Metadata](#metadata)

    Show/Hide

    • File /dcos-metadata/bootstrap-config.json

      DC/OS bootstrap configuration

      Path:/opt/mesosphere/etc/bootstrap-config.json

    • File /dcos-metadata/dcos-version.json

      DC/OS version (unauthenticated)

      Path:/opt/mesosphere/active/dcos-metadata/etc/dcos-version.json

    • File /dcos-metadata/ui-config.json

      DC/OS GUI configuration (unauthenticated)

    • Public IP and Cluster ID

      Path:conf/lib/metadata.lua

  • [

    • Proxy /net/v1/nodes

      Exposes the public IP addresses for nodes in a cluster

      Path:null

  • [

    Network Metrics](#network-metrics)

    Show/Hide

    • Proxy /networking/api/v1/

      Networking-related metrics

      Rewrite:
      Regex:^/networking/api/v1/(.*)
      Replacement:/$1
      Type:break
      Proxy:
      Path:$upstream_dcos_netapi

  • [

    Other](#other)

    • Proxy /internal/mesos_dns/

      Path:http://$backend/
      Server:127.0.0.1:8123
      Backend:Mesos DNS
      API Reference:

  • [

    Package](#package)

    Show/Hide

    • Proxy /package/

      Package Management

      Path:$upstream_cosmos

  • [

    Pkgpanda](#pkgpanda)

    • Proxy /pkgpanda/

      DC/OS component package management

      Path:http://$backend
      Server:unix:/run/dcos/pkgpanda-api.sock
      Backend:DC/OS Component Package Manager (Pkgpanda)
      API Reference:

    • File /pkgpanda/active.buildinfo.full.json

      List the active Pkgpanda packages

      Path:/opt/mesosphere/active.buildinfo.full.json

  • [

    Secrets](#secrets)

    Show/Hide

    • Proxy /secrets/v1/

      Securely store and retrieve secrets

      Path:$upstream_secrets

  • Service](#service)

    • Proxy /service/(?<service_path>.+)

      Proxy to services running on DC/OS

      Path:$upstream_url

  • [

    System](#system)

    Show/Hide

    • Proxy /system/health/v1

      Component service status

      Path:
      Server:unix:/run/dcos/dcos-diagnostics.sock
      Backend:DC/OS Diagnostics
      API Reference:https://docs.d2iq.com/mesosphere/dcos/2.1/monitoring/#system-health-http-api-endpoint

    • Proxy /system/v1/agent/(?<agentid>[0-9a-zA-Z-]+)(?<url>/logs.*|/metrics/v0.*|/dcos-metadata/dcos-version.json)

      System proxy to a specific agent node

      Rewrite:
      Regex:^/system/v1/agent/[0-9a-zA-Z-]+/(logs.|metrics/v0.)
      Replacement:/system/v1$url
      Type:break
      Rewrite:
      Regex:^/system/v1/agent/[0-9a-zA-Z-]+/dcos-metadata/dcos-version.json
      Replacement:/dcos-metadata/dcos-version.json
      Type:break
      Proxy:
      Path:$agentaddr:$adminrouter_agent_port

    • Proxy /system/v1/backup/

      Backup & Restore DC/OS Components

      Path:
      Server:unix:/run/dcos/dcos-backup-master.sock
      Backend:DC/OS Backup
      API Reference:https://docs.d2iq.com/mesosphere/dcos/2.1/administering-clusters/backup-and-restore/backup-restore-api/

    • Proxy /system/v1/leader/marathon(?<url>.*)

      System proxy to the master node with the Marathon leader

      Path:$mleader_host/system/v1$url$is_args$query_string

    • System proxy to the master node with the Mesos leader

      Path:$system_v1_leader_mesos

    • Proxy /system/v1/logs/

      Node, component service, and container (task) logs

      Path:
      Server:unix:/run/dcos/dcos-log.sock
      Backend:DC/OS Log
      API Reference:https://docs.d2iq.com/mesosphere/dcos/2.1/monitoring/logging/logging-reference/