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

Obtém informações do Ray Job.

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:GetRayJob

get

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces/{workspaceId}/rayJob/{submissionId} 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
submissionId	string	Não	O ID do Ray Job.	rj-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	O esquema da resposta.
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944
submissionId	string	O ID do Ray Job.	rj-xxxxxxxxxx
name	string	O nome do cluster Ray.	myRayCluster
displayReleaseVersion	string	A versão do mecanismo Ray DPI.	err-1.2.0 (Ray 2.55.1, Python 3.12)
tags	array	As tags.
	Tag	As tags.
status	string	O status da tarefa. Valores válidos: Submitted: A tarefa foi enviada. Pending: O cluster está sendo criado. Running: A tarefa está em execução. Succeeded: A tarefa foi concluída com êxito. Failed: A tarefa falhou. Cancelling: A tarefa está sendo cancelada. Cancelled: A tarefa foi cancelada. Timeout: A tarefa expirou e foi cancelada.	Running
message	string	As informações de execução.	Job finished successfully
entrypoint	string	O comando de inicialização.	python main.py
submitTime	integer	A hora de envio da tarefa. Este valor é um timestamp UNIX em milissegundos.	1750327082303
startTime	integer	A hora de início. Este valor é um timestamp UNIX em milissegundos.	1750327083303
endTime	integer	A hora de término da tarefa. Este valor é um timestamp UNIX em milissegundos.	1762949372000
duration	integer	A duração da tarefa, em segundos.	2459764
networkServiceName	string	O nome da conectividade de rede.	vpc
runtimeEnvJson	string	A string JSON do ambiente de runtime do Ray.	{"pip":["requests==2.26.0","pendulum==2.1.2"],"env_vars":{"KEY":"VALUE"}}
workingDir	string	A URL do diretório de trabalho do código da tarefa.	oss://mybucket/hello.zip
submissionMode	string	O modo de envio do job.	HTTPMode
metadataJson	string	A string JSON de metadados da tarefa.	{"owner": "alice"}
entrypointNumCpus	string	O número de CPUs solicitadas pela tarefa entrypoint.	1
entrypointNumGpus	string	O número de GPUs solicitadas pela tarefa entrypoint.	0
entrypointMemory	string	O tamanho de memória solicitado pela tarefa entrypoint.	4Gi
entrypointResources	string	A string JSON de solicitação de recursos personalizados para a tarefa entrypoint.	{"fpu": 1}
shutdownAfterJobFinishes	boolean	Especifica se o cluster temporário deve ser destruído automaticamente após a conclusão da tarefa. Valor padrão: true.	true
ttlSecondsAfterFinished	integer	O número de segundos a aguardar antes de destruir o cluster. Este parâmetro só entra em vigor quando shutdownAfterJobFinishes está definido como true.	60
activeDeadlineSeconds	integer	O período de timeout.	3600
volumeIds	array	A lista de IDs de arquivos gerenciados.
	string	O ID do arquivo gerenciado.	vol-123456789
backoffLimit	integer	O número de novas tentativas em caso de falha. Atualmente fixado em 0.	2
headSpec	object	Os parâmetros do nó head do cluster Ray.
replica	integer	O número de nós.	1
enableAutoScaling	boolean	Indica se o escalonamento automático está ativado para os nós worker.	true
idleTimeoutSeconds	integer	O timeout de ociosidade para nós worker quando o escalonamento automático está ativado.	60
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
gpuSpec	string	O tipo de GPU.	ecs.gn6i-c4g1.xlarge
displayReleaseVersion	string	A versão do mecanismo Ray DPI.	err-1.3.0 (Ray 2.55.1, Python 3.12)
workerSpecs	array<object>	As informações do nó worker do cluster Ray.
	object	A estrutura de informações do nó worker do cluster Ray.
groupName	string	O nome do grupo de nós worker.	WorkerGroup1
replica	integer	O número de nós worker.	1
minReplica	integer	O número mínimo de workers.	1
maxReplica	integer	O número máximo de workers.	10
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
gpuSpec	string	O tipo de GPU.	ecs.gn6i-c4g1.xlarge
displayReleaseVersion	string	A versão do mecanismo DPI.	ray-1.2.0 (Ray 2.55.1, Python 3.12)
extraParam	string	Os parâmetros extras no formato JSON.	{"userDefinedFiles": "oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json", "userRequirementsFile": "oss://mybucket/requirements.txt"}
creatorName	string	O apelido do criador.	Alice
dashboardUrl	string	A URL do painel do cluster Ray. Quando o cluster Ray está no estado Running, esta é a Runtime UI. Após o cluster entrar no estado Deleted, esta é a History UI. A History UI é suportada apenas na versão err-1.2.0 e posteriores.	https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx
logBucketName	string	O nome do bucket que armazena logs.	ss-ray-cn-hangzhou
logPath	string	O caminho onde os logs são armazenados.	w-xxxxxxx/ray/logs/xxxxxx/
cuHours	number	Os recursos de CU consumidos. Este valor é retornado 10 minutos após o cluster ser liberado.	1899
guHours	object	As horas de GPU consumidas. Este campo está vazio atualmente.
gpuSpec	string	O tipo de GPU.	ecs.gn6i-c4g1.xlarge
gpuHours	number	As horas de GPU consumidas.	2.6
dashboardUrlExtra	array	As URLs extras da interface do painel. Este campo está vazio atualmente.
	string	As URLs extras da interface do painel. Este campo está vazio atualmente.	-
clusterState	string	O status do cluster Ray correspondente. Valores válidos: Deleted: Excluído. Submitted: Enviado, mas a criação não foi iniciada. Pending: Em criação. Running: Em execução.	Running
taskBizId	string	O ID do nó de desenvolvimento de dados.	TSK-682e0112f6f24d9f9305b92174846985

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "submissionId": "rj-xxxxxxxxxx",
  "name": "myRayCluster",
  "displayReleaseVersion": "err-1.2.0 (Ray 2.55.1, Python 3.12)",
  "tags": [
    {
      "key": "workflowId",
      "value": "wf-123test"
    }
  ],
  "status": "Running",
  "message": "Job finished successfully.",
  "entrypoint": "python main.py",
  "submitTime": 1750327082303,
  "startTime": 1750327083303,
  "endTime": 1762949372000,
  "duration": 2459764,
  "networkServiceName": "vpc",
  "runtimeEnvJson": "{\"pip\":[\"requests==2.26.0\",\"pendulum==2.1.2\"],\"env_vars\":{\"KEY\":\"VALUE\"}}",
  "workingDir": "oss://mybucket/hello.zip",
  "submissionMode": "HTTPMode",
  "metadataJson": "{\"owner\": \"alice\"}",
  "entrypointNumCpus": "1",
  "entrypointNumGpus": "0",
  "entrypointMemory": "4Gi",
  "entrypointResources": "{\"fpu\": 1}",
  "shutdownAfterJobFinishes": true,
  "ttlSecondsAfterFinished": 60,
  "activeDeadlineSeconds": 3600,
  "volumeIds": [
    "vol-123456789"
  ],
  "backoffLimit": 2,
  "headSpec": {
    "replica": 1,
    "enableAutoScaling": true,
    "idleTimeoutSeconds": 60,
    "queueName": "root_queue",
    "cpu": "2",
    "memory": "8Gi",
    "gpuSpec": "ecs.gn6i-c4g1.xlarge",
    "displayReleaseVersion": "err-1.3.0 (Ray 2.55.1, Python 3.12)"
  },
  "workerSpecs": [
    {
      "groupName": "WorkerGroup1",
      "replica": 1,
      "minReplica": 1,
      "maxReplica": 10,
      "queueName": "root_queue",
      "cpu": "2",
      "memory": "8Gi",
      "gpuSpec": "ecs.gn6i-c4g1.xlarge",
      "displayReleaseVersion": "ray-1.2.0 (Ray 2.55.1, Python 3.12)"
    }
  ],
  "extraParam": "{\"userDefinedFiles\": \"oss://mybucket/artifact/config.json,oss://mybucket/artifact/config2.json\", \"userRequirementsFile\": \"oss://mybucket/requirements.txt\"}",
  "creatorName": "Alice",
  "dashboardUrl": "https://emr-ray-gateway-cn-hangzhou.aliyuncs.com/workspace/w-xxxxxxxx/raycluster/ray-xxxxxx/dashboard?token=xxxxxx",
  "logBucketName": "ss-ray-cn-hangzhou",
  "logPath": "w-xxxxxxx/ray/logs/xxxxxx/",
  "cuHours": 1899,
  "guHours": {
    "gpuSpec": "ecs.gn6i-c4g1.xlarge",
    "gpuHours": 2.6
  },
  "dashboardUrlExtra": [
    "-"
  ],
  "clusterState": "Running",
  "taskBizId": "TSK-682e0112f6f24d9f9305b92174846985"
}

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.