Перейти к содержимому

14.Эксплуатация и обслуживание

1. Создать задачу запроса трафика

Адрес интерфейса: /v1/instance/flow/query

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.18.0

Описание интерфейса:

Создать задачу запроса трафика черезПолучить результат задачи запроса трафикаРезультат запроса интерфейса

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
instanceUuids uuid контейнера body true list Одна или несколько записей данных контейнера
startTime Время начала body true string Время начала запроса (должно быть временем ровно в начале часа), формат yyyy-MM-dd hh:mm:ss
endTime Время окончания body true string Время окончания запроса (должно быть временем ровно в начале часа), формат yyyy-MM-dd hh:mm:ss
billingType Тип тарификации body true string Тип перечисления: PEEKPERCENT95 (тарификация по 95-му процентилю пиковой пропускной способности)
taskDesc Описание задачи body false string Описание задачи

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/instance/flow/query"
body:
{
    "instanceUuids": ["i-236a0f378e9f109584d13c3591c42dff","i-39757fe1833c29fd0ef8263b8d2f46d3"],
    "startTime":"2023-09-01 18:00:00",
    "endTime":"2023-10-01 18:00:00",
    "billingType":"PEEKPERCENT95",
    "taskDesc":"2023年9月份流量汇总"
}

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных list<object>
  jobId ID задачи string
timestamp Временная метка integer
traceId ID обработки запроса string

Пример ответа:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "jobId": "4730ee885e6845ec8a4f026fe90e7920"
    },
    "timestamp": 1705479262853,
    "traceId": "C20240117161421507001"
}

2. Получить результат задачи запроса трафика

Адрес интерфейса: /v1/instance/flow/query/result/{jobId}

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.18.0

Описание интерфейса:

Получить результат задачи запроса трафика

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
jobId jobId, возвращенный после вызова интерфейса path true string ID задачи

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/instance/flow/query/result/4730ee885e6845ec8a4f026fe90e7920"

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных list<object>
  jobId ID задачи string
  status Статус выполнения задачи int 1:выполняется 2:выполнено успешно -1:ошибка выполнения
  billingType Тип тарификации string Тип перечисления: PEEKPERCENT95 (тарификация по 95-му процентилю пиковой пропускной способности)
  billingValue Значение тарификации double Имеет значение при успешном статусе, пропускная способность (единица bps)
  bandwidthList Список сведений о пропускной способности list<object>
    recordTime Время записи long
    receive Полученные данные double Единица измерения: bps
    send Отправить данные double Единица измерения: bps
timestamp Временная метка integer
traceId ID обработки запроса string

Пример ответа:

{
    "message": "操作成功！",
    "code": 200,
    "result": {
        "jobId": "4730ee885e6845ec8a4f026fe90e7920",
        "taskDesc":"2023年9月份流量汇总",
        "status":2,
        "billingType":"PEEKPERCENT95",
        "billingValue":100.0,
        "bandwidthList":[{
            "recordTime":1676020200000,
            "receive":50.0,
            "send":50.0
        }]
    },
    "timestamp": 1705479262853,
    "traceId": "C20240117161421507001"
}

3. Запросить онлайн-статус сервера

Адрес интерфейса: /v1/arm/server/query/online/status

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.19.0

Описание интерфейса:

Запрос онлайн-статуса сервера

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
nodeUuid uuid узла body true string
armServerUuids Список uuid серверов body true list

Пример запроса, в фактическом запросе замените значения параметров:

POST "/openapi/v1/arm/server/query/online/status"
body:
{
    "armServerUuids":["s-08f5fb859a9d9161c2727bf57e586f02"],
    "nodeUuid":"81f62329436eed8f36d0595bf81b63db"
}

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных object
  serverList Пара ключ-значение object key — uuid，value — статус（1:онлайн；0:офлайн）
timestamp Временная метка integer
traceId ID обработки запроса string

Пример ответа:

{
    "message": "操作成功",
    "code": 200,
    "result": {
        "serverList": {
            "s-08f5fb859a9d9161c2727bf57e586f02": 1
        }
    },
    "timestamp": 1736495691785,
    "traceId": "E20250110155451785129"
}

4. Запросить онлайн-статус платы

Адрес интерфейса: /v1/arm/card/query/online/status

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.19.0

Описание интерфейса:

Запрос онлайн-статуса платы

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
nodeUuid uuid узла body true string
uuids Список uuid плат body true list

Пример запроса, в фактическом запросе замените значения параметров:

POST "/v1/arm/card/query/online/status"
body:
{
    "uuids":["26d9132fdfe8fe58e52ea13033239ac3","8398e402e6bd85c7e27f15f088d8d9e2"],
    "nodeUuid":"81f62329436eed8f36d0595bf81b63db"
}

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных object
  armCardList Пара ключ-значение object key — uuid，value — статус（1:онлайн；0:офлайн）
timestamp Временная метка integer
traceId ID обработки запроса string

Пример ответа:

{
    "message": "操作成功",
    "code": 200,
    "result": {
        "armCardList": {
            "8398e402e6bd85c7e27f15f088d8d9e2": 1,
            "26d9132fdfe8fe58e52ea13033239ac3": 1
        }
    },
    "timestamp": 1736496285388,
    "traceId": "E20250110160445388133"
}

5. Запросить использование ресурсов платы

Адрес интерфейса: /v1/system/resource/current

Метод запроса:POST

Тип данных запроса:application/json

Тип данных ответа:*/*,application/json

Поддерживаемая версия:v1.19.0

Описание интерфейса:

Запрос использования ресурсов cpu, памяти и диска платы

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
snList Список sn плат body true list Если передается значение uuids, snList не передается; передается только один из двух параметров
uuids Список uuid плат body true list Если передается значение snList, uuids не передается; передается только один из двух параметров
type Тип body true integer 1:плата. В настоящее время поддерживается только тип платы

Пример запроса, в фактическом запросе замените значения параметров:

POST "/v1/system/resource/current"
body:
{
    "type": 1,
    "snList": [
        "OR65M62QC2D242406618"
    ]
}

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных object
  list Объект данных object
    sn или uuid sn или uuid string
      recordTime Временная метка(секунды) long Момент времени сбора
      cpuCore общее количество ядер cpu string
      cpuUsageActive использование cpu string
      memTotal Общая память string
      memAvailable Доступная память string
      memActualUsed Фактически используемая память string
      memUsedPercent Использование памяти string
      diskTotal Общий диск string
      diskUsed Использование диска string
      diskUsedPercent Процент использования диска string
timestamp Временная метка integer
traceId ID обработки запроса string

Пример ответа:

{
    "code": 200,
    "result": {
        "list": {
            "OR65Q61QC2D240402603": {
                "cpuCore": "8",
                "cpuUsageActive": "3.52%",
                "diskTotal": "223.59G",
                "diskUsed": "11.60G",
                "diskUsedPercent": "5.19%",
                "memActualUsed": "2.58G",
                "memAvailable": "8.89G",
                "memTotal": "11.47G",
                "memUsedPercent": "22.49%",
                "recordTime": 1755225150
            },
            "OR65Q61QC2D240403791": {
                "cpuCore": "8",
                "cpuUsageActive": "3.59%",
                "diskTotal": "223.59G",
                "diskUsed": "10.95G",
                "diskUsedPercent": "4.90%",
                "memActualUsed": "2.58G",
                "memAvailable": "8.88G",
                "memTotal": "11.47G",
                "memUsedPercent": "22.52%",
                "recordTime": 1755225150
            }
        }
    },
    "success": true,
    "timestamp": 0
}

6. Утилизировать плату (ранее отмена подписки на плату)

Адрес интерфейса: /v1/arm/card/apply/release

Метод запроса: POST

Тип данных запроса: application/json

Тип данных ответа: */*,application/json

Поддерживаемая версия: v1.18.0

callbackUrl предоставляется версией v1.19.0

Описание интерфейса:

Утилизировать плату (ранее отмена подписки на плату, в дальнейшем планируется использовать интерфейс только администраторами, будет добавлен контроль прав)

Параметры запроса:

Имя параметра Описание параметра Местоположение Обязательно ли Тип данных Описание
nodeUuid uuid узла body true string
batchMap Пара ключ-значение uuid платы/название платы body false object Планируется вывести это поле из эксплуатации позже, рекомендуется передавать значение поля uuids вместо этого поля
uuids Список uuid плат body true List<String> Заменяет batchMap
deepRelease Глубокая утилизация body false boolean После освобождения платы есть задача утилизации.
Когда значение равно true, процесс задачи утилизации: уничтожить контейнеры платы->Автоматическая прошивка qfile->Повторно привязать ip платы->Установить последние cce, ccem;
Когда значение равно false, процесс задачи утилизации: уничтожить контейнеры платы
callbackUrl Адрес callback уведомления body false string POST-запрос

Пример запроса

POST "/openapi/v1/arm/card/apply/release"
body:
{
    "batchMap":{
        "e123de61c90d0abbd503c48c769bb38a":"fjz-api-1"
    },
    "uuids": ["e123de61c90d0abbd503c48c769bb38a"],
    "nodeUuid":"81f62329436eed8f36d0595bf81b63db",
    "deepRelease": true,
    "callbackUrl": "http://127.0.0.1/notice"
}

Параметры ответа:

Имя параметра Описание параметра Тип Описание
code Код возврата integer(int32)
message Возвращаемое сообщение обработки string
result Возвращаемый объект данных object
  recycleJobs Результат задачи утилизации list<object>
    jobId id задачи string id задачи освобождения платы, используется для запроса деталей задачи jobId
    code Код статуса отправки задачи integer СоответствуетТаблица кодов статуса ответа
    message Описание отправки задачи string
    uuid uuid платы string
    sn SN платы string
    recycleTraceId Бизнес-ID задачи утилизации string
  jobs Результат задачи list<object>
    jobId id задачи string
    code Код статуса отправки задачи integer СоответствуетТаблица кодов статуса ответа
    message Описание отправки задачи string
    uuid uuid платы string
    sn SN платы string
timestamp Временная метка integer(int64)
traceId ID обработки запроса string

Пример ответа:

{
    "message": "操作成功",
    "code": 200,
    "result": {
        "recycleJobs": [
            {
                "jobId": "4431f0758c244106950b1a98f358d433",
                "code": 200,
                "sn": "OR65Q61QC2D240403252",
                "recycleTraceId": "E20250326183529385229_1",
                "message": "success",
                "uuid": "ef8f33d103ffc9b79af8709397e3d559"
            }
        ],
        "jobs": [
            {
                "jobId": "c5ebec444805454c97f8884804796dde",
                "code": 200,
                "sn": "OR65Q61QC2D240403252",
                "message": "success",
                "uuid": "ef8f33d103ffc9b79af8709397e3d559"
            }
        ]
    },
    "timestamp": 1742985329522,
    "traceId": "E20250326183529385229"
}