> ## Documentation Index
> Fetch the complete documentation index at: https://ppio.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 查询 Endpoint 详情

## 请求头

<ParamField header="Content-Type" type="string" required={true}>
  枚举值：application/json。
</ParamField>

<ParamField header="Authorization" type="string" required={true}>
  Bearer 身份验证格式，例如：Bearer \{\{API 密钥}}。
</ParamField>

## 查询参数

<ParamField query="id" type="string" required={true}>
  需要查询的 Endpoint ID。
</ParamField>

## 响应参数

<ResponseField name="endpoint" type="object" required={true}>
  Endpoint 信息。

  <Expandable title="properties" defaultOpen={true}>
    <ResponseField name="id" type="string" required={true}>
      Endpoint ID。
    </ResponseField>

    <ResponseField name="name" type="string" required={true}>
      Endpoint 名称。
    </ResponseField>

    <ResponseField name="appName" type="string" required={true}>
      应用名称。
    </ResponseField>

    <ResponseField name="state" type="object" required={true}>
      Endpoint 状态。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="state" type="string" required={true}>
          Endpoint 状态。取值为 serving 时，表示 Endpoint 可以正常服务。
        </ResponseField>

        <ResponseField name="error" type="string" required={false}>
          Endpoint 处于异常状态时的错误码。
        </ResponseField>

        <ResponseField name="message" type="string" required={false}>
          Endpoint 处于异常状态时的错误信息。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="url" type="string" required={true}>
      Endpoint URL。通过该 URL 可以访问 您的 HTTP 服务。
    </ResponseField>

    <ResponseField name="workerConfig" type="object" required={true}>
      Endpoint 的 Worker 配置。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="minNum" type="integer" required={true}>
          最小 Worker 数。
        </ResponseField>

        <ResponseField name="maxNum" type="integer" required={true}>
          最大 Worker 数。
        </ResponseField>

        <ResponseField name="freeTimeout" type="string" required={true}>
          空闲超时。单位为秒。
        </ResponseField>

        <ResponseField name="maxConcurrent" type="string" required={true}>
          最大并发数。
        </ResponseField>

        <ResponseField name="gpuNum" type="integer" required={true}>
          每个 Worker 的 GPU 卡数。
        </ResponseField>

        <ResponseField name="requestTimeout" type="integer" required={true}>
          请求超时(秒)。
        </ResponseField>

        <ResponseField name="cudaVersion" type="string" required={true}>
          CUDA 版本。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="policy" type="object" required={true}>
      Endpoint 的弹性策略。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="type" type="string" required={true}>
          弹性策略类型。取值：

          * queue：队列延迟策略，表示根据队列中请求的等待时间调整 Worker 的数量。
          * concurrency：队列请求策略，表示根据队列中的请求数，自动调整 Worker 的数量。
        </ResponseField>

        <ResponseField name="value" type="string" required={true}>
          根据 type 的取值，value 表示不同。

          * type = queue 时，value 表示队列等待时间，单位为秒。
          * type = concurrency 时，value 表示队列最大请求数。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="image" type="object" required={true}>
      Endpoint 的镜像配置。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="image" type="string" required={true}>
          镜像地址。
        </ResponseField>

        <ResponseField name="authId" type="string" required={true}>
          镜像仓库凭证。
        </ResponseField>

        <ResponseField name="command" type="string" required={true}>
          容器启动命令。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="rootfsSize" type="integer" required={true}>
      系统盘大小。
    </ResponseField>

    <ResponseField name="volumeMounts" type="object[]" required={true}>
      Endpoint 的存储配置。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="type" type="string" required={true}>
          存储类型。取值：

          * local：本地存储。
          * network：云存储。
        </ResponseField>

        <ResponseField name="id" type="string" required={true}>
          云存储 ID。
        </ResponseField>

        <ResponseField name="size" type="integer" required={true}>
          type = local 时返回，表示本地盘的大小。
        </ResponseField>

        <ResponseField name="mountPath" type="string" required={true}>
          存储的挂载路径。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="envs" type="object[]" required={true}>
      环境变量。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="key" type="string" required={true}>
          环境变量名称。
        </ResponseField>

        <ResponseField name="value" type="string" required={true}>
          环境变量取值。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="ports" type="object[]" required={true}>
      HTTP 端口。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="port" type="integer" required={true}>
          HTTP 端口。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="workers" type="object[]" required={true}>
      Endpoint 的 Worker 信息。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="id" type="string" required={true}>
          Worker ID。
        </ResponseField>

        <ResponseField name="state" type="object" required={true}>
          Worker 状态。

          <Expandable title="properties" defaultOpen={true}>
            <ResponseField name="state" type="string" required={true}>
              Worker 状态。取值为 running 时，表示 Worker 可以正常服务。
            </ResponseField>

            <ResponseField name="error" type="string" required={false}>
              Worker 处于异常状态时的错误码。
            </ResponseField>

            <ResponseField name="message" type="string" required={false}>
              Worker 处于异常状态时的错误信息。
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="log" type="string" required={true}>
          Worker 的日志路径。
        </ResponseField>

        <ResponseField name="metrics" type="string" required={true}>
          Worker 的监控信息。
        </ResponseField>

        <ResponseField name="healthy" type="boolean" required={true}>
          Worker 是否健康。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="products" type="object[]" required={true}>
      产品信息。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="id" type="string" required={true}>
          产品 ID。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="healthy" type="object" required={true}>
      Endpoint 的健康检查配置。

      <Expandable title="properties" defaultOpen={true}>
        <ResponseField name="path" type="string" required={true}>
          使用 HTTP 请求进行健康健康时，检测的路径。
        </ResponseField>

        <ResponseField name="initialDelay" type="integer" required={true}>
          启动多久后开始健康检查。单位为秒。
        </ResponseField>

        <ResponseField name="period" type="integer" required={true}>
          健康检查的执行周期。单位为秒。
        </ResponseField>

        <ResponseField name="timeout" type="integer" required={true}>
          健康检查的超时时间。单位为秒。
        </ResponseField>

        <ResponseField name="successThreshold" type="integer" required={true}>
          从上次检查失败后，重新认定为检查成功的次数。
        </ResponseField>

        <ResponseField name="failureThreshold" type="integer" required={true}>
          从上次检查成功后，连续失败多少次认定为检查失败。
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="clusterID" type="string" required={true}>
      云存储所在的集群 ID。使用云存储时返回。
    </ResponseField>

    <ResponseField name="log" type="string" required={true}>
      Endpoint 的日志路径。
    </ResponseField>
  </Expandable>
</ResponseField>
