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

# 查询实例详情

## 请求头

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

## 查询参数

<ParamField query="instanceId" type="string" required={true}>
  要查询详情的实例 ID。
</ParamField>

## 响应参数

<ResponseField name="id" type="string" required={true}>
  实例 ID。
</ResponseField>

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

<ResponseField name="clusterId" type="string" required={true}>
  集群 ID。
</ResponseField>

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

<ResponseField name="status" type="string" required={true}>
  实例状态。取值：

  * `toCreate`：待创建
  * `creating`：创建中
  * `pulling`：拉取镜像中
  * `running`：运行中
  * `toStart`：待启动
  * `starting`：启动中
  * `toStop`：待停止
  * `stopping`：停止中
  * `exited`：已停止
  * `toRestart`：待重启
  * `restarting`：重启中
  * `toRemove`：待删除
  * `removing`：删除中
  * `removed`：已删除
  * `toReset`：待重置(升级)
  * `resetting`：重置中
  * `migrating`：迁移中
  * `freezing`：冻结中
</ResponseField>

<ResponseField name="sshCommand" type="string" required={false}>
  用于 SSH 远程登录的命令。
</ResponseField>

<ResponseField name="password" type="string" required={false}>
  用于 SSH 远程登录的密码。
</ResponseField>

<ResponseField name="imageUrl" type="string" required={true}>
  容器镜像地址。
</ResponseField>

<ResponseField name="imageAuthId" type="string" required={true}>
  镜像仓库认证信息。
</ResponseField>

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

<ResponseField name="entrypoint" type="string" required={false}>
  容器启动 entrypoint。
</ResponseField>

<ResponseField name="cpuNum" type="string" required={true}>
  实例的 CPU 数。单位为核。
</ResponseField>

<ResponseField name="memory" type="string" required={true}>
  实例的内存大小。单位为 GB。
</ResponseField>

<ResponseField name="gpuNum" type="string" required={true}>
  实例的 GPU 卡数。
</ResponseField>

<ResponseField name="createdAt" type="string" required={true}>
  实例的创建时间。格式为 Unix 时间戳。
</ResponseField>

<ResponseField name="lastStartedAt" type="string" required={true}>
  实例最近一次的启动时间。格式为 Unix 时间戳。
</ResponseField>

<ResponseField name="lastStoppedAt" type="string" required={true}>
  实例最近一次的停止时间。格式为 Unix 时间戳。
</ResponseField>

<ResponseField name="useTime" type="string" required={true}>
  实例的使用时长。单位为秒。
</ResponseField>

<ResponseField name="billingMode" type="string" required={true}>
  实例的计费方式。取值：

  * onDemand：按量计费。

  * monthly：包年包月。

  * spot: 抢占式计费。
</ResponseField>

<ResponseField name="productId" type="string" required={true}>
  用于部署实例的产品 ID。
</ResponseField>

<ResponseField name="productName" type="string" required={true}>
  用于部署实例的产品名称。
</ResponseField>

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

<ResponseField name="tools" type="object[]" required={false}>
  工具信息。目前部分官方镜像包含 Jupyter。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="name" type="string" required={false}>
      工具名称。
    </ResponseField>

    <ResponseField name="port" type="string" required={false}>
      工具使用端口。
    </ResponseField>

    <ResponseField name="type" type="string" required={false}>
      工具使用端口类型。
    </ResponseField>

    <ResponseField name="endpoint" type="string" required={false}>
      工具访问地址。
    </ResponseField>
  </Expandable>
</ResponseField>

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

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

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

    <ResponseField name="size" type="string" required={false}>
      存储容量大小。
    </ResponseField>

    <ResponseField name="id" type="string" required={false}>
      云存储 ID。当 type = network 时返回。
    </ResponseField>

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

<ResponseField name="node" type="object[]" required={false}>
  节点信息。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="maxRootfsSize" type="string" required={false}>
      最大可用系统盘大小。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="jobs" type="object[]" required={false}>
  当前实例正在运行的任务。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="id" type="string" required={false}>
      任务 ID。
    </ResponseField>

    <ResponseField name="type" type="string" required={false}>
      任务类型。目前仅有saveImage，表示保存镜像。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="statusError" type="object" required={false}>
  实例创建失败或实例不可用时的错误信息。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="state" type="string" required={false}>
      实例异常状态。
    </ResponseField>

    <ResponseField name="message" type="string" required={false}>
      错误信息。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="network" type="object" required={false}>
  实例的 VPC 网络信息。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="id" type="string" required={false}>
      VPC 网络的 ID。
    </ResponseField>

    <ResponseField name="ip" type="string" required={false}>
      实例的 IP 地址。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="portMappings" type="object[]" required={true}>
  实例端口映射信息。

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

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

    <ResponseField name="type" type="string" required={true}>
      协议类型。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="envs" type="object[]" required={false}>
  实例的环境变量信息。

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

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

<ResponseField name="connectComponentSSH" type="object" required={false}>
  实例 SSH 连接信息。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="isRunning" type="boolean" required={false}>
      是否正在 SSH 远程登录。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="connectComponentWebTerminal" type="object" required={false}>
  实例 Web Terminal连接信息。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="address" type="string" required={false}>
      用于 Web 远程登录的地址。
    </ResponseField>

    <ResponseField name="username" type="string" required={false}>
      用于 Web 远程登录的用户名。
    </ResponseField>

    <ResponseField name="password" type="string" required={false}>
      用于 Web 远程登录的密码。
    </ResponseField>

    <ResponseField name="isRunning" type="boolean" required={false}>
      是否正在通过 Web 远程登录。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="connectComponentJupyter" type="object" required={false}>
  实例 Jupyter 连接信息（如果有）。

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

    <ResponseField name="address" type="string" required={false}>
      连接地址。
    </ResponseField>

    <ResponseField name="isRunning" type="boolean" required={false}>
      是否正在通过 Jupyter 远程登录。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="connectComponentLog" type="object" required={false}>
  实例日志连接信息（HTTP Stream）。

  <Expandable title="properties" defaultOpen={false}>
    <ResponseField name="systemLogAddress" type="string" required={false}>
      系统日志地址。
    </ResponseField>

    <ResponseField name="instanceLogAddress" type="string" required={false}>
      实例日志地址。

      请求日志时可在地址中增加如下参数：

      * follow=0 或 1：是否持续获取日志。取值 0（不持续） 或 1（持续）。默认 1。
      * sse=0 或 1：是否使用 SSE 协议返回日志。取值 0（不使用） 或 1（使用）。默认 1。
      * timestamp=0 或 1：是否需要时间戳。取值 0（不需要） 或 1（需要）。默认 1。
      * tail=x：初始化日志时获取最后 x 行。

      示例：`https://c092dad5a76a3da2-2224.gpu-instance.ppinfra.com/sys?follow=1&sse=1&timestamps=1&tail=200`
    </ResponseField>

    <ResponseField name="isRunning" type="boolean" required={false}>
      是否正在连接。
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="kind" type="string" required={false}>
  实例类型。
</ResponseField>

<ResponseField name="endTime" type="string" required={false}>
  包年包月实例到期时间。若是按量计费实例，则返回 -1。
</ResponseField>

<ResponseField name="freeStorageSize" type="integer" required={false}>
  免费的系统盘容量大小。单位为 GB。
</ResponseField>

<ResponseField name="keepDataDay" type="integer" required={false}>
  实例关机后，数据保留的天数。
</ResponseField>
