describeClusterInstances

describir las instancias que pertenecen a un clúster.

Sintaxis de la solicitud

GET /v3/clusters/{clusterName}/instances
{
  "nextToken": "string",
  "nodeType": "string",
  "queueName": "string",
  "region": "string"
}

Cuerpo de la solicitud

Nombre del clúster

El nombre del clúster.

Tipo: cadena

Obligatorio: sí

nextToken

Un token que se usa para las solicitudes paginadas.

Tipo: cadena

Requerido: No

Tipo de nodo

Filtra las instancias por tipo de nodo.

Tipo: cadena

Valores válidos: HeadNode, ComputeNode

Obligatorio: no

Nombre de la cola

Filtra las instancias por nombre de cola.

Tipo: cadena

Requerido: No

region

En elRegión de AWS que se encuentra el clúster.

Tipo: cadena

Requerido: No

Sintaxis de la respuesta

{
  "nextToken": "string",
  "instances": [
    {
      "instanceId": "string",
      "instanceType": "string",
      "launchTime": "2019-08-24T14:15:22Z",
      "privateIpAddress": "string",
      "publicIpAddress": "string",
      "state": "pending",
      "nodeType": "HeadNode",
      "queueName": "string"
    }
  ]
}

Cuerpo de respuesta

instances

La lista de instancias del clúster.

instanceId

El ID de instancia EC2.

Tipo: cadena

instanceType

El tipo de instancia EC2.

Tipo: cadena

launchTime

La hora en que se lanzó la instancia EC2.

Tipo: datetime

Tipo de nodo

El tipo de nodo.

Tipo: cadena

Valores válidos: HeadNode, ComputeNode

publicIpAddress

La dirección IP pública del clúster.

Tipo: cadena

Nombre de la cola

El nombre de la cola en la instancia EC2 respalda un nodo.

Tipo: cadena

estado

El estado de la instancia EC2 del nodo.

Tipo: cadena

Valores válidos: pending | running | shutting-down | terminated | stopping | stopped

nextToken

Un token que se usa para las solicitudes paginadas.

Tipo: cadena

Ejemplo

Python

Solicitud

$ describe_cluster_instances(cluster_name_3x)

200 Respuesta

{
  'instances': [
    {
      'instance_id': 'i-abcdef01234567890',
      'instance_type': 't2.micro',
      'launch_time': datetime.datetime(2022, 3, 30, 14, 2, 7, tzinfo=tzlocal()),
      'node_type': 'HeadNode',
      'private_ip_address': '192.0.2.5',
      'public_ip_address': '198.51.100.180',
      'state': 'running'
    }
  ]
}