Actualización de una instancia de complemento
Función
Esta API se utiliza para actualizar una instancia de complemento.
URI
PUT /api/v3/addons/{id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
id |
Sí |
String |
ID de instancia de complemento. |
Parámetros 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ámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
kind |
Sí |
String |
Tipo de la API. El valor se fija en Addon y no se puede cambiar. |
apiVersion |
Sí |
String |
Versión de la API. El valor se fija en v3 y no se puede cambiar. |
metadata |
Sí |
Objeto de Metadata |
Información básica sobre el objeto. Metadatos es una colección de atributos. |
spec |
Sí |
Objeto de InstanceRequestSpec |
Descripción detallada de la instalación o actualización del complemento. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
uid |
No |
String |
ID único. |
name |
No |
String |
Nombre del complemento. |
labels |
No |
Map<String,String> |
Etiquetas de complemento en pares de clave y valor. Este es un campo reservado y no tiene efecto. |
annotations |
No |
Map<String,String> |
Anotaciones del complemento en el formato de los pares de clave y valor.
|
updateTimestamp |
No |
String |
Tiempo de actualización. |
creationTimestamp |
No |
String |
Tiempo de creación. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
version |
Sí |
String |
Versión del complemento que se instalará o actualizará, por ejemplo, 1.0.0. |
clusterID |
Sí |
String |
ID de clúster. |
values |
Sí |
Map<String,Object> |
Parámetros de instalación de la plantilla del complemento (variando según el complemento). Durante la actualización del complemento, debe especificar todos los parámetros de instalación. Si no se especifican los parámetros, se utilizan los valores predeterminados de la plantilla de complemento. Los parámetros de instalación de complementos actuales se pueden obtener a través de la API para consultar las instancias de complementos. |
addonTemplateName |
Sí |
String |
Nombre de la plantilla de complemento que se va a instalar, por ejemplo, coredns. |
Parámetros de respuesta
Código de estado: 200
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. |
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.
|
updateTimestamp |
String |
Tiempo de actualización. |
creationTimestamp |
String |
Tiempo de creación. |
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. |
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. |
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. |
Ejemplo de las solicitudes
{ "kind" : "Addon", "apiVersion" : "v3", "metadata" : { "annotations" : { "addon.upgrade/type" : "upgrade" } }, "spec" : { "clusterID" : "1b2ec02d-a3b2-11ec-b0d0-0255ac100099", "version" : "1.2.10", "addonTemplateName" : "gpu-beta", "values" : { "basic" : { "device_version" : "1.2.10", "driver_version" : "1.2.10", "obs_url" : "******", "region" : "******", "swr_addr" : "******", "swr_user" : "hwofficial", "rbac_enabled" : true }, "custom" : { "is_driver_from_nvidia" : true, "nvidia_driver_download_url" : "https://us.download.nvidia.com/tesla/396.37/NVIDIA-Linux-x86_64-396.37.run" } } } }
Ejemplo de las respuestas
Código de estado: 200
OK
{ "kind" : "Addon", "apiVersion" : "v3", "metadata" : { "uid" : "684fa9b2-a987-11ec-ba79-0255ac100096", "name" : "gpu-beta", "creationTimestamp" : "2022-03-22T02:25:57Z", "updateTimestamp" : "2022-03-22T02:25:57Z" }, "spec" : { "clusterID" : "1b2ec02d-a3b2-11ec-b0d0-0255ac100099", "version" : "1.2.10", "addonTemplateName" : "gpu-beta", "addonTemplateType" : "helm", "addonTemplateLogo" : "******", "addonTemplateLabels" : [ "Accelerator" ], "description" : "A device plugin for nvidia.com/gpu resource on nvidia driver", "values" : { "basic" : { "device_version" : "1.2.10", "driver_version" : "1.2.10", "obs_url" : "******", "rbac_enabled" : true, "region" : "******", "swr_addr" : "******", "swr_user" : "hwofficial" }, "custom" : { "is_driver_from_nvidia" : true, "nvidia_driver_download_url" : "https://us.download.nvidia.com/tesla/396.37/NVIDIA-Linux-x86_64-396.37.run" } } }, "status" : { "status" : "upgrading", "Reason" : "addon upgrading", "message" : "", "targetVersions" : null, "currentVersion" : { "version" : "1.2.10", "input" : { "basic" : { "device_version" : "1.2.10", "driver_version" : "1.2.10", "obs_url" : "******", "region" : "******", "swr_addr" : "******", "swr_user" : "hwofficial" }, "parameters" : { "custom" : { "is_driver_from_nvidia" : true, "nvidia_driver_download_url" : "" } } }, "stable" : true, "translate" : { "en_US" : { "addon" : { "changeLog" : "Supported GPU driver of a new version for CentOS.", "description" : "A device plugin for nvidia.com/gpu resource on nvidia driver" }, "description" : { "Parameters.custom.drivers_info.cuda" : "CUDA Toolkit", "Parameters.custom.drivers_info.product" : "Product", "Parameters.custom.drivers_info.product_series" : "Product Series", "Parameters.custom.drivers_info.product_type" : "Product Type", "Parameters.custom.nvidia_driver_download_url" : "\u0001Download the nvidia driver\raccroding to the input link" }, "key" : { "Parameters.custom.nvidia_driver_download_url" : "Nvidia Driver" } }, "fr_FR" : { "addon" : { "changeLog" : "Pilote GPU pris en charge d'une nouvelle version pour CentOS.", "description" : "Un plug-in de dispositif pour les ressources GPU sur un pilote\rNVIDIA." }, "description" : { "Parameters.custom.drivers_info.cuda" : "Boîte à outils CUDA", "Parameters.custom.drivers_info.product" : "Produit", "Parameters.custom.drivers_info.product_series" : "Serie de produits", "Parameters.custom.drivers_info.product_type" : "type de produit", "Parameters.custom.nvidia_driver_download_url" : "\u0001Téléchargez le pilote nvidia\raccroding sur le lien d'entrée" }, "key" : { "Parameters.custom.nvidia_driver_download_url" : "Nvidia Driver" } }, "zh_CN" : { "addon" : { "changeLog" : "", "description" : "" }, "description" : { "Parameters.custom.drivers_info.cuda" : "CUDA Toolkit", "Parameters.custom.drivers_info.product" : "", "Parameters.custom.drivers_info.product_series" : "", "Parameters.custom.drivers_info.product_type" : "", "Parameters.custom.nvidia_driver_download_url" : "" }, "key" : { "Parameters.custom.nvidia_driver_download_url" : "" } } }, "supportVersions" : null, "creationTimestamp" : "2022-01-11T14:57:44Z", "updateTimestamp" : "2022-01-11T15:04:37Z" } } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
Aceptar |
Códigos de error
Consulte Códigos de error.