describeCluster

Obtém informações detalhadas sobre um cluster existente.

Sintaxe da solicitação

GET /v3/clusters/{clusterName}
{
  "region": "string"
}

Corpo da solicitação

clusterName

O nome do cluster.

Tipo: string

Obrigatório: sim

region

A Região da AWS em que o cluster está.

Tipo: string

Obrigatório: não

Sintaxe da resposta

nota

failureReason mudou para failures a partir do AWS ParallelCluster versão 3.5.0.

{
  "clusterName": "string",
  "region": "string",
  "version": "string",
  "cloudFormationStackStatus": "CREATE_IN_PROGRESS",
  "clusterStatus": "CREATE_IN_PROGRESS",
  "scheduler": {
    "type": "string",
    "metadata": {
      "name": "string",
      "version": "string"
    }
  },
  "cloudformationStackArn": "string",
  "creationTime": "2019-08-24T14:15:22Z",
  "lastUpdatedTime": "2019-08-24T14:15:22Z",
  "clusterConfiguration": {
    "url": "string"
  },
  "computeFleetStatus": "START_REQUESTED",
  "tags": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "headNode": {
    "instanceId": "string",
    "instanceType": "string",
    "launchTime": "2019-08-24T14:15:22Z",
    "privateIpAddress": "string",
    "publicIpAddress": "string",
    "state": "pending"
  },
  "failures": [
    {
      "failureCode": "string",
      "failureReason": "string"
    }
  ]
  "loginNodes": {      
    "status": "string",
    "address": "string",
    "scheme": "string",
    "healthyNodes": integer,
    "unhealthyNodes": integer
  }
}

Corpo da resposta

clusterName

O nome do cluster.

Tipo: string

cloudformationStackArn

O nome do recurso da Amazon (ARN) da pilha principal do CloudFormation.

Tipo: string

cloudformationStackStatus

Status de pilha do CloudFormation.

Tipo: string

Valores válidos: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | ROLLBACK_IN_PROGRESS | ROLLBACK_FAILED | ROLLBACK_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_ROLLBACK_IN_PROGRESS | UPDATE_ROLLBACK_FAILED | UPDATE_ROLLBACK_COMPLETE_CLEANUP_IN_PROGRESS | UPDATE_ROLLBACK_COMPLETE

clusterConfiguration

url

URL do arquivo de configuração do cluster.

Tipo: string

clusterStatus

Status do cluster.

Tipo: string

Valores válidos: CREATE_IN_PROGRESS | CREATE_FAILED | CREATE_COMPLETE | DELETE_IN_PROGRESS | DELETE_FAILED | DELETE_COMPLETE | UPDATE_IN_PROGRESS | UPDATE_COMPLETE | UPDATE_FAILED

computeFleetStatus

Status da frota de computação.

Tipo: string

Valores válidos: START_REQUESTED | STARTING | RUNNING | PROTECTED | STOP_REQUESTED | STOPPING | STOPPED | UNKNOWN | ENABLED | DISABLED

creationTime

Marca de data e hora da criação do cluster.

Tipo: datetime

lastUpdatedTime

Marca de data/hora da última atualização do cluster.

Tipo: datetime

region

A Região da AWS em que o cluster foi criado.

Tipo: string

tags

Lista de tags associadas ao cluster.

chave

Nome da tag.

Tipo: string

tag

Valor da tag.

Tipo: string

version

A versão do AWS ParallelCluster usada para criar o cluster.

Tipo: string

falhas

A lista de falhas quando a pilha do cluster está em status CREATE_FAILED.

failureCode

Código de falha quando a pilha do cluster está em status CREATE_FAILED.

Tipo: string

failureReason

Razão da falha quando a pilha do cluster está em status CREATE_FAILED.

Tipo: string

head_node

Nó principal do cluster.

instanceId

O ID da instância do EC2.

Tipo: string

instanceType

Um tipo de instância do EC2.

Tipo: string

launchTime

A hora em que a instância do EC2 foi iniciada.

Tipo: datetime

privateIpAddress

O endereço IP privado do cluster.

Tipo: string

publicIpAddress

O endereço IP público do cluster.

Tipo: string

estado

O status da instância do nó principal.

Tipo: string

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

programador

metadados

Os metadados do programador.

name

O nome do programador.

Tipo: string

version

A versão do programador.

Tipo: string

loginNodes

status

O status do nó de login.

Tipo: string

Valores válidos: PENDING | FAILED | ACTIVE

address

O endereço do nó de login.

Tipo: string

scheme

O esquema do nó de login.

Tipo: string

scheme

Número de nós saudáveis.

Tipo: inteiro

scheme

O número de nós não saudáveis.

Tipo: inteiro

type

O tipo de programador.

Tipo: string

Exemplo

Python

Solicitação

$ describe_cluster(cluster_name_3x)

Resposta 200

{
  'cloud_formation_stack_status': 'CREATE_COMPLETE',
  'cloudformation_stack_arn': 'arn:aws:cloudformation:us-east-1:123456789012:stack/cluster_name_3x/16b49540-aee5-11ec-8e18-0ac1d712b241',
  'cluster_configuration': {
    'url': 'https://parallelcluster-....'
  },
  'cluster_name': 'cluster_name_3x',
  'cluster_status': 'CREATE_COMPLETE',
  'compute_fleet_status': 'RUNNING',
  'creation_time': datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  'head_node': {
    'instance_id': 'i-abcdef01234567890',
    'instance_type': 't2.micro',
    'launch_time': datetime.datetime(2022, 3, 28, 22, 21, 56, tzinfo=tzlocal()),
    'private_ip_address': '172.31.56.3',
    'public_ip_address': '107.23.100.164',
    'state': 'running'
  },
  'last_updated_time': datetime.datetime(2022, 3, 28, 22, 19, 9, 661000, tzinfo=tzlocal()),
  'region': 'us-east-1',
  'tags': [
    {
      'key': 'parallelcluster:version', 'value': '3.2.1'
    }
  ],
  'version': '3.2.1'
}