Skip to content

2.项目

1. 创建项目

接口地址: /v1/project

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.10.0

接口描述:

创建项目

请求参数:

参数 数据类型 位置 是否必须 描述
name integer body true 项目名称,项目名称
remark integer body false 备注信息
standard string body false 是否为默认项目,设置为默认项目后,之前的默认项目将变成非默认项目。板卡资源、容器资源、镜像资源、业务网络都是归属于项目下的单元,若对这些资源进行增加或查询时需要指定对应的项目id,如果不传则默认获取用户有权限项目中的默认项目。  

请求示例,实际请求请替换参数值:

POST "/openapi/v1/project"
body:
{
    "name": "ttt",
    "remark": "test_create"
}

响应参数:

参数 数据类型 描述
code integer(int32) 返回代码
message string 返回处理消息
timestamp integer(int64) 时间戳
traceId string 请求处理ID,请求ID

响应示例:

{

    "message": "操作成功!",
    "code": 200,
    "result": "创建项目成功",
    "timestamp": 1720161166348,
    "traceId": "C20240705143246348042"
}

2. 项目列表

接口地址: /v1/project/list

请求方式:POST

请求数据类型:application/json

响应数据类型:*/*,application/json

支持版本:v1.10.0

接口描述:

获取项目列表

请求参数: 无

请求示例,实际请求请替换参数值:

POST "/openapi/v1/project/list"

响应参数:

参数 数据类型 描述
code integer 返回代码
message string 返回处理消息
result list<object> 返回数据对象
  uuid string 项目UUID
  name string 项目名称
  remark string 备注信息
  owner integer 项目所有者ID
  ownerName string 项目所有者名称
  standard boolean 是否默认项目,为true是默认项目
  status integer 是否启用,1启用,0停用
  limitArmcard long 项目可申请的板卡数
  cardNum integer 板卡数量
  createTime string 项目创建时间
timestamp integer 时间戳
traceId string 请求处理ID

响应示例:

{

    "message": "操作成功!",
    "code": 200,
    "result": [
        {
            "uuid": "4fef186e57b64e64e57666db378e6135",
            "name": "ttt",
            "remark": "test_create",
            "owner": 2,
            "createTime": "2024-07-05 14:32:46",
            "standard": false,
            "status": 1,
            "ownerName": "public",
            "limitArmcard": 100,
            "cardNum": 10
        }
    ],
    "timestamp": 1720161270363,
    "traceId": "C20240705143430363013"
}