GET 获取实例列表

GET /v1/gpu/instances

请求参数

名称	位置	类型	必选	说明
name	query	string	否	实例名模糊匹配
pageSize	query	integer	否	页大小
pageNum	query	integer	否	页码
X-Appid	header	string	否	none
X-Nonce	header	string	否	none
X-Timestamp	header	string	否	none
X-Signature	header	string	否	none
X-Request-Id	header	string	否	none

返回示例

{
  "instances": [
    {
      "id": "string",
      "name": "string",
      "region": "string",
      "regionName": "string",
      "status": "string",
      "sshCommand": "string",
      "GPUType": "string",
      "rootPassword": "string",
      "imageName": "string",
      "cpuLimit": "string",
      "memLimit": "string",
      "GPULimit": "string",
      "createdAt": "string",
      "LastStartedAt": "string",
      "LastStoppedAt": "string",
      "useTime": "string",
      "portMappings": [
        {
          "port": "string",
          "endpoint": "string",
          "type": "string"
        }
      ],
      "billingType": "string",
      "jupyterAddress": "string",
      "expiredAt": "string",
      "networkStorageId": "string",
      "productId": "string",
      "statusError": {
        "state": "string",
        "message": "string"
      },
      "diskSize": "string"
    }
  ],
  "pageSize": 0,
  "pageNum": 0,
  "total": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	A successful response.	Inline

返回数据结构

状态码 200

名称	类型	必选	约束	中文名	说明
» instances	[object]	false	none	实例列表	none
»» id	string	true	none	实例 ID	none
»» name	string	false	none	实例名	none
»» region	string	false	none	区域 ID	none
»» regionName	string	false	none	区域名	none
»» status	string	true	none	实例状态： toCreate:待创建,creating:创建中,pulling:拉取镜像中,running:运行中,toStart:待启动, starting:启动中,toStop:待停止,stopping:停止中,exited:已停止,toRemove:待删除,removing:删除中,removed:已删除	none
»» sshCommand	string	false	none	ssh 命令	none
»» GPUType	string	true	none	GPU 型号	none
»» rootPassword	string	false	none	root 用户密码	none
»» imageName	string	true	none	镜像信息	none
»» cpuLimit	string(int64)	true	none	CPU 核心数	none
»» memLimit	string(int64)	true	none	内存大小（单位 GB）	none
»» GPULimit	string(int64)	true	none	GPU 数量	none
»» createdAt	string(int64)	true	none	创建时间戳	none
»» LastStartedAt	string(int64)	false	none	最后一次开始时间	none
»» LastStoppedAt	string(int64)	false	none	最后一次停止时间	none
»» useTime	string(int64)	false	none	使用时间	none
»» portMappings	[object]	false	none	端口映射	none
»»» port	string	true	none		none
»»» endpoint	string	true	none		none
»»» type	string	false	none		none
»» billingType	string	false	none	计费模式	none
»» jupyterAddress	string	false	none	Jupyter 地址	none
»» expiredAt	string(int64)	false	none	到期时间	none
»» networkStorageId	string	true	none	网络存储 ID	none
»» productId	string	true	none	产品 ID	none
»» statusError	object	false	none		none
»»» state	string	true	none	错误状态	none
»»» message	string	true	none	错误信息	none
»» diskSize	integer	false	none	本地存储大小	none
» pageSize	integer(int32)	true	none	每页大小	none
» pageNum	integer(int32)	true	none	页数	none
» total	integer(int32)	true	none	总数	none

请求参数​

返回结果​

返回数据结构​

请求参数

返回结果

返回数据结构