1.Regions and nodes

1. Region paginated list

API address: /v1/area/page/list

Request method: POST

Request data type: application/json

Response data type: */*,application/json

Supported version: v1.0.0

API description:

Paginated query of regions, including region name, specific location, and other region creation information

Request example:

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

Request parameters:

Parameters	Data type	Location	Whether required	Description
field	string	body	false	Sort field
name	string	body	false	Region name
order	string	body	false	Sort rule, descending/ascending
pageNum	integer	body	false	Current page number, default 1
pageSize	integer	body	false	Amount of data on the current page, default 10

Response parameters:

Parameters	Type	Description
code	integer(int32)	Return code
message	string	Return processing message
result	IPage<object>	Returned data object
records	list<object>	Data list on the current page
uuid	string	uuid
name	string	Region name
position	string	Location
status	integer	Status, 0: disabled 1: enabled
remark	string	Remarks
total	integer	Total number of records
current	integer	Current page number
pages	integer	Total pages
size	integer	Number of items displayed per page
timestamp	integer(int64)	Timestamp
traceId	boolean	Request processing ID

Response example:

{
    "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"
}

1. message must not be empty when the API returns an error

2. Region details

API address: /v1/area/details/{uuid}

Request method: GET

Request data type: *

Response data type: */*,application/json

Supported version: v1.0.0

API description:

Query region details, including the number of nodes, servers, cards, containers, etc. under this region

Request parameters:

Parameters	Data type	Location	Whether required	Description
uuid	string	path	true	Region uuid

Response parameters:

Parameters	Data type	Description
code	integer(int32)	Return code
message	string	Return processing message
result	object	Returned data object
uuid	string	uuid
name	string	Name
status	integer	Enable status, 0:disabled 1:enabled
position	string	Location
remark	string	Remarks
timestamp	integer(int64)	Timestamp
traceId	string	Request processing ID

Response example:

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

3. Node paginated list

API address: /v1/node/page/list

Request method: POST

Request data type: application/json

Response data type: */*,application/json

Supported version: v1.0.0

API description:

Paginated query of node information

Request parameters:

Parameters	Data type	Location	Whether required	Description
field	string	body	false	Sort field
name	string	body	false	Node name
order	string	body	false	Sort rule, descending/ascending
pageNum	integer	body	false	Current page number, default 1
pageSize	integer	body	false	Amount of data on the current page, default 10

Request example:

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
}

Response parameters:

Parameters	Data type	Description
code	integer(int32)	Return code
message	string	Return processing message
result	IPage <object>	Returned data object
records	list<object>	Data list on the current page
uuid	string	Node uuid
name	string	Node name
status	integer	Status, 0: disabled 1: enabled
onlineStatus	integer	Online status, 0:offline 1:online
areaUuid	string	Region uuid
areaName	string	Region name
remark	string	Remarks
total	integer	Total number of records
current	integer	Current page number
pages	integer	Total pages
size	integer	Number of items displayed per page
timestamp	integer(int64)	Timestamp, integer(int64)
traceId	string	Request processing ID

Response example:

{
    "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. Node details

API address: /v1/node/details/{uuid}

Request method: GET

Request data type: *

Response data type: */*,application/json

Supported version: v1.0.0

API description:

Query node details such as the number of servers, cards, containers, etc. under the node

Request parameters:

Parameters	Data type	Location	Whether required	Description
uuid	string	path	true	Node uuid

Response parameters:

Parameters	Data type	Description
code	integer(int32)	Return code
message	string	Return processing message
result	object	Returned data object
uuid	string	uuid
name	string	Node name
areaName	string	Region
areaUuid	string	Region uuid
onlineStatus	integer	Online status, 0:offline 1:online
status	integer	Enable status, 0:disabled 1:enabled
remark	string	Remarks
timestamp	integer(int64)	Timestamp
traceId	string	Request processing ID

Response example:

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