Lectura de un clúster especificado
Función
Esta API se utiliza para obtener detalles sobre un clúster especificado.
El URL para la gestión de clústeres tiene el formato https://Endpoint/uri. En el URL, uri indica la ruta del recurso, es decir, la ruta para el acceso a la API.
URI
GET /api/v3/projects/{project_id}/clusters/{cluster_id}
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
project_id |
Sí |
String |
ID del proyecto. Para obtener más información sobre cómo obtener el valor, consulta Cómo obtener parámetros en el URI de API. |
cluster_id |
Sí |
String |
ID del clúster. Para obtener más información sobre cómo obtener el valor, consulta Cómo obtener parámetros en el URI de API. |
Parámetro |
Obligatorio |
Tipo |
Descripción |
---|---|---|---|
detail |
No |
String |
Si se consultan los detalles sobre un clúster. Si este parámetro se establece en true, el número total de los nodos (totalNodesNumber), el número de los nodos normales (activeNodesNumber), el total de las CPU (totalNodesCPU), el tamaño total de la memoria (totalNodesMemory) y los complementos instalados (installedAddonInstances) se agregará a la anotación. Los detalles de los complementos instalados incluyen el nombre del complemento (addonTemplateName), versión (version) y estado (status). |
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 Cluster o cluster 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 ClusterMetadata |
Información básica sobre un clúster. Metadatos es una colección de atributos. |
spec |
Objeto de ClusterSpec |
Descripción detallada del clúster. CCE crea o actualiza objetos definiendo o actualizando spec. |
status |
Objeto de ClusterStatus |
Estado del clúster. |
Parámetro |
Tipo |
Descripción |
---|---|---|
name |
String |
Nombre del clúster. Escriba de 4 a 128 caracteres, comenzando con una letra minúscula y no terminando con un guion (-). Solo se permiten letras minúsculas, dígitos y guiones (-). |
uid |
String |
El ID único de recurso, que se genera automáticamente después de crear el recurso. Un ID definido por el usuario no tendrá efecto. |
annotations |
Map<String,String> |
Anotaciones de clúster, en el formato de pares de clave y valor. "annotations": { "key1" : "value1", "key2" : "value2" }
NOTA:
|
labels |
Map<String,String> |
Etiquetas de clúster, en el formato de pares de clave y valor.
NOTA:
El valor de este campo es generado automáticamente por el sistema y es utilizado por el frontend para identificar las características admitidas por el clúster durante la actualización. Los valores personalizados no son válidos. |
creationTimestamp |
String |
Hora en la que se creó el clúster. |
updateTimestamp |
String |
Hora en la que se actualizó el clúster. |
Parámetro |
Tipo |
Descripción |
---|---|---|
category |
String |
Tipo del clúster:
El clúster de CCE admite el despliegue híbrido de las máquinas virtuales y los servidores de metal desnudo (BMS), y los nodos heterogéneos como nodos habilitados para GPU y NPU. Puede ejecutar sus contenedores en un entorno de tiempo de ejecución de contenedores seguro y estable basado en un modelo de red de alto rendimiento. |
type |
String |
Arquitectura de nodo principal de un clúster:
|
flavor |
String |
Valor predeterminado: cuando se crea un clúster de CCE o de Kunpeng, el valor es cce.s1.small para los escenarios que no son de DeC y cce.dec.s1.small para los de DeC. La variante de clúster, que no se puede cambiar después de crear el clúster.
NOTA:
|
version |
String |
Versión de clúster, que refleja la versión básica de la comunidad de Kubernetes. Se recomienda la versión más reciente. Puede crear clústeres de dos versiones más recientes en la consola de CCE. Para saber qué versiones de clúster están disponibles, inicie sesión en la consola de CCE, cree un clúster y compruebe el parámetro Version. Puede invocar a las API para crear los clústeres de otras versiones. Sin embargo, estos clústeres se pondrán gradualmente fuera de línea. Para más detalles sobre la política de soporte, consulte el anuncio del CCE.
NOTA:
|
platformVersion |
String |
Versión de la plataforma de clúster de CCE, que indica la versión interna en la versión de clúster (version). Las versiones de plataforma se utilizan para rastrear iteraciones en una versión de clúster principal. Son únicos dentro de una versión del clúster principal y se cuentan cuando cambia la versión del clúster principal. Este parámetro no se puede personalizar. Al crear un clúster, se selecciona automáticamente la última versión de plataforma correspondiente. El formato de platformVersion es cce.X.Y.
|
description |
String |
Descripción del clúster, por ejemplo, qué propósito está destinado a servir el clúster. De forma predeterminada, este campo se deja sin especificar. Para modificar la descripción del clúster después de crear el clúster, invoque a la API para actualizar la información del clúster o vaya a la página de detalles del clúster en la consola de CCE. Solo se admite la codificación UTF-8. |
customSan |
Matriz de strings |
Campo de SAN personalizado en el certificado de servidor del servidor de API de clúster, que debe cumplir con las especificaciones de formato SSL y X509.
Por ejemplo: SAN 1: DNS Name=example.com SAN 2: DNS Name=www.example.com SAN 3: DNS Name=example.net SAN 4: IP Address=93.184.216.34 |
ipv6enable |
Boolean |
Si el clúster admite direcciones de IPv6. Este campo es compatible con clústeres de v1.15 y las versiones posteriores. |
hostNetwork |
Objeto de HostNetwork |
Parámetros de red de nodo, incluidos los ID de VPC y de subred. Este campo es obligatorio porque los nodos de un clúster se comunican entre sí mediante una VPC. |
containerNetwork |
Objeto de ContainerNetwork |
Parámetros de red de contenedores, incluido el modelo de red de contenedores y el bloque CIDR de contenedores. |
eniNetwork |
Objeto de EniNetwork |
Configuración del modelo de Cloud Native Network 2.0. Especifique este campo al crear un clúster de CCE Turbo. |
authentication |
Objeto de Authentication |
Configuraciones del modo de autenticación de clúster. |
billingMode |
Integer |
Modo de facturación de un clúster.
El valor predeterminado es pago por uso. |
masters |
Matriz de objetos de MasterSpec |
Configuraciones avanzadas de los nodos principales |
kubernetesSvcIpRange |
String |
Bloque de CIDR de servicio o el rango de direcciones IP en el que debe estar kubernetes clusterIp. Este campo solo está disponible para los clústeres de v1.11.7 y posteriores. |
clusterTags |
Matriz de objetos de ResourceTag |
Etiquetas de recursos de clúster. |
kubeProxyMode |
String |
Modo de reenvío de servicio. Hay dos modos disponibles:
|
az |
String |
La AZ. Este campo se devuelve solo para una consulta. Para obtener más información acerca de las AZ admitidas por CCE, consulte la sección Regiones y puntos de conexión. |
extendParam |
Objeto de ClusterExtendParam |
El campo extendido para decidir si el clúster se extenderá entre las AZ o pertenecerá a un proyecto empresarial específico, o si se creará un clúster de CCE dedicado. |
supportIstio |
Boolean |
Si se admite Istio. |
Parámetro |
Tipo |
Descripción |
---|---|---|
vpc |
String |
ID de la VPC utilizada para crear un nodo principal. Métodos:
NOTA:
|
subnet |
String |
ID de red de la subred utilizada para crear un nodo principal. Métodos:
|
SecurityGroup |
String |
ID de grupo de seguridad del nodo. El valor se genera al crear un grupo de seguridad y cualquier valor definido por el usuario no es válido. |
Parámetro |
Tipo |
Descripción |
---|---|---|
mode |
String |
Modelo de red de contenedores. Seleccione uno de los siguientes valores posibles:
|
cidr |
String |
Bloque de contenedores de CIDR. Recomendado: 10.0.0.0/12-19, 172.16.0.0/16-19, or 192.168.0.0/16-19. Si el bloque CIDR seleccionado entra en conflicto con los existentes, se reportará un error. Este parámetro no se puede modificar una vez creado el clúster. (Este parámetro ha sido descartado. Si se ha configurado cidrs, omita este parámetro.) |
cidrs |
Matriz de objetos de ContainerCIDR |
Lista de bloques CIDR de contenedores. En clústeres de v1.21 y posteriores, se utiliza el campo cidrs. Cuando el tipo de red de clúster es de tipo vpc-router, puede agregar varios bloques CIDR de contenedor. En las versiones anteriores a v1.21, si se usa el campo cidrs, el primer elemento CIDR en la matriz se usa como el bloque CIDR contenedor. Este parámetro no se puede modificar una vez creado el clúster. |
Parámetro |
Tipo |
Descripción |
---|---|---|
cidr |
String |
Bloque de contenedores de CIDR. Recomendado: 10.0.0.0/12-19, 172.16.0.0/16-19 y 192.168.0.0/16-19 |
Parámetro |
Tipo |
Descripción |
---|---|---|
eniSubnetId |
String |
ID de red IPv4 de la subred donde reside el ENI. (IPv6 no es compatible y se descarta.) Para obtener el valor:
|
eniSubnetCIDR |
String |
CIDR de la subred ENI (se descarta) |
subnets |
Matriz de objetos de NetworkSubnet |
Lista de los ID de subred IPv4 |
Parámetro |
Tipo |
Descripción |
---|---|---|
subnetID |
String |
ID de red IPv4 de la subred para crear los nodos principales. Actualmente, IPv6 no es compatible. Métodos:
|
Parámetro |
Tipo |
Descripción |
---|---|---|
mode |
String |
Modo de autenticación de clúster.
Los clústeres de v1.13 o posterior admiten rbac y authenticating_proxy. El valor predeterminado es rbac. |
authenticatingProxy |
Objeto de AuthenticatingProxy |
Configuración relacionada con el modo authenticating_proxy. Este campo es obligatorio cuando el modo de autenticación es authenticating_proxy. |
Parámetro |
Tipo |
Descripción |
---|---|---|
ca |
String |
Certificado de X509 CA (Base64-encoded) configurado en modo authenticating_proxy. Este campo es obligatorio cuando el modo de autenticación de clúster es authenticating_proxy. Tamaño máximo: 1 MB |
cert |
String |
Certificado de cliente emitido por el certificado X509 CA configurado en modo autenticating_proxy, que se utiliza para la autenticación desde kube-apiserver al servidor de API extendido. Este campo es obligatorio cuando el modo de autenticación de clúster es authenticating_proxy (el valor debe estar codificado en base 64). |
privateKey |
String |
La clave privada del certificado de cliente emitido por el certificado X509 CA configurado en modo autenticating_proxy, que se utiliza para la autenticación desde kube-apiserver al servidor de API extendido. La clave privada utilizada por el clúster de Kubernetes no es compatible con la encriptación de contraseñas. Utilice una clave privada no cifrada. Este campo es obligatorio cuando el modo de autenticación de clúster es authenticating_proxy (el valor debe estar codificado en base 64). |
Parámetro |
Tipo |
Descripción |
---|---|---|
key |
String |
La clave.
|
value |
String |
El valor.
|
Parámetro |
Tipo |
Descripción |
---|---|---|
clusterAZ |
String |
La AZ de los nodos principales en el clúster. Para obtener más información acerca de las AZ admitidas por CCE, consulte la sección Regiones y puntos de conexión.
|
dssMasterVolumes |
String |
Si el sistema y los discos de datos de un nodo principal utilizan el almacenamiento distribuido dedicado. Si este parámetro se omite o se deja sin especificar, los discos de EVS se utilizan de forma predeterminada. Este parámetro es obligatorio para clústeres de CCE dedicados. Está en el siguiente formato: <rootVol.dssPoolID>.<rootVol.volType>;<dataVol.dssPoolID>.<dataVol.volType> Descripción de campo
Ejemplo: c950ee97-587c-4f24-8a74-3367e3da570f.sas;6edbc2f4-1507-44f8-ac0d-eed1d2608d38.ssd
NOTA:
Este campo no se puede configurar para los clústeres de CCE no dedicados. |
enterpriseProjectId |
String |
ID del proyecto de empresa al que pertenece un clúster.
NOTA:
|
kubeProxyMode |
String |
Modo de reenvío de servicio. Hay dos modos disponibles:
NOTA:
Este parámetro ha sido obsoleta. Si este parámetro y kubeProxyMode en ClusterSpec se especifican al mismo tiempo, se utiliza este último. |
clusterExternalIP |
String |
La EIP del nodo principal |
alpha.cce/fixPoolMask |
String |
Número de bits de máscara del pool fijo de direcciones IP del modelo de red contenedor. Este campo solo se admite para el modelo de red VPC (vpc-router). Este parámetro determina el número de direcciones IP de contenedor que se pueden asignar a un nodo. El número máximo de pods que se pueden crear en un nodo se decide por este parámetro y maxPods se establece durante la creación del nodo. Para obtener más información, consulte la sección Número máximo de pods que se pueden crear en un nodo. Para los caracteres enteros, el valor oscila entre 24 y 28. |
decMasterFlavor |
String |
Especificaciones del nodo principal en el clúster híbrido dedicado. |
dockerUmaskMode |
String |
Configuración de UmaskMode predeterminada de Docker en un clúster. El valor puede ser secure o normal. Si no se especifica este parámetro, se utiliza normal de forma predeterminada. |
kubernetes.io/cpuManagerPolicy |
String |
Política de gestión de CPU de clúster. El valor puede ser none o static. El valor predeterminado es none.
|
orderID |
String |
ID de pedido. Este campo se devuelve en la respuesta cuando el clúster se factura anualmente/mensualmente con el pago automático habilitado. |
periodType |
String |
NOTA:
Esta opción es válida y obligatoria solo cuando billingMode se establece en 1 (facturación anual/mensual). |
periodNum |
Integer |
Duración de la suscripción. El valor puede ser:
NOTA:
Este campo es válido y obligatorio cuando billingMode está establecido en 1. |
isAutoRenew |
String |
Si la renovación automática está habilitada.
NOTA:
Este campo es válido cuando billingMode está establecido en 1. Si no se especifica, la renovación automática no está habilitada. |
isAutoPay |
String |
Si deducir las tarifas automáticamente.
NOTA:
Este campo es válido cuando billingMode está establecido en 1. Si no se especifica, la deducción automática de la tarifa no está habilitada. |
upgradefrom |
String |
Registros de cómo se actualiza el clúster a la versión actual |
Parámetro |
Tipo |
Descripción |
---|---|---|
phase |
String |
Estado del clúster. Valores posibles:
|
jobID |
String |
ID del trabajo. |
reason |
String |
Motivo del cambio de estado del clúster. Este parámetro se devuelve si el clúster no está en el estado Available (Disponible). |
message |
String |
Información detallada sobre por qué el clúster cambia al estado actual. Este parámetro se devuelve si el clúster no está en el estado Available (Disponible). |
endpoints |
Matriz de objetos de ClusterEndpoints |
Dirección de acceso de kube-apiserver en el clúster. |
isLocked |
Boolean |
El recurso de CBC está bloqueado. |
lockScene |
String |
Escenario donde el recurso de CBC está bloqueado. |
lockSource |
String |
Bloqueo de recursos. |
lockSourceId |
String |
ID del recurso bloqueado. |
deleteOption |
Object |
Si desea eliminar configuraciones. Este parámetro solo está contenido en la respuesta a la solicitud de eliminación. |
deleteStatus |
Object |
Si desea eliminar la información de estado. Este parámetro solo está contenido en la respuesta a la solicitud de eliminación. |
Ejemplo de las solicitudes
No hay
Ejemplo de las respuestas
Código de estado: 200
La información sobre el clúster especificado se obtiene correctamente.
{ "kind" : "Cluster", "apiVersion" : "v3", "metadata" : { "name" : "mycluster", "uid" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb", "creationTimestamp" : "2018-08-02 03:48:58.968214406 +0000 UTC", "updateTimestamp" : "2018-08-02 04:05:29.386391813 +0000 UTC" }, "spec" : { "type" : "VirtualMachine", "flavor" : "cce.s1.small", "version" : "v1.7.3-r13", "description" : "this is a demo cluster", "customSan" : [ "192.168.1.0", "example.com" ], "hostNetwork" : { "vpc" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb", "subnet" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb" }, "containerNetwork" : { "mode" : "overlay_l2", "cidr" : "172.16.0.0/16" }, "authentication" : { "mode" : "x509", "authenticatingProxy" : { } }, "billingMode" : 0 }, "status" : { "phase" : "Available", "endpoints" : [ { "url" : "https://192.168.0.11:5443", "type" : "Internal" } ] } }
Códigos de estado
Código de estado |
Descripción |
---|---|
200 |
La información sobre el clúster especificado se obtiene correctamente. |
Códigos de error
Consulte Códigos de error.