Skip to main content
GET
https://www.chenyu.cn
/
api
/
open
/
v2
/
instance
/
info
查询实例详情
curl --request GET \
  --url https://www.chenyu.cn/api/open/v2/instance/info \
  --header 'Authorization: Bearer <token>'
{
  "code": 123,
  "msg": "<string>",
  "data": {
    "instance_uuid": "<string>",
    "status": 123,
    "title": "<string>",
    "create_time": 123,
    "start_time": 123,
    "server_url": [
      {}
    ],
    "server_map": [
      {
        "title": "<string>",
        "url": "<string>",
        "port_type": "<string>",
        "protocol": "<string>",
        "ssh_info": {
          "host": "<string>",
          "port": 123,
          "username": "<string>",
          "password": "<string>"
        }
      }
    ],
    "save_image_status": 123,
    "charging_type": 123,
    "shutdown_regular": {
      "shutdown_time": 123,
      "enable": true
    },
    "image_uuid": "<string>",
    "image_name": "<string>",
    "image_tag": "<string>",
    "gpu_uuid": "<string>",
    "gpu_name": "<string>",
    "gpu_nums": 123
  }
}

​
查询实例详情

查询指定实例的详细信息，包括服务地址、SSH连接信息等。

​
请求参数

​
instance_uuid
string
required
实例UUID

​
响应参数

​
code
integer
响应码
​
msg
string
响应信息
​
data
object
实例详细信息

​
代码示例

import requests
from datetime import datetime

url = "https://www.chenyu.cn/api/open/v2/instance/info"
headers = {
    "Authorization": "Bearer your_api_key"
}

params = {
    "instance_uuid": "instance-uuid-123"
}

response = requests.get(url, headers=headers, params=params)
result = response.json()

if result['code'] == 0:
    instance = result['data']
    create_time = datetime.fromtimestamp(instance['create_time'])
    
    print(f"实例详情:")
    print(f"实例UUID: {instance['instance_uuid']}")
    print(f"实例名称: {instance['title']}")
    print(f"实例状态: {instance['status']}")
    print(f"GPU名称: {instance['gpu_name']}")
    print(f"GPU数量: {instance['gpu_nums']}")
    print(f"创建时间: {create_time.strftime('%Y-%m-%d %H:%M:%S')}")
    
    if instance['server_url']:
        print("\n服务访问地址:")
        for url in instance['server_url']:
            print(f"  - {url}")
    
    if instance['server_map']:
        print("\n服务详情:")
        for service in instance['server_map']:
            print(f"  {service['title']}: {service['url']}")
            if 'ssh_info' in service:
                ssh = service['ssh_info']
                print(f"    SSH连接: ssh {ssh['username']}@{ssh['host']} -p {ssh['port']}")
else:
    print(f"查询失败: {result['msg']}")

​
响应示例

{
  "code": 0,
  "msg": "查询成功",
  "data": {
    "instance_uuid": "instance-uuid-123",
    "status": 2,
    "title": "实例标题",
    "create_time": 1699000000,
    "start_time": 1699001000,
    "server_url": ["https://example.com"],
    "server_map": [
      {
        "title": "Web服务",
        "url": "https://example.com",
        "port_type": "http",
        "protocol": "tcp",
        "ssh_info": {
          "host": "example.com",
          "port": 22,
          "username": "root",
          "password": "password"
        }
      }
    ],
    "save_image_status": 3,
    "charging_type": 1,
    "shutdown_regular": {
      "shutdown_time": 0,
      "enable": false
    },
    "image_uuid": "image-uuid-123",
    "image_name": "pytorch",
    "image_tag": "2.0",
    "gpu_uuid": "gpu-uuid-123",
    "gpu_name": "RTX 4080",
    "gpu_nums": 1
  }
}

​
说明

  • 只能查看自己的实例
  • 如果实例已删除或隐藏，返回错误提示
  • ssh_info 仅在 port_type 为 ssh 时存在