算力API接口

接口共通部分

Header参数

参数	类型	必填	说明
Authorization	string	是	访问令牌，格式：`Bearer <Token>`

实例接口

实例调用流程

实例接口调用流程图

查询SKU列表

请求地址

GET https://waas.aigate.cc/api/openapi/instance/skuList

Query参数

参数	位置	类型	必填	说明
areaName	query	string	是	可用区可选参数 `华东一区` `华东二区`

返回响应

response (application/json)
├── code: integer               # 业务状态码（0=成功，1=失败）
├── msg: string                 # 业务返回消息
├── errCode: string             # 错误码（失败时返回）
└── data: array<object>         # SKU 列表
|   ├── areaName: string        # 区域名称
|   ├── skuName: string         # SKU 名称
|   ├── price: string           # 价格
|   ├── vmSize: string          # 规格名称
|   ├── cpuMf: string           # CPU 型号
|   ├── cpuCore: integer        # CPU 核心数
|   ├── memorySize: string      # 内存大小
|   ├── sysDiskSize: string     # 系统盘大小
|   └── maxGpuCount: integer    # 最大 GPU 数量
└── ok: boolean                 # 请求是否成功

返回示例：

json

{
    "code": 0,
    "msg": null,
    "errCode": null,
    "data": [
        {
            "areaName": "华东一区",
            "skuName": "4090-24GB-DDR5",
            "price": "199",
            "vmSize": "24",
            "cpuMf": "2.5",
            "cpuCore": 20,
            "memorySize": "100",
            "sysDiskSize": "100",
            "maxGpuCount": 3
        }
    ],
    "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/instance/skuList?areaName=' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/skuList?areaName=',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
url = 'https://waas.aigate.cc/api/openapi/instance/skuList?areaName='
payload = {}
headers = {
  'Authorization': 'Bearer 令牌Token'
}
response = requests.request("GET", url, headers=headers, data = payload)
print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/skuList?areaName=")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php
$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://waas.aigate.cc/api/openapi/instance/skuList?areaName=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => array(
    "Authorization: Bearer 令牌Token"
  ),
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

http

GET /api/openapi/instance/skuList HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

创建实例

请求地址

POST https://waas.aigate.cc/api/openapi/instance/start

Body参数

参数	位置	类型	必填	说明
skuName	body	string	否	SKU 名称（与 `gpuModel` 二选一，必填其一）
gpuModel	body	string	否	GPU 型号（与 `skuName` 二选一，必填其一）
areaName	body	string	是	区域名称
count	body	integer	是	租用 SKU 数量，范围：1–8，默认值：1
imageId	body	integer(int64)	是	镜像 ID
imageType	body	string	是	镜像类型：`1`=系统镜像（暂不支持），`2`=社区镜像，`3`=个人镜像

返回响应

response (application/json)
├─ code : integer     # 业务状态码（0=成功，1=失败）
├─ msg : string       # 返回信息说明
├─ errCode : string   # 错误码（失败时返回）
├─ data : object      # 返回数据
|  ├── instanceId : string          # 实例 ID
|  └── operationStatus : string     # 操作状态
|  └── instanceStatus : string      # 实例状态
|  └── instanceName : string        # 实例名称
|  └── areaName : string            # 区域名称
|  └── count : integer              # 租用 SKU 数量
|  └── imageId : integer            # 镜像 ID
|  └── imageType : string           # 镜像类型
|  └── userId : string              # 用户 ID
|  └── instanceUtilList : array     # 实例工具列表
|  └── chargeType : string          # 镜像计费类型
|  └── skuId : string               # sku ID
└─ ok : boolean                     #true=成功，false=失败

返回示例：

json

{
    "code": 0,
    "msg": null,
    "errCode": null,
    "data": {
        "instanceId": "1096727553686249472",
        "operationStatus": "9",
        "instanceStatus": "9",
        "instanceName": null,
        "areaName": "华东一区",
        "count": 1,
        "imageId": "1096726823955333120",
        "imageType": "3",
        "userId": "1008838404038725632",
        "instanceUtilList": null,
        "chargeType": "0",
        "skuId": "1081967350193463296"
    },
    "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/instance/start' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "skuName": "string",
    "gpuModel": "string",
    "areaName": "string",
    "count": 1,
    "imageId": 0,
    "imageType": "string"
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/instance/start',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "skuName": "string",
      "gpuModel": "string",
      "areaName": "string",
      "count": 1,
      "imageId": 0,
      "imageType": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/instance/start"

payload = json.dumps({
   "skuName": "string",
   "gpuModel": "string",
   "areaName": "string",
   "count": 1,
   "imageId": 0,
   "imageType": "string"
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"skuName\": \"string\",\n    \"gpuModel\": \"string\",\n    \"areaName\": \"string\",\n    \"count\": 1,\n    \"imageId\": 0,\n    \"imageType\": \"string\"\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/start")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/start',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "skuName": "string",
    "gpuModel": "string",
    "areaName": "string",
    "count": 1,
    "imageId": 0,
    "imageType": "string"
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/instance/start HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 140

{
    "skuName": "string",
    "gpuModel": "string",
    "areaName": "string",
    "count": 1,
    "imageId": 0,
    "imageType": "string"
}

实例列表

请求地址

POST https://waas.aigate.cc/api/openapi/instance/page

Body参数

参数	位置	类型	必填	说明
operationStatus	body	string	否	运行状态（`2`=运行中，`4`=已释放，null=计费中）
current	body	integer	是	分页页码
pageSize	body	integer	是	分页大小（最大限制为`20`）

返回响应

response (application/json)
├── code: integer                       # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                         # 业务返回信息
├── errCode: string                     # 错误码（失败时返回）
└── data: object                        # 分页数据
|   ├── total: integer                  # 总记录数
|   └── records: array<object>          # 实例列表
|       ├── instanceId: integer          # 实例订购 id
|       ├── operationStatus: string      # 运行状态
|       ├── instanceName: string         # 实例名称
|       ├── areaName: string             # 区域名称
|       ├── count: integer               # 租用 sku 数量
|       ├── imageId: integer             # 镜像 id
|       └── imageType: string            # 镜像类型('1'=系统镜像，'2'=社区镜像，'3'=个人镜像，'4'=团队镜像)
└── ok : boolean                        #true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": {
    "total": 1,
    "records": [
      {
        "instanceId": "1096749550260588544",
        "operationStatus": "2",
        "instanceName": null,
        "areaName": "华东一区",
        "count": 1,
        "imageId": "1096013560902451200",
        "imageType": "3"
      }
    ]
  },
  "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/instance/page' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operationStatus": "2",
    "current": 1,
    "pageSize": 10
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/instance/page',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "operationStatus": "2",
      "current": 1,
      "pageSize": 10
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/instance/page"

payload = json.dumps({
   "operationStatus": "2",
   "current": 1,
   "pageSize": 10
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"operationStatus\": \"2\",\n    \"current\": 1,\n    \"pageSize\": 10\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/page")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/page',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "operationStatus": "2",
    "current": 1,
    "pageSize": 10
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/instance/page HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 40

{
    "operationStatus": "2",
    "current": 1,
    "pageSize": 10
}

实例详情

请求地址

GET https://waas.aigate.cc/api/openapi/instance/get

Query参数

参数	位置	类型	必填	说明
instanceId	query	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                         # 业务状态码（0=成功，1=失败）
├── msg: string                           # 业务返回消息
├── errCode: string                       # 错误码（失败时返回）
├── data: object (OpInstancePageVO)       # 实例数据
│   ├── instanceId: integer(int64)        # 实例订购 ID
│   ├── operationStatus: string           # 实例运行状态
│   ├── instanceName: string              # 实例名称
│   ├── areaName: string                  # 区域名称
│   ├── count: integer                    # 租用 SKU 数量
│   ├── imageId: integer(int64)           # 镜像 ID
│   ├── imageType: string                 # 镜像类型
│   ├── chargeType: string                # 镜像计费类型
│   └── instanceUtilList: array<object> (InstanceUtilVO)  # 实例工具列表
│       ├── instanceId: integer(int64)    # 实例订购 ID
│       ├── protocol: string              # 工具类型
│       ├── port: integer                 # 端口
│       ├── host: string                  # 主机地址
│       ├── alias: string                 # 别名
│       ├── httpType: string              # HTTP 类型（1=普通 HTTP，2=WS）
│       ├── name: string                  # 工具名称
│       ├── instancePort: string           # 实例端口
│       ├── userAccount: string            # 登录账号
│       ├── password: string               # 密码
│       └── config: string                 # 端口配置
└── ok: boolean                           # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": {
    "instanceId": "1096749550260588544",
    "operationStatus": "2",
    "instanceName": null,
    "areaName": "华东一区",
    "count": 1,
    "imageId": "1096013560902451200",
    "imageType": "3",
    "chargeType": "0",
    "instanceUtilList": [
      {
        "instanceId": "1096749550260588544",
        "protocol": "TCP",
        "port": 22,
        "host": "90b99c2b23174f23b71959c644f6cc83.region1.waas.aigate.cc",
        "alias": null,
        "httpType": "1",
        "name": "ssh",
        "instancePort": "42429",
        "userAccount": "root",
        "password": "52a41fc9246a4a6daf0ab501ab0a6634",
        "config": "{\"containerPort\":22,\"exposedPort\":42429,\"protocol\":\"TCP\"}"
      }
    ]
  },
  "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/instance/get' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/get',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/instance/get"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/get")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/get',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/instance/get HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

实例状态

请求地址

GET https://waas.aigate.cc/api/openapi/instance/status

Query参数

参数	位置	类型	必填	说明
instanceId	query	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
└── data: string                         # 实例状态
|                                        # 1  = 实例创建成功
|                                        # 2  = 运行中
|                                        # 3  = 正在保存
|                                        # 4  = 实例已释放
|                                        # 5  = 正在释放实例
|                                        # 6  = 实例已暂停
|                                        # 7  = 已关机
|                                        # 8  = 正在拉取镜像
|                                        # 9  = 正在初始化实例
|                                        # 10 = 已保存
|                                        # 11 = 正在关机
|                                        # 12 = 实例暂停中
|                                        # 13 = 实例开机中
|                                        # 14 = 取消暂停中
|                                        # 15 = 正在更换镜像
|                                        # 16 = 实例启动中
|                                        # 17 = 准备拉取镜像
|                                        # 18 = 镜像拉取完成
|                                        # 19 = 实例迁移中
|                                        # 20 = 实例重启中
|                                        # 21 = 实例已清理
|                                        # 22 = 实例已关机且镜像已提交
|                                        # 23 = 保存中
|                                        # 24 = 实例不释放镜像正在保存
|                                        # 25 = 实例释放镜像正在保存
└── ok: boolean                          # 请求是否成功

返回示例:

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": "2",
  "ok": true
}

代码示例：

bash

--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/status',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/instance/status"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/status")
   .method("GET", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/status',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/instance/status HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

实例开机

请求地址

GET https://waas.aigate.cc/api/openapi/instance/open

仅当实例的状态=7或者22的时候，调用此接口

Query参数

参数	位置	类型	必填	说明
instanceId	query	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
└── data: string                         # 实例状态
└── ok: boolean                          # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": null,
  "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/instance/open' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/open',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/instance/open"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/open")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/open',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/instance/open HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

实例关机

请求地址

GET https://waas.aigate.cc/api/openapi/instance/close

当实例的状态=2时候，调用此接口

Query参数

参数	位置	类型	必填	说明
instanceId	query	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
└── data: string                         # 实例状态
└── ok: boolean                          # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": null,
  "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/instance/close' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/close',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/instance/close"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/close")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/close',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/instance/close HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

实例重启

请求地址

GET https://waas.aigate.cc/api/openapi/instance/restart

当实例的状态=2时候，调用此接口

Query参数

参数	位置	类型	必填	说明
instanceId	query	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
└── data: string                         # 实例状态
└── ok: boolean                          # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": null,
  "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/instance/restart' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/restart',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/instance/restart"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/restart")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/restart',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/instance/restart HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

释放实例

请求地址

GET https://waas.aigate.cc/api/openapi/instance/release

Query参数

参数	位置	类型	必填	说明
instanceId	query	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
└── data: string                         # 实例状态
└── ok: boolean                          # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": null,
  "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/instance/release' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/instance/release',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/instance/release"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/release")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/release',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/instance/release HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

续租实例

请求地址

POST https://waas.aigate.cc/api/openapi/instance/reOrder

仅支持类型为周期租用且状态是运行中的实例

Body参数

参数	位置	类型	必填	说明
instanceId	body	integer(int64)	是	实例 ID
type	body	string	是	计费方式： 0 = 时（按时计费） 1 = 天（周期计费） 2 = 周（周期计费） 3 = 月（周期计费） 4 = 年（周期计费） 5 = 算力券 6 = 包时
rentTimes	body	integer	是	续租时长：按时：1～24 包天：1～365 包周：1～52 包月：1～12

返回响应

response (application/json)
├─ code : integer     #业务状态码（0=成功，1=失败）
├─ msg : string       #返回信息说明
├─ errCode : string   #错误码（失败时返回）
├─ data : object()    #返回数据
└─ ok : boolean       #true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": null,
  "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/instance/reOrder' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instanceId": 0,
    "type": "0",
    "rentTimes": 0
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/instance/reOrder',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "instanceId": 0,
      "type": "0",
      "rentTimes": 0
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/instance/reOrder"

payload = json.dumps({
   "instanceId": 0,
   "type": "0",
   "rentTimes": 0
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"instanceId\": 0,\n    \"type\": \"0\",\n    \"rentTimes\": 0\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/reOrder")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/reOrder',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "instanceId": 0,
    "type": "0",
    "rentTimes": 0
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/instance/reOrder HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 60

{
    "instanceId": 0,
    "type": "0",
    "rentTimes": 0
}

镜像接口

将实例保存为镜像

请求地址

POST https://waas.aigate.cc/api/openapi/image/save

Body参数

参数	位置	类型	必填	说明
instanceId	body	integer (int64)	是	实例 ID
imageName	body	string	是	保存的镜像名称（长度 5～50 字符）

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
└── data: object                         # 镜像数据
|   ├── worksId: integer              # 镜像 ID
|   ├── name: string                 # 镜像名称
|   ├── status: string               # 保存状态（1=成功，2=保存中，3=失败）
|   ├── size: string                 # 镜像大小（byte）
|   ├── intro: string                # 镜像介绍
|   ├── areaName: string             # 区域名称
|   ├── imageType: string            # 镜像类型（1=系统镜像，2=社区镜像，3=个人镜像）
|   ├── imageChargeInfo: object       # 计费信息
|   │   ├── chargeType: string        # 计费类型（0=免费，1=收费）
|   │   └── price: string             # 价格
|   ├── servicePort: array<object>   # 服务端口列表
|   │   ├── port: integer             # 端口
|   │   ├── protocolName: string      # 协议名称
|   │   ├── protocol: string          # 协议
|   │   └── alias: string             # 别名
|   └── shareLimitPort: array<object> # 镜像共享端口限制
|       ├── port: integer             # 端口
|       ├── protocolName: string      # 协议名称
|       ├── protocol: string          # 协议
|       ├── alias: string             # 别名
|       └── isLimitShare: integer     # 是否限制私有镜像分享端口（1=是，0=否）
└── ok: boolean                        # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": {
    "worksId": "1096760860083888128",
    "name": "一区个人镜像",
    "status": "2",
    "size": null,
    "intro": null,
    "areaName": "华东一区",
    "imageType": "3",
    "imageChargeInfo": {
      "chargeType": "0",
      "price": "0"
    },
    "servicePort": [],
    "shareLimitPort": null,
    "imageVersion": null
  },
  "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/image/save' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "instanceId": 0,
    "imageName": "string"
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/image/save',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "instanceId": 0,
      "imageName": "string"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/image/save"

payload = json.dumps({
   "instanceId": 0,
   "imageName": "string"
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"instanceId\": 0,\n    \"imageName\": \"string\"\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/image/save")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/image/save',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "instanceId": 0,
    "imageName": "string"
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/image/save HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 50

{
    "instanceId": 0,
    "imageName": "string"
}

查询镜像列表

请求地址

POST https://waas.aigate.cc/api/openapi/image/page

个人镜像Body参数

参数	位置	类型	必填	说明
current	body	integer	是	当前页码，默认值：`1`
pageSize	body	integer	是	每页条数，取值范围：`5 ~ 20`，默认值：`10`
imageType	body	string	是	镜像类型：`3` = 个人镜像

社区镜像Body参数

参数	位置	类型	必填	说明
current	body	integer	是	当前页码，默认值：`1`
pageSize	body	integer	是	每页条数，取值范围：`5 ~ 20`，默认值：`10`
imageType	body	string	是	`2` = 社区镜像
areaName	body	string	是	区域：`华东一区`，`华东二区`
skuName	body	string	是	sku名称
imageName	body	string	是	社区镜像名称
imageVersion	body	string	是	镜像版本

返回响应

response (application/json)
├── code: integer                         # 业务状态码（0=成功，1=失败）
├── msg: string                           # 返回信息
├── errCode: string                       # 错误码（失败时返回）
└── data: object                          # 分页数据
|   ├── total: integer                   # 总记录数
|   └── records: array<object>           # 镜像列表
|       ├── worksId: integer              # 镜像 ID
|       ├── name: string                 # 镜像名称
|       ├── status: string               # 保存状态
|       ├── size: string                 # 镜像大小（byte）
|       ├── intro: string                # 镜像介绍
|       ├── areaName: string             # 区域名称
|       ├── imageType: string            # 镜像类型（1=系统镜像，2=社区镜像，3=个人镜像）
|       ├── imageChargeInfo: object       # 计费信息
|       │   ├── chargeType: string        # 计费类型（0=免费，1=收费）
|       │   └── price: string             # 价格
|       ├── servicePort: array<object>   # 服务端口列表
|       │   ├── port: integer             # 端口
|       │   ├── protocolName: string      # 协议名称
|       │   ├── protocol: string          # 协议
|       │   └── alias: string             # 别名
|       └── shareLimitPort: array<object> # 镜像共享端口限制
|           ├── port: integer             # 端口
|           ├── protocolName: string      # 协议名称
|           ├── protocol: string          # 协议
|           ├── alias: string             # 别名
|           └── isLimitShare: integer     # 是否限制私有镜像分享端口（1=是，0=否）
└── ok: boolean                          # true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": {
    "total": 1,
    "records": [
      {
        "worksId": "1096747195809005568",
        "name": "573737",
        "status": "1",
        "size": "15267544026",
        "intro": null,
        "areaName": "华东一区",
        "imageType": "3",
        "imageChargeInfo": null,
        "servicePort": [
          {
            "port": 8888,
            "protocolName": "jupyterlab",
            "protocol": "HTTP",
            "alias": null
          }
        ],
        "shareLimitPort": [
          {
            "port": 8888,
            "protocolName": "jupyterlab",
            "protocol": "HTTP",
            "alias": null,
            "isLimitShare": 0
          }
        ],
        "imageVersion": null
      },
    ]
  },
  "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/image/page' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "current": 1,
    "pageSize": 10,
    "imageType": "3"
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/image/page',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "current": 1,
      "pageSize": 10,
      "imageType": "3"
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/image/page"

payload = json.dumps({
   "current": 1,
   "pageSize": 10,
   "imageType": "3"
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"current\": 1,\n    \"pageSize\": 10,\n    \"imageType\": \"3\"\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/image/page")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/image/page',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "current": 1,
    "pageSize": 10,
    "imageType": "3"
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/image/page HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 62

{
    "current": 1,
    "pageSize": 10,
    "imageType": "3"
}

查询特定实例保存的镜像列表

请求地址

POST https://waas.aigate.cc/api/openapi/instance/image/page

Body参数

参数	位置	类型	必填	说明
current	body	integer	是	当前页码，默认值：1
pageSize	body	integer	是	每页数量，范围：5 ~ 500，默认值：10
instanceId	body	integer	是	实例 ID

返回响应

response (application/json)
├── code: integer                         # 业务状态码（0=成功，1=失败）
├── msg: string                           # 业务返回消息
├── errCode: string                       # 错误码（失败时返回）
└── data: object                          # 镜像分页数据
    ├── total: integer                   # 镜像总数
    └── records: array<object>           # 镜像列表
        ├── worksId: integer             # 镜像 ID
        ├── name: string                 # 镜像名称
        ├── status: string               # 保存状态
        ├── size: string                 # 镜像大小（byte）
        ├── intro: string                # 镜像介绍
        ├── areaName: string             # 区域名称
        ├── imageType: string            # 镜像类型（1=系统镜像，2=社区镜像，3=个人镜像）
        ├── imageChargeInfo: object      # 计费信息
        │   ├── chargeType: string       # 计费类型（0=免费，1=收费）
        │   └── price: string            # 价格
        ├── servicePort: array<object>   # 服务端口列表
        │   ├── port: integer            # 端口
        │   ├── protocolName: string     # 协议名称
        │   ├── protocol: string         # 协议
        │   └── alias: string            # 别名
        └── shareLimitPort: array<object> # 共享端口限制列表
        │   ├── port: integer            # 端口
        │   ├── protocolName: string     # 协议名称
        │   ├── protocol: string         # 协议
        │   ├── alias: string            # 别名
        │   └── isLimitShare: integer    # 是否限制私有镜像分享端口（1=是，0=否）
        └── imageVersion: string         # 镜像版本

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": {
    "total": 1,
    "records": [
      {
        "worksId": "1096013560902451200",
        "name": "实例镜像1",
        "status": "1",
        "size": "43969691561",
        "intro": null,
        "areaName": "华东一区",
        "imageType": "3",
        "imageChargeInfo": null,
        "servicePort": [
            {
              "port": 8888,
              "protocolName": "JupyterLab",
              "protocol": "HTTP",
              "alias": null
            }
        ],
        "shareLimitPort": [
            {
              "port": 8888,
              "protocolName": "JupyterLab",
              "protocol": "HTTP",
              "alias": null,
              "isLimitShare": 0
            }
          ],
        "imageVersion": null
      }
    ]
  },
  "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/instance/image/page' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "current": 1,
    "pageSize": 10,
    "instanceId": 0
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/instance/image/page',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "current": 1,
      "pageSize": 10,
      "instanceId": 0
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/instance/image/page"

payload = json.dumps({
   "current": 1,
   "pageSize": 10,
   "instanceId": 0
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"current\": 1,\n    \"pageSize\": 10,\n    \"instanceId\": 0\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/instance/image/page")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/instance/image/page',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "current": 1,
    "pageSize": 10,
    "instanceId": 0
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/instance/image/page HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 61

{
    "current": 1,
    "pageSize": 10,
    "instanceId": 0
}

查询镜像详情

请求地址

POST https://waas.aigate.cc/api/openapi/image/get

Body参数

参数	位置	类型	必填	说明
imageType	body	string	是	镜像类型：`1`=系统镜像（暂不支持），`2`=社区镜像，`3`=个人镜像
imageId	body	integer	是	镜像 ID（int64）

返回响应

response (application/json)
├── code: integer                         # 业务状态码（0=成功，1=失败）
├── msg: string                           # 业务返回消息
├── errCode: string                       # 错误码（失败时返回）
└── data: object                          # 镜像信息
    ├── worksId: integer                 # 镜像 ID（int64）
    ├── name: string                     # 镜像名称
    ├── status: string                   # 保存状态
    ├── size: string                     # 镜像大小（byte）
    ├── intro: string                    # 镜像介绍
    ├── areaName: string                 # 区域名称
    ├── imageType: string                # 镜像类型（1=系统镜像，2=社区镜像，3=个人镜像）
    ├── imageChargeInfo: object           # 计费信息
    │   ├── chargeType: string            # 计费类型（0=免费，1=收费）
    │   └── price: string                 # 价格
    ├── servicePort: array<object>        # 服务端口列表
    │   ├── port: integer                 # 端口
    │   ├── protocolName: string          # 协议名称
    │   ├── protocol: string              # 协议
    │   └── alias: string                 # 别名
    └── shareLimitPort: array<object>     # 共享端口限制列表
    |   ├── port: integer                 # 端口
    |   ├── protocolName: string          # 协议名称
    |   ├── protocol: string              # 协议
    |   ├── alias: string                 # 别名
    |   └── isLimitShare: integer          # 是否限制私有镜像分享端口（1=是，0=否）
    └── imageVersion: string              # 镜像版本

返回示例：

json

{
    "code": 0,
    "msg": null,
    "errCode": null,
    "data": {
        "worksId": "1096760860083888128",
        "name": "一区镜像1",
        "status": "1",
        "size": "24161824343",
        "intro": null,
        "areaName": "华东一区",
        "imageType": "3",
        "imageChargeInfo": {
            "chargeType": "0",
            "price": "0"
        },
        "servicePort": [
            {
                "port": 8888,
                "protocolName": "jupyterlab",
                "protocol": "HTTP",
                "alias": null
            }
        ],
        "shareLimitPort": [
            {
                "port": 8888,
                "protocolName": "jupyterlab",
                "protocol": "HTTP",
                "alias": null,
                "isLimitShare": 0
            }
        ],
        "imageVersion": null
    },
    "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/image/get' \
--header 'Authorization: Bearer 令牌Token' \
--header 'Content-Type: application/json' \
--data-raw '{
    "imageType": "string",
    "imageId": 0
}'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/image/get',
   'headers': {
      'Authorization': 'Bearer 令牌Token',
      'Content-Type': 'application/json'
   },
   body: JSON.stringify({
      "imageType": "string",
      "imageId": 0
   })

};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests
import json

url = "https://waas.aigate.cc/api/openapi/image/get"

payload = json.dumps({
   "imageType": "string",
   "imageId": 0
})
headers = {
   'Authorization': 'Bearer 令牌Token',
   'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"imageType\": \"string\",\n    \"imageId\": 0\n}");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/image/get")
   .method("POST", body)
   .addHeader("Authorization", "Bearer 令牌Token")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/image/get',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'{
    "imageType": "string",
    "imageId": 0
}',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/image/get HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token
Content-Type: application/json
Content-Length: 47

{
    "imageType": "string",
    "imageId": 0
}

删除镜像

请求地址

GET https://waas.aigate.cc/api/openapi/image/destroy

Query参数

参数	位置	类型	必填	说明
imageId	query	integer	是	镜像 ID（int64）

返回响应

response (application/json)
├── code: integer                        # 业务状态码（0 = 成功，1 = 失败）
├── msg: string                          # 业务返回消息
├── errCode: string                      # 错误码（失败时返回）
├─ data : object()                       #返回数据
└─ ok : boolean                          #true=成功，false=失败

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": null,
  "ok": true
}

代码示例：

bash

curl --location --request GET 'https://waas.aigate.cc/api/openapi/image/destroy?imageId' \
--header 'Authorization: Bearer 令牌Token'

javascript

var request = require('request');
var options = {
   'method': 'GET',
   'url': 'https://waas.aigate.cc/api/openapi/image/destroy?imageId',
   'headers': {
      'Authorization': 'Bearer 令牌Token'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/image/destroy?imageId"

payload={}
headers = {
   'Authorization': 'Bearer 令牌Token'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/image/destroy?imageId")
   .get()
   .addHeader("Authorization", "Bearer 令牌Token")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/image/destroy?imageId',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'GET',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer 令牌Token'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

GET /api/openapi/image/destroy?imageId=null HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer 令牌Token

账户接口

查询账户余额

请求地址

POST https://waas.aigate.cc/api/openapi/user/balance

返回响应

response (application/json)
├── code: integer                 # 业务状态码（0=成功，1=失败）
├── msg: string                   # 业务返回消息
├── errCode: string               # 错误码（失败时返回）
└── data: object                  # 余额信息
|   └── balance: string           # 账户余额
└── ok: boolean                   # 请求是否成功

返回示例：

json

{
  "code": 0,
  "msg": null,
  "errCode": null,
  "data": {
    "balance": "12898"
  },
  "ok": true
}

代码示例：

bash

curl --location --request POST 'https://waas.aigate.cc/api/openapi/user/balance' \
--header 'Authorization: Bearer <token>'

javascript

var request = require('request');
var options = {
   'method': 'POST',
   'url': 'https://waas.aigate.cc/api/openapi/user/balance',
   'headers': {
      'Authorization': 'Bearer <token>'
   }
};
request(options, function (error, response) {
   if (error) throw new Error(error);
   console.log(response.body);
});

python

import requests

url = "https://waas.aigate.cc/api/openapi/user/balance"

payload={}
headers = {
   'Authorization': 'Bearer <token>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

java

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
   .url("https://waas.aigate.cc/api/openapi/user/balance")
   .method("POST", body)
   .addHeader("Authorization", "Bearer <token>")
   .build();
Response response = client.newCall(request).execute();

php

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://waas.aigate.cc/api/openapi/user/balance',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_HTTPHEADER => array(
      'Authorization: Bearer <token>'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

http

POST /api/openapi/user/balance HTTP/1.1
Host: waas.aigate.cc
Authorization: Bearer <token>

算力API接口 ​

接口共通部分 ​

实例接口 ​

实例调用流程 ​

查询SKU列表 ​

创建实例 ​

实例列表 ​

实例详情 ​

实例状态 ​

实例开机 ​

实例关机 ​

实例重启 ​

释放实例 ​

续租实例 ​

镜像接口 ​

将实例保存为镜像 ​

查询镜像列表 ​

查询特定实例保存的镜像列表 ​

查询镜像详情 ​

删除镜像 ​

账户接口 ​

查询账户余额 ​

算力API接口

接口共通部分

实例接口

实例调用流程

查询SKU列表

创建实例

实例列表

实例详情

实例状态

实例开机

实例关机

实例重启

释放实例

续租实例

镜像接口

将实例保存为镜像

查询镜像列表

查询特定实例保存的镜像列表

查询镜像详情

删除镜像

账户接口

查询账户余额