Облачная платформаAdvanced

Список Add-on Instances

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

Функция

Этот API используется для получения списка всех add-on instances в cluster.

Метод вызова

Для получения подробной информации см. Calling APIs.

URI

GET /api/v3/addons
Table 1 Параметры запроса

Параметр

Обязательно

Тип

Описание

cluster_id

Да

String

Для получения подробной информации о том, как получить идентификатор кластера, см. How to Obtain Parameters in the API URI.

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

Table 2 Параметры заголовка запроса

Параметр

Обязательно

Тип

Описание

Content-Type

Да

Строка

Определение

Тип (или формат) тела запроса. Значение по умолчанию — application/json. Другие значения этого поля будут указаны для конкретных API, если таковые имеются.

Ограничения

GET‑запросы не проверяются.

Значение по умолчанию

N/A

X-Auth-Token

Да

String

Details:

Запросы к API могут быть аутентифицированы с помощью токена или AK/SK. Если используется аутентификация на основе токена, этот параметр обязателен и должен быть установлен в токен пользователя. Для подробностей см. Obtaining a User Token.

Constraints:

Нет

Options:

N/A

Default value:

N/A

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

Код состояния: 200
Table 3 Параметры тела ответа

Параметр

Тип

Описание

kind

String

Тип API. Значение фиксировано как Addon и не может быть изменено.

apiVersion

String

Версия API. Значение фиксировано как v3 и не может быть изменено.

items

Массив объектов AddonInstance

Список экземпляров Add-on.
Table 4 AddonInstance

Параметр

Тип

Описание

тип

String

Тип API. Значение фиксировано на Addon и не может быть изменено.

apiVersion

String

Версия API. Значение фиксировано на v3 и не может быть изменено.

metadata

AddonMetadata объект

Базовая информация об объекте. Metadata представляет собой набор атрибутов.

spec

InstanceSpec объект

Подробное описание экземпляра add-on.

status

AddonInstanceStatus объект

Состояние экземпляра дополнения.
Table 5 AddonMetadata

Parameter

Type

Description

uid

String

Уникальный ID

name

String

Имя дополнения

alias

String

Алиас дополнения

labels

Map<String,String>

Add-on метки в виде пар ключ‑значение. Это зарезервированное поле и не действует.

annotations

Map<String,String>

Add-on аннотации в формате пар ключ‑значение.

  • Для установки Add-on значение фиксировано как {"addon.install/type":"install"}.

  • Для обновления Add-on значение фиксировано как {"addon.upgrade/type":"upgrade"}.

updateTimestamp

String

Время обновления.

creationTimestamp

String

Время создания.
Таблица 6 InstanceSpec

Параметр

Тип

Описание

clusterID

String

Cluster ID.

version

String

Версия шаблона дополнения, например, 1.0.0.

addonTemplateName

String

Имя шаблона дополнения, например, coredns.

addonTemplateType

String

Определение

Тип шаблона дополнения

Ограничения

N/A

Диапазон

  • helm: пакеты Helm

  • static: статические шаблоны

Значение по умолчанию

N/A

addonTemplateLogo

String

URL для получения логотипа шаблона дополнения.

addonTemplateLabels

Массив строк

Метки шаблона дополнения.

description

String

Описание шаблона Add-on.

значения

Map<String,Object>

Параметры установки шаблона Add-on (зависят от дополнения). Установите параметры соответствующим образом.
Table 7 AddonInstanceStatus

Parameter

Type

Description

status

String

Состояние экземпляра Add-on. Варианты:

  • running: Все экземпляры Add-on находятся в состоянии running. Это указывает, что Add-on работает правильно.

  • abnormal: Экземпляры Add-on находятся в состоянии abnormal и Add-on нельзя использовать. Вы можете нажать add-on name, чтобы просмотреть исключения.

  • installing: Add-on находится в процессе установки.

  • installFailed: Установка Add-on завершилась ошибкой. В этом случае удалите Add-on и затем установите его заново.

  • upgrading: Дополнение обновляется.

  • upgradeFailed: Обновление дополнения не удалось. В этом случае повторно обновите дополнение или удалите дополнение и установите его заново.

  • deleting: Дополнение удаляется.

  • deleteFailed: Удаление дополнения не удалось. В этом случае повторно удалите дополнение.

  • deleteSuccess: Удаление дополнения выполнено успешно.

  • available: Запущены только некоторые экземпляры дополнения. Это указывает, что некоторые функции дополнения доступны.

  • rollbacking: Выполняется откат дополнения.

  • rollbackFailed: Откат дополнения не удался. В этом случае повторно откатите дополнение или удалите его и установите заново.

  • unknown: Экземпляр chart дополнения не существует.

Reason

String

Причина сбоя установки дополнения.

message

String

Подробности ошибки установки.

targetVersions

Массив строк

Версии кластера, поддерживающие обновление дополнения.

currentVersion

Versions объект

Информация о текущей версии дополнения.

isRollbackable

Boolean

Можно ли откатить версию дополнения к исходной версии.

previousVersion

String

Версия дополнения до обновления или отката
Table 8 Versions

Parameter

Type

Описание

версия

String

Версия дополнения.

ввод

Object

Параметры установки дополнения.

стабильный

Boolean

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

перевод

Object

Информация о переводе, используемая GUI.

supportVersions

Массив объектов SupportVersions

Версии кластера, поддерживающие дополнение.

creationTimestamp

String

Время создания.

updateTimestamp

String

Время обновления.
Table 9 SupportVersions

Параметр

Тип

Описание

clusterType

String

Определение

Поддерживаемый тип кластера

Диапазон

  • VirtualMachine: CCE кластер, где узлы‑мастера являются x86‑серверами

clusterVersion

Массив строк

Версии кластера, поддерживающие дополнение. Значение задаётся регулярным выражением.

category

Массив строк

Типы кластеров, к которым применяются настройки

Options:

  • CCE: стандартные кластеры CCE

  • Turbo: кластеры CCE Turbo

Default value:

Если этот параметр оставить пустым, по умолчанию используются стандартные кластеры CCE и кластеры Turbo.

Example Requests

None

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

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

ok

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

Коды ошибок

См. Error Codes.
Родительская тема: Add-on Management
Предыдущая статья
Запрос Add-on Instance
Следующая статья
Создание Add-on Check Tasks пакетами
Поддержка Юридические документы Политика конфиденциальности
© 2026 Cloud.ru