Облачная платформаВсе платформы

Список экземпляров дополнений

Эта статья полезна?

Язык статьи: Русский

Показать оригинал

Страница переведена автоматически и может содержать неточности. Рекомендуем сверяться с английской версией.

Функция

Этот API используется для перечисления всех экземпляров дополнений в кластере.

Метод вызова

Для подробностей см. Вызов API.

URI

GET /api/v3/addons

Таблица 1 Параметры запроса
Параметр	Обязательно	Тип	Описание
cluster_id	Да	String	Идентификатор кластера. Для получения подробностей о том, как получить идентификатор кластера, см. Как получить параметры в URI API.

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

Таблица 2 Параметры заголовка запроса
Параметр	Обязательно	Тип	Описание
Content-Type	Да	String	Определение Тип (или формат) тела запроса. Значение по умолчанию — application/json. Другие значения этого поля будут предоставлены для конкретных API, если таковые имеются. Ограничения GET запросы не проверяются. Значение по умолчанию N/A
X-Auth-Token	Да	String	Подробности: Запросы к API могут быть аутентифицированы с помощью токена или AK/SK. Если используется аутентификация по токену, этот параметр обязателен и должен быть установлен в токен пользователя. Для подробностей см. Получение токена пользователя. Ограничения: Нет Опции: N/A Значение по умолчанию: N/A

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

Код состояния: 200

Таблица 3 Параметры тела ответа
Параметр	Тип	Описание
kind	String	Тип API. Значение фиксировано как Addon и не может быть изменено.
apiVersion	String	Версия API. Значение фиксировано как v3 и не может быть изменено.
items	Массив AddonInstance объектов	Список экземпляров дополнений.

Таблица 4 AddonInstance
Параметр	Тип	Описание
kind	String	Тип API. Значение фиксировано как Addon и не может быть изменено.
apiVersion	String	Версия API. Значение фиксировано как v3 и не может быть изменено.
metadata	AddonMetadata объект	Базовая информация об объекте. Метаданные — это набор атрибутов.
spec	InstanceSpec объект	Подробное описание экземпляра дополнения.
status	AddonInstanceStatus объект	Состояние экземпляра дополнения.

Таблица 5 AddonMetadata
Параметр	Тип	Описание
uid	String	Уникальный ID
name	String	Название дополнения
alias	String	Псевдоним дополнения
labels	Map<String,String>	Метки дополнения в виде пар ключ‑значение. Это зарезервированное поле и не действует.
annotations	Map<String,String>	Аннотации дополнения в формате пар ключ‑значение. Для установки дополнения значение фиксировано как {"addon.install/type":"install"}. Для обновления дополнения значение фиксировано как {"addon.upgrade/type":"upgrade"}.
updateTimestamp	String	Время обновления.
creationTimestamp	String	Время создания.

Таблица 6 InstanceSpec
Параметр	Тип	Описание
clusterID	String	Идентификатор кластера.
version	String	Версия шаблона дополнения, например, 1.0.0.
addonTemplateName	String	Имя шаблона дополнения, например, coredns.
addonTemplateType	String	Определение Тип шаблона дополнения Ограничения N/A Диапазон helm: Helm пакеты static: статические шаблоны Значение по умолчанию N/A
addonTemplateLogo	String	URL для получения логотипа шаблона дополнения.
addonTemplateLabels	Массив строк	Метки шаблона дополнения.
description	String	Описание шаблона дополнения.
values	Map<String,Object>	Параметры установки шаблона дополнения (зависят от дополнения). Установите параметры соответствующим образом.

Таблица 7 AddonInstanceStatus
Параметр	Тип	Описание
status	String	Состояние экземпляра дополнения. Параметры: running: Все экземпляры дополнения работают. Это указывает, что дополнение функционирует корректно. abnormal: Экземпляры дополнения находятся в аномальном состоянии, и дополнение невозможно использовать. Вы можете нажать на название дополнения, чтобы просмотреть исключения. installing: Дополнение устанавливается. installFailed: Установка дополнения завершилась ошибкой. В этом случае удалите дополнение и установите его заново. upgrading: Дополнение обновляется. upgradeFailed: Обновление дополнения завершилось ошибкой. В этом случае попробуйте обновить дополнение снова или удалите и переустановите его. deleting: Дополнение удаляется. deleteFailed: Удаление дополнения завершилось ошибкой. В этом случае удалите дополнение повторно. deleteSuccess: Удаление дополнения успешно завершено. available: Работают только некоторые экземпляры дополнения. Это означает, что доступны некоторые функции дополнения. rollbacking: Дополнение откатывается. rollbackFailed: Откат дополнения завершился ошибкой. В этом случае повторите откат или удалите и переустановите дополнение. unknown: Экземпляр чарта дополнения не существует.
Причина	String	Причина неудачной установки дополнения.
message	String	Подробности ошибки установки.
targetVersions	Массив строк	Версии кластера, поддерживающие обновление дополнения.
currentVersion	Версии объект	Информация о текущей версии дополнения.
isRollbackable	Boolean	Можно ли откатить версию дополнения к исходной версии.
previousVersion	String	Версия дополнения до обновления или отката.

Таблица 8 Versions
Параметр	Тип	Описание
version	String	Версия дополнения.
input	Object	Параметры установки дополнения.
stable	Boolean	Является ли версия дополнения стабильным релизом.
translate	Object	Информация о переводе, используемая графическим интерфейсом.
supportVersions	Массив SupportVersions объектов	Версии кластера, поддерживающие дополнение.
creationTimestamp	String	Время создания.
updateTimestamp	String	Время обновления.

Таблица 9 SupportVersions
Параметр	Тип	Описание
clusterType	String	Определение Поддерживаемый тип кластера Диапазон VirtualMachine: CCE кластер, где узлы‑мастера — x86‑серверы. ARM64: Kunpeng кластер, где узлы‑мастера — Kunpeng серверы. Ограничения Для кластеров CCE Autopilot поддерживается только VirtualMachine поддерживается.
clusterVersion	Массив строк	Версии кластера, поддерживающие дополнение. Значение — регулярное выражение.
category	Массив строк	Типы кластеров, к которым применяются настройки Опции: CCE: стандартные кластеры CCE Turbo: кластеры CCE Turbo Autopilot: кластеры CCE Autopilot Значение по умолчанию: Если параметр оставить пустым, по умолчанию будут использоваться стандартные и Turbo кластеры CCE.

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

Нет

Примеры ответов

Код состояния: 200

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Addon",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "8ca259cc-553b-11e9-926f-0255ac101a31",
      "name" : "storage-driver",
      "alias" : "storage-driver",
      "creationTimestamp" : "2019-04-02T11:36:26Z",
      "updateTimestamp" : "2019-04-02T11:36:26Z"
    },
    "spec" : {
      "clusterID" : "0c0e4a63-5539-11e9-95f7-0255ac10177e",
      "version" : "1.0.10",
      "addonTemplateName" : "storage-driver",
      "addonTemplateType" : "helm",
      "addonTemplateLogo" : "https://192.149.48.66/cce-addon-southchina-aw1hz2u/storage-driverlogo.svg",
      "addonTemplateLabels" : [ "Storage" ],
      "description" : "A kubernetes FlexVolume Driver used to support cloud storage",
      "values" : {
        "basic" : {
          "addon_version" : "1.0.10",
          "euleros_version" : "2.2.5",
          "obs_url" : "",
          "platform" : "linux-amd64",
          "swr_addr" : "100.125.6.246:20202",
          "swr_user" : "hwofficial"
        },
        "flavor" : {
          "replicas" : 1
        },
        "parameters" : { }
      }
    },
    "status" : {
      "status" : "running",
      "Reason" : "Install complete",
      "message" : "",
      "targetVersions" : null,
      "currentVersion" : {
        "version" : "1.0.10",
        "input" : {
          "basic" : {
            "euleros_version" : "2.2.5",
            "obs_url" : "",
            "swr_addr" : "100.125.6.246:20202",
            "swr_user" : "hwofficial"
          },
          "parameters" : { }
        },
        "stable" : true,
        "translate" : {
          "en_US" : {
            "addon" : {
              "changeLog" : "The plug-in is upgraded to enhance the storage plug-in function.",
              "description" : "A kubernetes FlexVolume Driver used to support cloud storage"
            }
          },
          "zh_CN" : {
            "addon" : {
              "changeLog" : "",
              "description" : ""
            }
          }
        },
        "supportVersions" : null,
        "creationTimestamp" : "2019-03-29T13:45:37Z",
        "updateTimestamp" : "2019-03-29T13:45:37Z"
      }
    }
  } ]
}

Коды состояний

Код состояния	Описание
200	ok

Коды ошибок

См. Коды ошибок.

Родительская тема: Управление дополнениями

Предыдущая статья

Запрос экземпляра дополнения

Следующая статья

Создание дополнительных задач проверки пакетно

Эта статья полезна?

Поддержка Юридические документы Политика конфиденциальности