Consulta de una instancia de complemento
Función
Esta API se utiliza para obtener detalles sobre una instancia de complemento.
URI
GET /api/v3/addons/{id}
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| id | Sí | String | ID de instancia de complemento. |
| Parámetro | Obligatorio | Tipo | Descripción |
|---|---|---|---|
| cluster_id | No | 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
| 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
| 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
No hay
Ejemplo de las respuestas
Código de estado: 200
OK
{
"kind" : "Addon",
"apiVersion" : "v3",
"metadata" : {
"uid" : "24b23108-55c0-11e9-926f-0255ac101a31",
"name" : "gpu-beta",
"creationTimestamp" : "2019-04-03T03:25:34Z",
"updateTimestamp" : "2019-04-03T03:25:34Z"
},
"spec" : {
"clusterID" : "0c0e4a63-5539-11e9-95f7-0255ac10177e",
"version" : "1.0.0",
"addonTemplateName" : "gpu-beta",
"addonTemplateType" : "helm",
"addonTemplateLogo" : "",
"addonTemplateLabels" : [ "Accelerator" ],
"description" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
"values" : {
"basic" : {
"rbac_enabled" : true,
"swr_addr" : "100.125.6.246:20202",
"swr_user" : "hwofficial"
}
}
},
"status" : {
"status" : "installing",
"Reason" : "",
"message" : "",
"targetVersions" : null,
"currentVersion" : {
"version" : "1.0.0",
"input" : {
"basic" : {
"swr_addr" : "100.125.6.246:20202",
"swr_user" : "hwofficial"
},
"parameters" : { }
},
"stable" : true,
"translate" : {
"en_US" : {
"addon" : {
"changeLog" : "A device plugin for nvidia.com/gpu resource on nvidia driver",
"description" : "A device plugin for nvidia.com/gpu resource on nvidia driver"
}
},
"zh_CN" : {
"addon" : {
"changeLog" : "",
"description" : ""
}
}
},
"supportVersions" : null,
"creationTimestamp" : "2018-10-23T13:14:55Z",
"updateTimestamp" : "2018-12-07T09:40:24Z"
}
}
} Códigos de estado
| Código de estado | Descripción |
|---|---|
| 200 | Aceptar |
Códigos de error
Consulte Códigos de error.
