Estos contenidos se han traducido de forma automática para su comodidad, pero Huawei Cloud no garantiza la exactitud de estos. Para consultar los contenidos originales, acceda a la versión en inglés.

Centro de ayuda/ Cloud Container Engine/ Referencia de la API/ API/ Gestión de complementos/ Listado de instancias de complementos

Actualización más reciente 2023-04-13 GMT+08:00

Ver PDF

Listado de instancias de complementos

Función

Esta API se utiliza para listar todas las instancias de complementos en el clúster.

URI

GET /api/v3/addons

**Tabla 1** Parámetros de consulta
Parámetro	Obligatorio	Tipo	Descripción
cluster_id	Sí	String	ID de clúster. Para obtener más información sobre cómo obtener un ID de clúster, consulte Cómo obtener parámetros en el URI de API.

Parámetros de solicitud

**Tabla 2** Parámetros de cabecera de solicitud
Parámetro	Obligatorio	Tipo	Descripción
Content-Type	Sí	String	Tipo de cuerpo del mensaje (formato).
X-Auth-Token	Sí	String	Las solicitudes para invocar a una API pueden autenticarse usando un token o AK/SK. Si se utiliza la autenticación basada en token, este parámetro es obligatorio y se debe establecer en un token de usuario. Para obtener más información, consulte Obtención de un token de usuario.

Parámetros de respuesta

Código de estado: 200

**Tabla 3** Parámetros del cuerpo de respuesta
Parámetro	Tipo	Descripción
kind	String	Tipo de la API. El valor se fija en Addon y no se puede cambiar.
apiVersion	String	Versión de la API. El valor se fija en v3 y no se puede cambiar.
items	Matriz de objetos de AddonInstance	Lista de instancias de complemento.

**Tabla 4** AddonInstance
Parámetro	Tipo	Descripción
kind	String	Tipo de la API. El valor se fija en Addon y no se puede cambiar.
apiVersion	String	Versión de la API. El valor se fija en v3 y no se puede cambiar.
metadata	Objeto de Metadata	Información básica sobre el objeto. Metadatos es una colección de atributos.
spec	Objeto de InstanceSpec	Descripción detallada de la instancia del complemento.
status	Objeto de AddonInstanceStatus	Estado de la instancia del complemento.

**Tabla 5** Metadato
Parámetro	Tipo	Descripción
uid	String	ID único.
name	String	Nombre del complemento.
labels	Map<String,String>	Etiquetas de complemento en pares de clave y valor. Este es un campo reservado y no tiene efecto.
annotations	Map<String,String>	Anotaciones del complemento en el formato de los pares de clave y valor. Para la instalación del complemento, el valor se fija en {"addon.install/type":"install"}. Para la actualización del complemento, el valor se fija en {"addon.upgrade/type":"upgrade"}.
updateTimestamp	String	Tiempo de actualización.
creationTimestamp	String	Tiempo de creación.

**Tabla 6** InstanceSpec
Parámetro	Tipo	Descripción
clusterID	String	ID de clúster.
version	String	Versión de plantilla adicional, por ejemplo, 1.0.0.
addonTemplateName	String	Nombre de la plantilla del complemento, por ejemplo, coredns.
addonTemplateType	String	Tipo de plantilla del complemento.
addonTemplateLogo	String	URL para obtener el logotipo de la plantilla del complemento.
addonTemplateLabels	Matriz de strings	Etiquetas de la plantilla del complemento.
description	String	Descripción de la plantilla del complemento.
values	Map<String,Object>	Parámetros de instalación de la plantilla del complemento (variando según el complemento). Establezca los parámetros en consecuencia.

**Tabla 7** AddonInstanceStatus
Parámetro	Tipo	Descripción
status	String	Estado de la instancia del complemento.
Reason	String	Causa del error de instalación del complemento.
message	String	Detalles de error de instalación.
targetVersions	Matriz de strings	Versiones a las que se puede actualizar la versión actual del complemento.
currentVersion	Objeto de Versiones	Información sobre la versión actual del complemento.

**Tabla 8** Versions
Parámetro	Tipo	Descripción
version	String	Versión del complemento.
input	Object	Parámetros de instalación del complemento.
stable	Boolean	Si la versión del complemento es una versión estable.
translate	Object	Información de la traducción utilizada por GUI.
supportVersions	Matriz de objetos de SupportVersions	Versiones de clúster que admiten el complemento.
creationTimestamp	String	Tiempo de creación.
updateTimestamp	String	Tiempo de actualización.

**Tabla 9** SupportVersions
Parámetro	Tipo	Descripción
clusterType	String	Tipo de clúster que admite el complemento.
clusterVersion	Matriz de strings	Versiones de clúster que admiten el complemento. El valor es una expresión regular.

Ejemplo de las solicitudes

No hay

Ejemplo de las respuestas

Código de estado: 200

{
  "kind" : "Addon",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Addon",
    "apiVersion" : "v3",
    "metadata" : {
      "uid" : "8ca259cc-553b-11e9-926f-0255ac101a31",
      "name" : "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"
      }
    }
  } ]
}