九章智算云

获取实例列表

查询CCI容器计算实例的列表信息。

GEThttps://api.alayanew.com/v1/cci/instance/list

鉴权(Authorizations)

AuthorizationString必填

用户可通过已获取的 Open API Key 做验证。例如:Bearer [YOUR_API_KEY]

Query Parameters

pageNoInteger

页码,从 1 开始。例如:1

pageSizeInteger

每页数量。例如:20

nameString

实例名称模糊查询。例如:my-cci-instance

tenantIdString

租户ID。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a

statusString

实例状态过滤,可选值:PENDINGRUNNINGSTOPPEDERRORRELEASING 等。例如:RUNNING

idString

实例ID。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a

orderInstanceIdString

订单实例ID。例如:ca78d6b9-e196-5a0f-b1be-ab036b3cb91a

aidcIdInteger

AIDC ID 过滤。例如:1

Response

statusInteger

业务状态码,200表示成功。

messageString

接口响应信息,成功或失败原因描述。例如:"OK"

dataObject

接口返回的数据对象,包含实例列表及分页信息。

显示 properties
recordsArray

实例列表数组。

显示properties
idString

实例ID。例如:"ca78d6b9-e196-5a0f-b1be-ab036b3cb91a"

nameString

实例名称。例如:"cci-demo-test"

descriptionString

实例描述。例如:"测试实例"

orderInstanceIdString

订单实例ID。例如:"ca78d6b9-e196-5a0f-b1be-ab036b3cb91a"

statusString

实例状态。例如:"RUNNING"

priorityInteger

优先级。例如:1

subStatusString

子状态。例如:"RUNNING"

createTimeString

创建时间。例如:"2025-12-10 00:00:00"

updateTimeString

更新时间。例如:"2025-12-10 23:59:59"

startTimeString

启动时间。例如:"2025-12-10 00:00:00"

stopTimeString

停止时间。例如:"2025-12-10 23:59:59"

releaseTimeString

释放时间。例如:"2025-12-10 23:59:59"

autoStopTimeString

自动停止时间。例如:"2023-12-10 00:00:00"

autoReleaseTimeString

自动删释放时间。例如:"2023-12-10 23:59:59"

autoStopEnableBoolean

自动关机开关。例如:true

autoReleaseEnableBoolean

自动删释放开关。例如:true

imageString

镜像地址。例如:"tableagent-registry-vpc.cn-beijing.cr.aliyuncs.com/project01/bs:v1"

aidcIdInteger

智算中心ID。例如:17

resourceObject

资源信息。

显示 properties
cpuCoresString

CPU 核数。例如:"2"

memoryGBString

内存 (GB)。例如:"4"

gpuNameString

GPU 型号;无则为 "-" 或 null。例如:"-"

gpuCountString

GPU 个数。例如:"1"

diskGBString

系统盘容量 (GB)。例如:"50"

productNameString

产品名(资源类型)。例如:"云容器实例1"

productCodeString

产品编码。例如:"PRD-CCI-1"

envObject

环境变量。

显示 properties
Additional propertiesString

环境变量键值对,值为字符串类型。

tenantIdString

租户ID。

tenantNameString

租户名称。

createdByString

创建者Id。

creatorNameString

创建者名称。

webSSHUrlString

webssh 地址。

jupyterUrlString

jupyter 地址。

jupyterHealthBoolean

jupyter服务是否可用。

vscodeUrlString

vscode 地址。

vscodeHealthBoolean

vscode服务是否可用。

nowString

当前服务器时间,例如:"2025-09-01 19:00:00"

saveImageStatusBoolean

是否处于镜像保存中。例如:true

storageSizeInteger

挂载存储大小。

bundleBoolean

是否打包。

pageNoInteger

页码。例如:1

pageSizeInteger

每页行数。例如:20

totalRowsInteger

总行数。例如:20

curl -X 'GET' \
  'https://api.alayanew.com/v1/cci/instance/list?pageNo=1&pageSize=20&name=my-cci-instance&tenantId=ca78d6b9-e196-5a0f-b1be-ab036b3cb91a&status=RUNNING&id=ca78d6b9-e196-5a0f-b1be-ab036b3cb91a&orderInstanceId=ca78d6b9-e196-5a0f-b1be-ab036b3cb91a&aidcId=1' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer [YOUR_API_KEY]'
import requests
from urllib.parse import urlencode

base_url = "https://api.alayanew.com/v1/cci/instance/list"

params = {
    "pageNo": 1,
    "pageSize": 20,
    "name": "my-cci-instance",
    "tenantId": "ca78d6b9-e196-5a0f-b1be-ab036b3cb91a",
    "status": "RUNNING",
    "id": "ca78d6b9-e196-5a0f-b1be-ab036b3cb91a",
    "orderInstanceId": "ca78d6b9-e196-5a0f-b1be-ab036b3cb91a",
    "aidcId": 1
}

url = f"{base_url}?{urlencode(params)}"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer [YOUR_API_KEY]"
}

response = requests.get(url, headers=headers)

print(response.text)
const params = new URLSearchParams({
  pageNo: '1',
  pageSize: '20',
  name: 'my-cci-instance',
  tenantId: 'ca78d6b9-e196-5a0f-b1be-ab036b3cb91a',
  status: 'RUNNING',
  id: 'ca78d6b9-e196-5a0f-b1be-ab036b3cb91a',
  orderInstanceId: 'ca78d6b9-e196-5a0f-b1be-ab036b3cb91a',
  aidcId: '1'
});

const url = `https://api.alayanew.com/v1/cci/instance/list?${params.toString()}`;

fetch(url, {
  method: 'GET',
  headers: {
    'accept': 'application/json',
    'Authorization': 'Bearer [YOUR_API_KEY]'
  }
})
  .then(response => response.text())
  .then(data => console.log(data))
  .catch(error => console.error(error));
{
  "status": 200,
  "message": "OK",
  "data": {
    "records": [
      {
        "id": "00964ce3-b99c-43da-8826-ab9c5574eef2",
        "name": "实例123",
        "description": "我的实例",
        "orderInstanceId": "00964ce3-b99c-43da-8826-ab9c5574eef2",
        "status": "RUNNING",
        "priority": 3,
        "subStatus": "ERROR",
        "createTime": "2023-12-10 00:00:00",
        "updateTime": "2023-12-10 23:59:59",
        "startTime": "2023-12-10 00:00:00",
        "stopTime": "2023-12-10 23:59:59",
        "releaseTime": "2023-12-10 23:59:59",
        "autoStopTime": "2023-12-10 00:00:00",
        "autoReleaseTime": "2023-12-10 23:59:59",
        "autoStopEnable": true,
        "autoReleaseEnable": true,
        "image": "tableagent-registry-vpc.cn-beijing.cr.aliyuncs.com/project01/bs:v1",
        "aidcId": 17,
        "resource": {
          "cpuCores": "2",
          "memoryGB": "4",
          "gpuName": "-",
          "gpuCount": "1",
          "diskGB": "50",
          "productName": "云容器实例1",
          "productCode": "PRD-CCI-1"
        },
        "env": {
          "additionalProp1": "string",
          "additionalProp2": "string",
          "additionalProp3": "string"
        },
        "tenantId": "string",
        "tenantName": "string",
        "createdBy": "string",
        "creatorName": "string",
        "webSSHUrl": "string",
        "jupyterUrl": "string",
        "jupyterHealth": true,
        "vscodeUrl": "string",
        "vscodeHealth": true,
        "now": "2025-09-01 19:00:00",
        "saveImageStatus": true,
        "storageSize": 9007199254740991,
        "bundle": true
      }
    ],
    "pageNo": 1,
    "pageSize": 20,
    "totalRows": 120
  }
}
{
  "status": 403,
  "message": "Forbidden",
  "data": {}
}
{
  "status": 500,
  "message": "Internal Server Error",
  "data": {}
}

最后更新于