Consulta de una lista de clúster_MapReduce Service

Función

Esta API se utiliza para consultar una lista de clústeres creados por un usuario. Esta API es incompatible con Sahara.

Restricciones

Ninguna

Depuración

Puede depurar esta API a través de la autenticación automática en API Explorer. API Explorer puede generar automáticamente código SDK de ejemplo y proporcionar la depuración de código SDK de ejemplo.

URI

Formato
GET /v1.1/{project_id}/cluster_infos

Descripción de parámetro

**Tabla 1** Parámetros de URI
Parámetro	Obligatorio	Tipo	Descripción
project_id	Sí	String	El ID del proyecto. Para obtener más información sobre cómo obtener el ID del proyecto, consulte Obtención de un ID de proyecto.

**Tabla 2** Parámetros de Query
Parámetro	Obligatorio	Tipo	Descripción
pageSize	No	String	Número máximo de clústeres mostrados en una página Rango de valores: 1 a 2147483646
currentPage	No	String	Número de página actual
clusterName	No	String	El nombre del clúster.
clusterState	No	String	Puede consultar una lista de clústeres por estado de clúster. existing: consultar una lista de clústeres existentes excepto los clústeres terminados. history: consultar una lista de clústeres de historial, incluidos los clústeres terminados, los clústeres que no se terminan, los clústeres que no se eliminan máquinas virtuales y los clústeres que no se terminan una actualización de base de datos. starting: consultar una lista de clústeres que se están iniciando. running Consultar una lista de clústeres en ejecución. terminated: consultar una lista de clústeres terminados. failed: consultar una lista de clústeres fallidos. abnormal: consultar una lista de clústeres anormales. terminating: consultar una lista de clústeres que se están terminando. frozen: consultar una lista de clústeres congelados. scaling-out: consultar una lista de clústeres que se están escalando. scaling-in: consultar una lista de clústeres que se están reduciendo.
tags	No	String	Puede buscar un clúster por su etiqueta. Si especifica varias etiquetas, la relación entre ellas es AND. El formato del parámetro tags es *tags=k1v1,k2v2,k3v3. Cuando los valores de algunas etiquetas son nulos, el formato es tags=k1,k2,k3v3*.
enterpriseProjectId	No	String	ID de proyecto de empresa utilizado para consultar clústeres en un proyecto de empresa especificado. El valor predeterminado es 0, que indica el proyecto de empresa del tipo default. Para obtener el ID de proyecto empresarial, consulte el valor id en la tabla enterprise_project field data structure en "Consulta de la lista de proyectos empresariales" en Referencia de la API de Enterprise Management.

Parámetros de solicitud

Ninguna

Parámetros de respuesta

**Tabla 3** Parámetros de respuesta
Parámetro	Tipo	Descripción
clusterTotal	Integer	Número total de clústeres en una lista
clusters	Array of Cluster objects	Parámetros de clúster. Para obtener más información, consulte Tabla 4.

**Tabla 4** parámetros del clúster
Parámetro	Tipo	Descripción
clusterId	String	ID de clúster.
clusterName	String	Nombre del clúster.
masterNodeNum	String	Número de nodos de Master desplegados en un clúster.
coreNodeNum	String	Número de nodos principales desplegados en un clúster.
totalNodeNum	String	Número total de nodos desplegados en un clúster.
clusterState	String	Estado del clúster. Los valores válidos incluyen: Starting: se está iniciando el clúster. running: el clúster se está ejecutando. Terminated: el clúster se ha terminado. failed: el clúster falla. abnormal: el clúster es anormal. terminating: se está terminando el clúster. frozen: el clúster se ha congelado. Scaling-out: el clúster se está escalando horizontalmente. Scaling-in: el clúster se está reduciendo.
createAt	String	Tiempo de creación del clúster, que es una marca de tiempo de 10 bits.
updateAt	String	Tiempo de actualización del clúster, que es una marca de tiempo de 10 bits.
billingType	String	Modo de facturación de clúster.
dataCenter	String	Región de trabajo del clúster.
vpc	String	Nombre de la VPC.
vpcId	String	ID de VPC.
duration	String	Duración de la suscripción del clúster.
fee	String	Tarifa de creación de clúster, que se calcula automáticamente.
hadoopVersion	String	Versión Hadoop.
masterNodeSize	String	Especificaciones de instancia de un nodo de Master.
coreNodeSize	String	Especificaciones de instancia de un nodo Core.
componentList	Array	Lista de componentes. Para obtener más información, consulte Tabla 5.
externalIp	String	Dirección IP externa.
externalAlternateIp	String	Copia de respaldo de la dirección IP externa.
internalIp	String	Dirección IP interna.
deploymentId	String	ID de despliegue de clúster.
remark	String	Observaciones de clúster.
orderId	String	ID de orden de creación de clúster.
azId	String	ID de la AZ.
masterNodeProductId	String	ID de producto de un nodo de Master.
masterNodeSpecId	String	ID de especificación de un nodo de Master.
coreNodeProductId	String	ID de producto de un nodo Core.
coreNodeSpecId	String	ID de especificación de un nodo Core.
azName	String	Nombre de zona de disponibilidad.
azCode	String	Nombre de zona de disponibilidad (en).
availabilityZoneId	String	La zona de disponibilidad.
instanceId	String	ID de instancia.
vnc	String	URI para iniciar sesión remotamente en un ECS.
tenantId	String	ID del proyecto.
volumeSize	Integer	Espacio de almacenamiento en disco.
volumeType	String	Tipo de disco.
subnetId	String	ID de subred.
enterpriseProjectId	String	ID de proyecto de empresa.
clusterType	Integer	Tipo de clúster.
subnetName	String	Nombre de subred.
securityGroupsId	String	ID del grupo de seguridad.
slaveSecurityGroupsId	String	ID de grupo de seguridad de un nodo que no es Master. Actualmente, un clúster de MRS utiliza solo un grupo de seguridad. Por lo tanto, este campo ha sido descartado.
bootstrapScripts	Array of BootstrapScript objects	La información del script de acción de arranque. Para obtener más información sobre este parámetro, consulte Tabla 6.
stageDesc	String	Descripción del progreso de la operación de clúster. El progreso de la instalación del clúster incluye: Verificación de los parámetros del clúster: se están verificando los parámetros del clúster. Aplicación de recursos de clúster: se están aplicando recursos de clúster. Creación de máquinas virtuales: se están creando las máquinas virtuales. Inicialización de máquinas virtuales: se están inicializando las máquinas virtuales. Instalación de MRS Manager: se está instalando MRS Manager. Despliegue del clúster: se está desplegando el clúster. Error en la instalación del clúster: error al instalar el clúster. El progreso de ampliación de los grupos incluye: Preparación para la ampliación: se está preparando la ampliación de clúster. Creación de máquinas virtuales: se están creando las máquinas virtuales. Inicialización de máquinas virtuales: se están inicializando las máquinas virtuales. Adición de nodos al clúster: los nodos se están agregando al clúster. Error de ampliación: error al escalar el clúster. El progreso de la reducción del clúster incluye: Preparación para la reducción: Se está preparando la reducción de clústeres. Instancia en desmantelamiento: La instancia se está desmantelando. Eliminación de máquinas virtuales: se están eliminando las máquinas virtuales. Eliminación de nodos del clúster: se eliminan los nodos del clúster. Error de reducción: error al reducir el clúster. Si la instalación del clúster, la ampliación, o reducción fallan, stageDesc mostrará la causa del error.
isMrsManagerFinish	Boolean	Si la instalación de MRS Manager ha finalizado durante la creación del clúster. true: La instalación de MRS Manager ha finalizado. false: La instalación de MRS Manager no ha finalizado.
safeMode	Integer	Modo de ejecución de un clúster MRS. 0: clúster normal 1: clúster de seguridad
clusterVersion	String	Versión del clúster.
nodePublicCertName	String	Nombre del archivo clave.
masterNodeIp	String	Dirección IP de un nodo de Master.
privateIpFirst	String	Dirección IP privada preferida.
errorInfo	String	Mensaje de error.
tags	String	La información de la etiqueta.
chargingStartTime	String	Hora de inicio de la facturación.
logCollection	Integer	Si se recopilan registros cuando se produce un error en la instalación del clúster. 0 No recoger. 1: Recoger.
taskNodeGroups	List<NodeGroup>	Lista de nodos de tarea. Para obtener más información sobre los parámetros, consulte Tabla 7.
nodeGroups	List<NodeGroup>	Lista de nodos Master, Core y Task. Para obtener más información sobre los parámetros, consulte Tabla 7.
masterDataVolumeType	String	Tipo de almacenamiento en disco de datos del nodo de Master. Actualmente, se admiten SATA, SAS y SSD.
masterDataVolumeSize	Integer	Espacio de almacenamiento en disco de datos del nodo Master. Para aumentar la capacidad de almacenamiento de datos, puede agregar discos al mismo tiempo al crear un clúster. Rango de valores: 100 GB a 32,000 GB
masterDataVolumeCount	Integer	Número de discos de datos del nodo Master El valor solo se puede establecer en 1.
coreDataVolumeType	String	Tipo de almacenamiento en disco de datos del nodo Core. Actualmente, se admiten SATA, SAS y SSD.
coreDataVolumeSize	Integer	Espacio de almacenamiento en disco de datos del nodo Core. Para aumentar la capacidad de almacenamiento de datos, puede agregar discos al mismo tiempo al crear un clúster. Rango de valores: 100 GB a 32,000 GB
coreDataVolumeCount	Integer	Número de discos de datos del nodo Core. Rango de valores: 1 a 10
periodType	Integer	Si el tipo de suscripción es anual o mensual. 0: suscripción mensual 1: suscripción anual
scale	String	El estado de cambio del nodo. Si este parámetro se deja en blanco, los nodos del clúster no se cambian. Valores posibles: Scaling-out: El clúster se está escalando horizontalmente. Scaling-in: El clúster se está reduciendo. scaling-error: El clúster está en el estado de ejecución y no se puede ampliar o reducir o las especificaciones no se pueden escalar por última vez. scaling-up: Las especificaciones del nodo principal se están ampliando. scaling_up_first: Las especificaciones del nodo principal en espera se están ampiando. scaled_up_first: Las especificaciones del nodo principal en espera se han ampliado. scaled-up-success Las especificaciones del nodo master se han ampliado.

**Tabla 5** componentAmb
Parámetro	Tipo	Descripción
componentId	String	ID de componente Por ejemplo, el component_id de Hadoop es MRS 3.0.2_001, MRS 2.1.0_001, MRS 1.9.2_001, MRS 1.8.10_001.
componentName	String	Nombre del componente
componentVersion	String	Versión del componente
componentDesc	String	Descripción de los componentes

**Tabla 6** bootstrapScripts
Parámetro	Tipo	Descripción
name	String	Nombre de un script de acción de arranque, que debe ser único en un clúster. El valor solo puede contener números, letras, espacios, guiones (-) y guiones bajos (_) y no puede comenzar con un espacio. El valor puede contener de 1 a 64 caracteres.
uri	String	La ruta de un script de acción de arranque. Establezca este parámetro en una ruta de bucket OBS o una ruta de VM local. Ruta de acceso del bucket OBS: introduzca una ruta de acceso de script. Por ejemplo, ingrese la ruta del script de muestra público proporcionado por MRS. Ejemplo: s3a://bootstrap/presto/presto-install.sh. Si dualroles está instalado, el parámetro del script de presto-install.sh es dualroles. Si worker está instalado, el parámetro de script de presto-install.sh es worker. Basado en el hábito de uso de Presto, se recomienda instalar dualroles en los nodos principales activos y worker en los nodos núcleos. Ruta de acceso de VM local: introduzca una ruta de acceso de script. La ruta de acceso del script debe comenzar con una barra diagonal (/) y terminar con .sh.
parameters	String	Los parámetros de script de acción de arranque.
nodes	Array of strings	Tipo de nodo donde se ejecuta el script de acción de Bootstrap. El valor puede ser master, core o task. El tipo de nodo debe estar representado en minúsculas.
active_master	Boolean	Si el script de acción de arranque sólo se ejecuta en nodos principales activos. El valor predeterminado es false, que indica que el script de acción de arranque puede ejecutarse en todos los nodos principales.
fail_action	String	Si se deben continuar ejecutando scripts subsiguientes y crear un clúster después de que el script de acción de arranque no se ejecute. El valor predeterminado es errorout, que indica que la acción está detenida. Nota: Se recomienda establecer este parámetro en continue en la fase de puesta en marcha para que el clúster pueda seguir siendo instalado e iniciado sin importar si la acción de arranque es correcta. Valores posibles: continue: Continuar para ejecutar scripts subsiguientes. errorout: detener la acción.
before_component_start	Boolean	Hora en que se ejecuta el script de acción de arranque. Actualmente, están disponibles las dos opciones siguientes: Before component start y After component start. El valor predeterminado es false, que indica que el script de acción de arranque se ejecuta después de iniciar el componente.
start_time	Long	El tiempo de ejecución de un script de acción de arranque.
state	String	El estado de ejecución de un script de acción de arranque. PENDING IN_PROGRESS SUCCESS FAILURE
action_stages	Array of strings	Seleccione la hora a la que se ejecuta el script de acción de arranque. BEFORE_COMPONENT_FIRST_START: antes de que comience el componente inicial AFTER_COMPONENT_FIRST_START: después de que comience el componente inicial BEFORE_SCALE_IN: antes de reducir AFTER_SCALE_IN: después de reducir BEFORE_SCALE_OUT: antes de escalar horizontalmente after_scale_out: después de escalar horizontalmente

**Tabla 7** NodeGroupV10
Parámetro	Tipo	Descripción
GroupName	String	Nombre del grupo de nodos.
NodeNum	Integer	Número de nodos. El valor varía de 0 a 500. El número mínimo de nodos de Master y Core es 1 y el número total de nodos Core y Task no puede exceder de 500.
NodeSize	String	Especificaciones de instancia de un nodo.
NodeSpecId	String	ID de especificación de instancia de un nodo
NodeProductId	String	ID de producto de instancia de un nodo
VmProductId	String	ID de producto de VM de un nodo
VmSpecCode	String	Especificaciones de VM de un nodo
RootVolumeSize	Integer	Tamaño del disco del sistema de un nodo. Este parámetro no es configurable y su valor predeterminado es 40 GB.
RootVolumeProductId	String	ID de producto de disco de sistema de un nodo
RootVolumeType	String	Tipo de disco de sistema de un nodo
RootVolumeResourceSpecCode	String	Especificaciones de producto de disco de sistema de un nodo
RootVolumeResourceType	String	Tipo de producto de disco de sistema de un nodo
DataVolumeType	String	Tipo de almacenamiento de disco de datos de un nodo. Actualmente, se admiten SATA, SAS y SSD. SATA: E/S común SAS: E/S alta SSD: E/S ultra alta
DataVolumeCount	Integer	Número de discos de datos de un nodo.
DataVolumeSize	Integer	Espacio de almacenamiento en disco de datos de un nodo.
DataVolumeProductId	String	ID de producto de disco de datos de un nodo
DataVolumeResourceSpecCode	String	Especificaciones de producto de disco de datos de un nodo
DataVolumeResourceType	String	Tipo de producto de disco de datos de un nodo

Ejemplo de respuesta

Código de estado: 200

La consulta de la lista de clústeres se realiza correctamente.

{
  "clusterTotal" : "1",
  "clusters" : [ {
    "clusterId" : "bc134369-294c-42b7-a707-b2036ba38524",
    "clusterName" : "mrs_D0zW",
    "masterNodeNum" : "2",
    "coreNodeNum" : "3",
    "clusterState" : "terminated",
    "createAt" : "1498272043",
    "updateAt" : "1498636753",
    "chargingStartTime" : "1498273733",
    "logCollection" : "1",
    "billingType" : "Metered",
    "dataCenter" : "cn-hk1",
    "vpc" : null,
    "duration" : "0",
    "fee" : null,
    "hadoopVersion" : null,
    "masterNodeSize" : null,
    "coreNodeSize" : null,
    "componentList" : [ {
      "componentId" : "MRS 3.1.0_001",
      "componentName" : "Hadoop",
      "componentVersion" : "3.1.1",
      "componentDesc" : "A framework that allows for the distributed processing of large data sets across clusters."
    }, {
      "componentId" : "MRS 3.1.0_003",
      "componentName" : "HBase",
      "componentVersion" : "2.1.1",
      "componentDesc" : "A scalable, distributed database that supports structured data storage for large tables."
    }, {
      "componentId" : "MRS 3.1.0_002",
      "componentName" : "Spark",
      "componentVersion" : "2.3.2",
      "componentDesc" : "A fast and general engine for large-scale data processing."
    }, {
      "componentId" : "MRS 3.1.0_004",
      "componentName" : "Hive",
      "componentVersion" : "3.1.0",
      "componentDesc" : "A data warehouse infrastructure that provides data summarization and ad hoc querying."
    } ],
    "externalIp" : null,
    "externalAlternateIp" : null,
    "internalIp" : null,
    "deploymentId" : null,
    "remark" : "",
    "orderId" : null,
    "azId" : null,
    "azCode" : null,
    "masterNodeProductId" : null,
    "masterNodeSpecId" : null,
    "coreNodeProductId" : null,
    "coreNodeSpecId" : null,
    "azName" : "AZ1",
    "instanceId" : null,
    "vnc" : "v2/5a3314075bfa49b9ae360f4ecd333695/servers/e2cda891-232e-4703-995e-3b1406add01d/action",
    "tenantId" : null,
    "volumeSize" : "0",
    "volumeType" : null,
    "subnetId" : null,
    "subnetName" : null,
    "securityGroupsId" : null,
    "slaveSecurityGroupsId" : null,
    "bootstrapScripts" : [ {
      "name" : "test1-success",
      "uri" : "s3a://bootscript/script/simple/basic_success.sh",
      "parameters" : "",
      "nodes" : [ "master", "core" ],
      "active_master" : true,
      "fail_action" : "errorout",
      "before_component_start" : true,
      "state" : "SUCCESS",
      "start_time" : 1527681083,
      "action_stages" : [ "AFTER_SCALE_IN", "AFTER_SCALE_OUT" ]
    } ],
    "isMrsManagerFinish" : false,
    "stageDesc" : "Installing MRS Manager",
    "safeMode" : "0",
    "clusterVersion" : null,
    "nodePublicCertName" : null,
    "masterNodeIp" : "unknown",
    "privateIpFirst" : null,
    "errorInfo" : "",
    "clusterType" : "0",
    "nodeGroups" : [ {
      "GroupName" : "master_node_default_group",
      "NodeNum" : "1",
      "NodeSize" : "s3.xlarge.2.linux.bigdata",
      "NodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7",
      "VmProductId" : "",
      "VmSpecCode" : null,
      "NodeProductId" : "dc970349d128460e960a0c2b826c427c",
      "RootVolumeSize" : "40",
      "RootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "RootVolumeType" : "SATA",
      "RootVolumeResourceSpecCode" : "",
      "RootVolumeResourceType" : "",
      "DataVolumeType" : "SATA",
      "DataVolumeCount" : "1",
      "DataVolumeSize" : "100",
      "DataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "DataVolumeResourceSpecCode" : "",
      "DataVolumeResourceType" : ""
    }, {
      "GroupName" : "core_node_analysis_group",
      "NodeNum" : "1",
      "NodeSize" : "s3.xlarge.2.linux.bigdata",
      "NodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7",
      "VmProductId" : "",
      "VmSpecCode" : null,
      "NodeProductId" : "dc970349d128460e960a0c2b826c427c",
      "RootVolumeSize" : "40",
      "RootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "RootVolumeType" : "SATA",
      "RootVolumeResourceSpecCode" : "",
      "RootVolumeResourceType" : "",
      "DataVolumeType" : "SATA",
      "DataVolumeCount" : "1",
      "DataVolumeSize" : "100",
      "DataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "DataVolumeResourceSpecCode" : "",
      "DataVolumeResourceType" : ""
    }, {
      "GroupName" : "task_node_analysis_group",
      "NodeNum" : "1",
      "NodeSize" : "s3.xlarge.2.linux.bigdata",
      "NodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7",
      "VmProductId" : "",
      "VmSpecCode" : null,
      "NodeProductId" : "dc970349d128460e960a0c2b826c427c",
      "RootVolumeSize" : "40",
      "RootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "RootVolumeType" : "SATA",
      "RootVolumeResourceSpecCode" : "",
      "RootVolumeResourceType" : "",
      "DataVolumeType" : "SATA",
      "DataVolumeCount" : "1",
      "DataVolumeSize" : "100",
      "DataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "DataVolumeResourceSpecCode" : "",
      "DataVolumeResourceType" : ""
    } ],
    "taskNodeGroups" : [ {
      "GroupName" : "task_node_default_group",
      "NodeNum" : "1",
      "NodeSize" : "s3.xlarge.2.linux.bigdata",
      "NodeSpecId" : "cdc6035a249a40249312f5ef72a23cd7",
      "VmProductId" : "",
      "VmSpecCode" : null,
      "NodeProductId" : "dc970349d128460e960a0c2b826c427c",
      "RootVolumeSize" : "40",
      "RootVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "RootVolumeType" : "SATA",
      "RootVolumeResourceSpecCode" : "",
      "RootVolumeResourceType" : "",
      "DataVolumeType" : "SATA",
      "DataVolumeCount" : "1",
      "DataVolumeSize" : "100",
      "DataVolumeProductId" : "16c1dcf0897249758b1ec276d06e0572",
      "DataVolumeResourceSpecCode" : "",
      "DataVolumeResourceType" : ""
    } ],
    "masterDataVolumeType" : "SATA",
    "masterDataVolumeSize" : "200",
    "masterDataVolumeCount" : "1",
    "coreDataVolumeType" : "SATA",
    "coreDataVolumeSize" : "100",
    "coreDataVolumeCount" : "1",
    "periodType" : "0"
  } ]
}

Códigos de estado

Tabla 8 describe el código de estado.

**Tabla 8** Código de estado
Código de estado	Descripción
200	Se ha consultado la información de la lista de clústeres.

Consulte Códigos de estado.

Códigos de error

Consulte Códigos de error.

Consulta de una lista de clúster