GetRayCluster - E-MapReduce: Central de Documentação do Alibaba Cloud

Obtém um cluster Ray.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

emr-serverless-spark:GetRayCluster

get

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces/{workspaceId}/rayCluster/{clusterId} HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
workspaceId	string	Não	O ID do workspace.	w-d2d82aa09155
clusterId	string	Não	O ID do cluster.	ray-xxxxxxxxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944
clusterId	string	O ID do cluster Ray.	ray-k7nm8ahl5te4tg91
name	string	O nome do cluster Ray.	myRayCluster
displayReleaseVersion	string	A versão do mecanismo Ray DPI.	ray-1.0.0 (Ray 2.47.1, Python 3.12)
description	string	A descrição.	Ray Cluster for dev.
networkServiceName	string	O nome da conectividade de rede.	vpc
headSpec	object	Os parâmetros do nó head do cluster Ray.
queueName	string	O nome da fila.	root_queue
cpu	string	O número de núcleos de CPU.	2
memory	string	O tamanho da memória, em GiB.	8Gi
enableAutoScaling	boolean	Indica se o auto scaling está ativado para os nós worker.	false
idleTimeoutSeconds	integer	O período de tempo limite de ociosidade para os nós worker após a ativação do auto scaling.	60
replica	integer	O número de nós.	1
gpuSpec	string	O tipo de instância de GPU.	ecs.gn6i-c4g1.xlarge
gftEnabled	boolean	Indica se a tolerância a falhas do GCS está ativada.
gftConfig	object	A configuração de tolerância a falhas do GCS.
redisUrl	string	O endereço do Redis.	10.4.5.6:6789
redisUsername	string	O nome de usuário do Redis.	default
redisPassword	string	A senha do Redis.	123456
env	string	As variáveis de ambiente.	MY_ENV=123456
rayStartParams	string	Os parâmetros de inicialização do Ray.	--num-cpus=0
displayReleaseVersion	string	A versão do mecanismo Ray DPI.	err-1.3.0 (Ray 2.55.1, Python 3.12)
state	string	O status da sessão. Valores válidos: Starting: iniciando. Running: em execução. Stopping: parando. Stopped: parado. Error: com falha. Valores válidos: Stopped : Parado. Starting : Iniciando. Running : Em execução. Error : Erro. Stopping : Parando.	Running
creator	string	O UID do usuário que criou o cluster.	202077646755523991
creatorName	string	O apelido do criador.	Alice
modifier	string	O UID do usuário que atualizou o cluster pela última vez.	202077646755523991
modifierName	string	O apelido do modificador.	Alice
userId	string	O ID da conta Alibaba Cloud do criador.	123456789012
dashboardUrl	string	A URL do painel do cluster Ray.	https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx
jobUrl	string	O endereço público para envio de jobs do Ray.	https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com
submitToken	string	O token de autenticação para envio de jobs do Ray. Inclua este token no cabeçalho da solicitação como "ray-token": "token".	1d06484d3b424f7fa4ab7082a4076da2
modified	boolean	Indica se a configuração foi modificada.	false
extraParam	string	Os parâmetros adicionais no formato JSON.	{}
message	string	A mensagem de erro quando o status é Error.	ok
instances	array<object>	Os IDs dos nós do cluster Ray.
	object	A estrutura do nó do cluster Ray.
type	string	O tipo de nó.	Head
instanceId	string	O ID do nó.	ray-uiulpgow9xljim10-head-7cgta
containerState	string	O estado do contêiner principal.	Running
reason	string	As informações do nó.	OOMKilled
phase	string	O estado do pod do nó.	Running
message	string	As informações do estado do pod do nó.	ok
startTime	integer	A hora de início. O valor é um timestamp UNIX em milissegundos.	1762946698000
createTime	integer	A hora de criação. O valor é um timestamp UNIX em milissegundos.	1735870116167
containerStateReason	string	As informações do contêiner principal.	ok
containerStateMessage	string	As informações do estado do contêiner principal.	ContainerExit
containerExitCode	integer	O código de saída do contêiner principal.	137
instanceId	string	Os IDs dos nós do cluster Ray.	ray-k7nm8ahl5te4tg93-xxxxxxx
workerSpec	array<object>	As informações do nó worker do cluster Ray.
	object	A estrutura das informações do nó worker do cluster Ray.
groupName	string	O nome do grupo de nós worker.	WorkerGroup1
workerType	string	O tipo do grupo de nós worker. Valores válidos: CPU : Worker de CPU.	CPU
replica	integer	O número de nós worker.	2
queueName	string	O nome da fila.	root_queue
cpu	string	O número de núcleos de CPU.	2
memory	string	O tamanho da memória, em GiB.	8Gi
minReplica	integer	O número mínimo de workers.	1
maxReplica	integer	O número máximo de workers.	10
gpuSpec	string	O tipo de instância de GPU.	ecs.gn6i-c4g1.xlarge
displayReleaseVersion	string	A versão do mecanismo de banco de dados.	ray-1.2.0 (Ray 2.55.1, Python 3.12)
env	string	As variáveis de ambiente do Ray.	MY_ENV=12456
rayStartParams	string	Os parâmetros de inicialização do Ray.	--num-cpus=0
startTime	integer	A hora de início. O valor é um timestamp UNIX em milissegundos.	1750327083303
createTime	integer	A hora de criação. O valor é um timestamp UNIX em milissegundos.	1750327083303
modifiedTime	integer	A hora de atualização. O valor é um timestamp UNIX em milissegundos.	1754274541693
grpcEndpoint	string	O endpoint gRPC (rede interna). O nome de domínio no endpoint também pode ser usado para enviar jobs do Ray.	ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80
volumeIds	array	A lista de IDs de arquivos gerenciados.
	string	O ID do arquivo gerenciado.	vol-123456789
jobUrlInner	string	O endereço de rede interna para envio de jobs do Ray.	http://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "clusterId": "ray-k7nm8ahl5te4tg91",
  "name": "myRayCluster",
  "displayReleaseVersion": "ray-1.0.0 (Ray 2.47.1, Python 3.12)",
  "description": "Ray Cluster for dev",
  "networkServiceName": "vpc",
  "headSpec": {
    "queueName": "root_queue",
    "cpu": "2",
    "memory": "8Gi",
    "enableAutoScaling": false,
    "idleTimeoutSeconds": 60,
    "replica": 1,
    "gpuSpec": "ecs.gn6i-c4g1.xlarge",
    "gftEnabled": false,
    "gftConfig": {
      "redisUrl": "10.4.5.6:6789",
      "redisUsername": "default",
      "redisPassword": "123456"
    },
    "env": "MY_ENV=123456",
    "rayStartParams": "--num-cpus=0",
    "displayReleaseVersion": "err-1.3.0 (Ray 2.55.1, Python 3.12)"
  },
  "state": "Running",
  "creator": "202077646755523991",
  "creatorName": "Alice",
  "modifier": "202077646755523991",
  "modifierName": "Alice",
  "userId": "123456789012",
  "dashboardUrl": "https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx",
  "jobUrl": "https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com",
  "submitToken": "1d06484d3b424f7fa4ab7082a4076da2",
  "modified": false,
  "extraParam": "{}",
  "message": "ok",
  "instances": [
    {
      "type": "Head",
      "instanceId": "ray-uiulpgow9xljim10-head-7cgta",
      "containerState": "Running",
      "reason": "OOMKilled",
      "phase": "Running",
      "message": "ok",
      "startTime": 1762946698000,
      "createTime": 1735870116167,
      "containerStateReason": "ok",
      "containerStateMessage": "ContainerExit",
      "containerExitCode": 137
    }
  ],
  "instanceId": "ray-k7nm8ahl5te4tg93-xxxxxxx",
  "workerSpec": [
    {
      "groupName": "WorkerGroup1",
      "workerType": "CPU",
      "replica": 2,
      "queueName": "root_queue",
      "cpu": "2",
      "memory": "8Gi",
      "minReplica": 1,
      "maxReplica": 10,
      "gpuSpec": "ecs.gn6i-c4g1.xlarge",
      "displayReleaseVersion": "ray-1.2.0 (Ray 2.55.1, Python 3.12)",
      "env": "MY_ENV=12456",
      "rayStartParams": "--num-cpus=0"
    }
  ],
  "startTime": 1750327083303,
  "createTime": 1750327083303,
  "modifiedTime": 1754274541693,
  "grpcEndpoint": "ray://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com:80",
  "volumeIds": [
    "vol-123456789"
  ],
  "jobUrlInner": "http://emr-spark-ray-gateway-cn-hangzhou-internal.emr.aliyuncs.com"
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.