获取开发者密钥

此密钥为平台API操作唯一标识，务必保证不要泄露

❗️登录OneThingAI平台，进入账户中心，选择开发者密钥自助创建密钥

简介

OneThingAI平台向用户开放平台大部分使用相关API。您可以使用本文档介绍的API对您的实例进行管理。

域名：https://api-lab.onethingai.com

内容格式：application/json

必须请求头信息

创建实例的整体流程：

销毁实例的整体流程：

也可以使用以下python 的sdk来操作实例管理 API

sdk 地址： onethingai-pilot ， 简单例子： example

参考SDK 例子的代码：

接口列表

通用返回字段说明

注：实例创建、关机、开机、卸载接口均为单实例操作，不支持批量操作

1、我的镜像列表接口

接口地址：/api/v2/app/private/image/list

接口描述：拉取我的镜像列表接口

请求方式：GET

请求参数

主要返回字段说明

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v2/app/private/image/list' \
-H 'Authorization: Bearer {TOKEN}' 

返回例子

{
    "code": 0,
    "data": {
        "privateImageList": [
            {
                "appImageDescription": "",
                "appImageId": "PRIVATE_bg2ypp16lc4598yb-m6vubese-ki882u9l",
                "appImageName": "放大",
                "appImageStatus": 4,
                "appImageTotalSize": 79.707,
                "createdAt": 1724585700,
                "regionId": 2,
                "updatedAt": 1724728171
            },
            {
                "appImageDescription": "",
                "appImageId": "PRIVATE_aozzjm3p1st3xm2w-7mkhact9-9wyz0dsw",
                "appImageName": "波普头像",
                "appImageStatus": 4,
                "appImageTotalSize": 12106.064,
                "createdAt": 1723535516,
                "regionId": 2,
                "updatedAt": 1723536042
            }
        ]
    },
    "msg": "Success"
}

2、官方镜像、社区镜像列表接口

接口地址：/api/v1/app/publish/image/list

接口描述：拉取官方镜像、社区镜像列表接口

请求方式：GET

请求参数

主要返回字段说明

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/app/publish/image/list?appImageName=PyTorch&appImageAuthor=官方版' \
-H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "publishImageList": [
            {
                "appImageAuthor": "官方版",
                "appImageDescription": "强大的节点式stable diffusion",
                "appImageId": "PUBLIC_6",
                "appImageName": "ComfyUI",
                "appImageVersion": "v0.0.66",
                "createdAt": 1703721600,
                "updatedAt": 1734624600
            },
            {
                "appImageAuthor": "官方版",
                "appImageDescription": "强大的节点式stable diffusion",
                "appImageId": "PUBLIC_63",
                "appImageName": "ComfyUI稳定版",
                "appImageVersion": "v0.0.51",
                "createdAt": 1724331924,
                "updatedAt": 1734624601
            }
        ]
    },
    "msg": "Success"
}

3、资源拉取接口

请求地址：/api/v2/resources

接口描述：获取资源情况，返回参数中的maxGpuNum大于0的GPU类型才可以成功创建实例

请求方式：GET

请求参数

主要返回字段说明

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v2/resources?appImageId=PUBLIC_6&regionId=6' \
-H 'Authorization: Bearer {TOKEN}' 

返回例子

{
    "code": 0,
    "data": {
        "resourceList": [
            {
                "gpuType": "NVIDIA-A100-PCIE-40GB",
                "regionId": 6,
                "maxGpuNum": 0
            },
            {
                "gpuType": "NVIDIA-GEFORCE-RTX-4090",
                "regionId": 6,
                "maxGpuNum": 2
            },
            {
                "gpuType": "NVIDIA-GEFORCE-RTX-3090",
                "regionId": 6,
                "maxGpuNum": 0
            },
            {
                "gpuType": "NVIDIA-GEFORCE-RTX-3060",
                "regionId": 6,
                "maxGpuNum": 0
            }
        ]
    },
    "msg": "Success"
}

4、实例创建接口

接口地址：/api/v2/app

接口描述：支持官方镜像、社区镜像、我的镜像创建实例

请求方式：POST

请求参数

envs:

customPort:

curl 请求例子

curl -X POST 'https://api-lab.onethingai.com/api/v2/app' \
-H 'Authorization: Bearer {TOKEN}' \
-H 'Content-Type: application/json' \
-d' {
  "appImageId": "PRIVATE_eut5hud01926m5v5-qurjaoaq-vhbamj7l",
  "billType": 3,
  "gpuNum": 1,
  "regionId": 2,
  "gpuType": "NVIDIA-GEFORCE-RTX-4090", 
  "duration":0, 
  "groupId": "",
  "envs":[
        {
            "name": "myenv",
            "value": "import"
        },
        {
            "name": "myenv1",
            "value": "import1"
        }
    ],
  "customPort": [
      {
        "localPort": 1123,
        "type": "http"
      },
      {
        "localPort": 1124,
        "type": "http"
      }]
}'

返回例子

{
    "code":0
    "msg": "Success"
    "data": {
       "appId": "qyejicqiez7iwi7a-byswmjqd",
       "groupId": "xxxxx"  	
   }
}

5、实例列表接口

接口地址：/api/v2/app

接口描述：获取已创建实例列表

请求方式：GET

请求参数

主要返回字段说明

customPort:

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v2/app?page=1&pageSize=100' -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "appList": [
            {
                "appId": "548iag9wzvfxkk63-bam7jpt5",
                "appImageAuthor": "官方版",
                "appImageId": "PUBLIC_6",
                "appImageName": "ComfyUI",
                "appImageVersion": "v0.0.66",
                "billType": 3,
                "createdAt": 1734685267,
                "customName": "",
                "customPort": [],
                "errCode": 0,
                "expiredAt": 0,
                "gpuType": "NVIDIA-GEFORCE-RTX-4090",
                "groupId": "",
                "prePrice": 1.131,
                "price": 0.039,
                "regionId": 6,
                "runtime": 1716,
                "startedAt": 1734685267,
                "status": 300,
                "stoppedAt": 0,
                "systemDiskSize": 71680,
                "systemDiskSizeUsed": 24,
                "webUIAddress": ""
            },
            {
                "appId": "aagz63qkmhltsma1-eln150q2",
                "appImageAuthor": "官方版",
                "appImageId": "",
                "appImageName": "PyTorch",
                "appImageVersion": "PyTorch/2.0.1/3.10(ubuntu22.04)/11.7.1",
                "billType": 3,
                "createdAt": 1734421450,
                "customName": "",
                "customPort": [],
                "errCode": 0,
                "expiredAt": 1735159512,
                "gpuType": "NVIDIA-GEFORCE-RTX-4090",
                "groupId": "",
                "prePrice": 0,
                "price": 0.039,
                "regionId": 6,
                "runtime": 0,
                "startedAt": 0,
                "status": 800,
                "stoppedAt": 1734554712,
                "systemDiskSize": 71680,
                "systemDiskSizeUsed": 16,
                "webUIAddress": ""
            }
        ],
        "pagination": {
            "page": 1,
            "pageSize": 100,
            "total": 3
        }
    },
    "msg": "Success"
}

6、实例停用接口

接口地址：/api/v1/app/operate/shutdown/{appId}

接口描述：实例停用

请求方式：PUT

请求参数

无

curl 请求例子

curl -X PUT 'https://api-lab.onethingai.com/api/v1/app/operate/shutdown/ingr4j8rw3gtopnq-8kevdtua' -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code":0,
    "data": null,
    "msg": "Success"
}

7、实例启用接口

接口地址：/api/v1/app/operate/boot/{appId}

接口描述：实例开机

请求方式：PUT

请求参数

无

curl 请求例子

curl -X PUT 'https://api-lab.onethingai.com/api/v1/app/operate/boot/ingr4j8rw3gtopnq-8kevdtuz' -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code":0,
    "data": null,
    "msg": "Success"
}

8、实例卸载接口

接口地址：/api/v1/app/{appId}

接口描述：实例卸载

请求方式：DELETE

请求参数

无

curl 请求例子

curl -X DELETE 'https://api-lab.onethingai.com/api/v1/app/ingr4j8rw3gtopnq-8kevdtuz'  -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code":0,
    "data": null,
    "msg": "Success"
}

9、实例cpu使用率接口

接口地址：/api/v1/app/{appId}/monitor/cpuutil

接口描述：实例cpu使用率数据接口，只能查询近30分钟数据

请求方式：GET

请求参数

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/app/548iag9wzvfxkk63-bam7jpt5/monitor/cpuutil?startTime=1734686115&endTime=1734687915'  -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "list": [
            {
                "category": "cpuutil",
                "time": 1734688001,
                "value": 0.399020540372
            },
            {
                "category": "cpuutil",
                "time": 1734688016,
                "value": 0.321672586274
            },
            {
                "category": "cpuutil",
                "time": 1734688031,
                "value": 0.321672586274
            },
            {
                "category": "cpuutil",
                "time": 1734688046,
                "value": 0.587348224677
            }
        ]
    },
    "msg": "Success"
}

10、实例gpumemory使用数据接口

接口地址：/api/v1/app/{appId}/monitor/gpumemory

接口描述：实例gpumemory使用数据接口，只能查询近30分钟数据，单位MB

请求方式：GET

请求参数

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/app/548iag9wzvfxkk63-bam7jpt5/monitor/gpumemory?startTime=1734686115&endTime=1734687915'  -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "list": [
            {
                "category": "gpumemory:0",
                "time": 1734688001,
                "value": 543
            },
            {
                "category": "gpumemory:0",
                "time": 1734688016,
                "value": 543
            },
            {
                "category": "gpumemory:0",
                "time": 1734688031,
                "value": 543
            },
            {
                "category": "gpumemory:0",
                "time": 1734688046,
                "value": 543
            }
        ]
    },
    "msg": "Success"
}

11、实例memory使用数据接口

接口地址：/api/v1/app/{appId}/monitor/memory

接口描述：实例memory使用数据接口，只能查询近30分钟数据，单位MB

请求方式：GET

请求参数

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/app/548iag9wzvfxkk63-bam7jpt5/monitor/memory?startTime=1734686115&endTime=1734687915'  -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "list": [
            {
                "category": "memory",
                "time": 1734688001,
                "value": 1881.55859375
            },
            {
                "category": "memory",
                "time": 1734688016,
                "value": 1882.578125
            },
            {
                "category": "memory",
                "time": 1734688031,
                "value": 1882.578125
            },
            {
                "category": "memory",
                "time": 1734688046,
                "value": 1882.58203125
            }
        ]
    },
    "msg": "Success"
}

12、实例gpu使用率接口

接口地址：/api/v1/app/{appId}/monitor/gpuutil

接口描述：实例gpu使用率数据接口，只能查询近30分钟数据

请求方式：GET

请求参数

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/app/548iag9wzvfxkk63-bam7jpt5/monitor/gpuutil?startTime=1734686115&endTime=1734687915'  -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "list": [
            {
                "category": "gpuutil:0",
                "time": 1734688001,
                "value": 0
            },
            {
                "category": "gpuutil:0",
                "time": 1734688016,
                "value": 0
            },
            {
                "category": "gpuutil:0",
                "time": 1734688031,
                "value": 0
            },
            {
                "category": "gpuutil:0",
                "time": 1734688046,
                "value": 0
            }
        ]
    },
    "msg": "Success"
}

13、用户余额查询接口

请求地址：/api/v1/account/wallet/detail

接口描述：获取用户余额列表

请求方式：GET

请求参数

无

主要返回字段说明

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/account/wallet/detail' -H 'Authorization: Bearer {TOKEN}' 

返回例子

{
    "code": 0,
    "msg": "Success",
    "data": {
      "availableBalance": 0.05,
      "availableVoucherCash": 72.93,
      "consumeCashTotal": 6,
    }
}

14、用户消费账单查询接口

请求地址：/api/v2/account/wallet/consume/query

接口描述：获取用户消费账单

请求方式：GET

请求参数

主要返回字段说明

curl 请求例子

curl 'https://api-lab.onethingai.com/api/v1/account/wallet/consume/query?page=2&pageSize=100' -H 'Authorization: Bearer {TOKEN}'

返回例子

{
    "code": 0,
    "data": {
        "orderList": [
            {
                "actualPayCash": 0.14,
                "appId": "",
                "billType": 0,
                "businessType": 5,
                "consumeCash": 0.16,
                "createdAt": 1734623959,
                "event": "",
                "orderId": "20241219235919001026297440",
                "runtime": 0,
                "totalDiscountPrice": 0,
                "voucherDeductCash": 0.02
            },
            {
                "actualPayCash": 0,
                "appId": "aagz63qkmhltsma1-eln150q2",
                "billType": 3,
                "businessType": 1,
                "consumeCash": 11.08,
                "createdAt": 1734554712,
                "event": "关机扣费",
                "orderId": "20241219044512001016056266",
                "runtime": 17112,
                "totalDiscountPrice": 0,
                "voucherDeductCash": 11.08
            }
        ],
        "pagination": {
            "total": 966,
            "page": 1,
            "pageSize": 2
        }
    },
    "msg": "Success"
}