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