1.区域和节点

1. 区域分页列表

接口地址: /v1/area/page/list

请求方式: POST

请求数据类型: application/json

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

支持版本: v1.0.0

接口描述:

分页查询区域，含区域名，具体位置等区域创建信息

请求示例:

POST "/openapi/v1/area/page/list?time=1720774436&sign=3bbf04e6c524bc028d543148ea55447cad066f896431980e01d80488d1212807" 
body
{
    "field": "createTime",
    "order": "descending",
    "pageNum": 1,
    "pageSize": 10
}

请求参数:

参数	数据类型	位置	是否必须	描述
field	string	body	false	排序字段
name	string	body	false	区域名称
order	string	body	false	排序规则，descending/ascending
pageNum	integer	body	false	当前页码，默认 1
pageSize	integer	body	false	当前页面数据量，默认 10

响应参数:

参数	类型	描述
code	integer(int32)	返回代码
message	string	返回处理消息
result	IPage<object>	返回数据对象
records	list<object>	当前页的数据列表
uuid	string	uuid
name	string	区域名称
position	string	位置
status	integer	状态，0:停用 1:启用
remark	string	备注
total	integer	总记录数
current	integer	当前页码
pages	integer	总页数
size	integer	每页显示条数
timestamp	integer(int64)	时间戳
traceId	boolean	请求处理ID

响应示例:

{
    "message": "操作成功！",  //(1)!
    "code": 200,
    "result": {
        "total": 1,
        "current": 1,
        "pages": 1,
        "size": 10,
        "records": [
            {
                "uuid": "a8a4c72bb116e765d079e93c174e5b03",
                "name": "sz",
                "position": "广东省-深圳市-南山区",
                "remark": "验证区域备注20250418\n验证区域备注20250422\n验证区域备注20250620",
                "status": 1
            }
        ]
    },
    "timestamp": 1755223854528,
    "traceId": "C20250815101054528102"
}

接口出错时message必定不为空

2. 区域详情

接口地址: /v1/area/details/{uuid}

请求方式: GET

请求数据类型: *

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

支持版本: v1.0.0

接口描述:

查询区域详情，含该区域下节点数，服务器数，板卡数，容器数等

请求参数:

参数	数据类型	位置	是否必须	描述
uuid	string	path	true	区域 uuid

响应参数:

参数	数据类型	描述
code	integer(int32)	返回代码
message	string	返回处理消息
result	object	返回数据对象
uuid	string	uuid
name	string	名称
status	integer	启用状态，0:停用 1:启用
position	string	位置
remark	string	备注
timestamp	integer(int64)	时间戳
traceId	string	请求处理ID

响应示例:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "status": 1,
        "name": "sz",
        "remark": "验证区域备注20250418\n验证区域备注20250422\n验证区域备注20250620",
        "uuid": "a8a4c72bb116e765d079e93c174e5b03",
        "position": "广东省-深圳市-南山区"
    },
    "timestamp": 1755224065415,
    "traceId": "C20250815101425415066"
}

3. 节点分页列表

接口地址: /v1/node/page/list

请求方式: POST

请求数据类型: application/json

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

支持版本: v1.0.0

接口描述:

分页查询节点信息

请求参数:

参数	数据类型	位置	是否必须	描述
field	string	body	false	排序字段
name	string	body	false	节点名称
order	string	body	false	排序规则，descending/ascending
pageNum	integer	body	false	当前页码，默认 1
pageSize	integer	body	false	当前页面数据量，默认 10

请求示例:

POST "http://192.168.130.241:1800/openapi/v1/node/page/list?time=1720774436&sign=3bbf04e6c524bc028d543148ea55447cad066f896431980e01d80488d1212807"
body:
{
    "field": "createTime",
    "order": "descending",
    "pageNum": 1,
    "pageSize": 10
}

响应参数:

参数	数据类型	描述
code	integer(int32)	返回代码
message	string	返回处理消息
result	IPage <object>	返回数据对象
records	list<object>	当前页的数据列表
uuid	string	节点uuid
name	string	节点名称
status	integer	状态，0:停用 1:启用
onlineStatus	integer	在线状态，0:离线 1:在线
areaUuid	string	所属区域uuid
areaName	string	所属区域名称
remark	string	备注
total	integer	总记录数
current	integer	当前页码
pages	integer	总页数
size	integer	每页显示条数
timestamp	integer(int64)	时间戳，integer(int64)
traceId	string	请求处理ID

响应示例:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "total": 1,
        "current": 1,
        "pages": 1,
        "size": 10,
        "records": [
            {
                "areaName": "sz",
                "areaUuid": "a8a4c72bb116e765d079e93c174e5b03",
                "name": "nashan1",
                "remark": "验证节点编辑20250418\n验证节点编辑20250620",
                "onlineStatus": 1,
                "status": 1,
                "uuid": "1ddf1365dac9137cf77d6d0142ff7251"
            }
        ]
    },
    "timestamp": 1755224335407,
    "traceId": "C20250815101855407112"
}

4. 节点详情

接口地址: /v1/node/details/{uuid}

请求方式: GET

请求数据类型: *

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

支持版本: v1.0.0

接口描述:

查询节点下服务器数，板卡数，容器数等节点详细信息

请求参数:

参数	数据类型	位置	是否必须	描述
uuid	string	path	true	节点 uuid

响应参数:

参数	数据类型	描述
code	integer(int32)	返回代码
message	string	返回处理消息
result	object	返回数据对象
uuid	string	uuid
name	string	节点名称
areaName	string	所属区域
areaUuid	string	所属区域uuid
onlineStatus	integer	在线状态，0:离线 1:在线
status	integer	启用状态，0:停用 1:启用
remark	string	备注
timestamp	integer(int64)	时间戳
traceId	string	请求处理ID

响应示例:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "areaName": "sz",
        "areaUuid": "a8a4c72bb116e765d079e93c174e5b03",
        "name": "nashan1",
        "remark": "验证节点编辑20250418\n验证节点编辑20250620",
        "onlineStatus": 1,
        "status": 1,
        "uuid": "1ddf1365dac9137cf77d6d0142ff7251"
    },
    "timestamp": 1755224456373,
    "traceId": "C20250815102056373073"
}