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

Lista os clusters 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:ListRayCluster

none

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces/{workspaceId}/rayCluster 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

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
pageSize	integer	Não	O número de entradas a serem retornadas em cada página. Valor padrão: 20. Valor mínimo: 1. Valor máximo: 100.	20
pageNum	integer	Não	O número da página.	1

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
rayClusters	array<object>	A lista de clusters Ray.
	array<object>	A estrutura do cluster Ray.
clusterId	string	O ID do cluster.	ray-uiulpgow9xljimm1
name	string	O nome do cluster Ray.	testRayCluster
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	As informações do nó principal 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	Especifica se o auto scaling está ativado para os nós worker.	false
idleTimeoutSeconds	integer	O tempo limite de ociosidade para os nós worker, em segundos.	60
replica	integer	O número de nós.	1
gpuSpec	string	O tipo de instância GPU.	ecs.gn6i-c4g1.xlarge
workerSpec	array<object>	As informações do worker do cluster Ray.
	object	A estrutura de informações do worker do cluster Ray.
groupName	string	O nome do grupo de workers.	Group1
workerType	string	O tipo do worker. Valores válidos: CPU : Worker CPU.	CPU
replica	integer	O número de nós.	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 quando o auto scaling está ativado.	1
maxReplica	integer	O número máximo de workers quando o auto scaling está ativado.	10
gpuSpec	string	O tipo de instância GPU.	ecs.gn6i-c4g1.xlarge
state	string	O status do cluster. Valores válidos: Starting: O cluster está iniciando. Running: O cluster está em execução. Stopping: O cluster está parando. Stopped: O cluster está parado. Error: O cluster falhou. Valores válidos: Stopped : Parado. Starting : Iniciando. Running : Em execução. Error : Erro. Stopping : Parando.	Running
createTime	integer	A hora de criação. O valor é um timestamp UNIX em milissegundos.	1723722279800
modifiedTime	integer	A hora de modificação. O valor é um timestamp UNIX em milissegundos.	1723722279800
creator	string	O UID do criador.	202077646755123991
creatorName	string	O apelido do criador.	Alice
modifier	string	O UID do último atualizador.	202077646755123991
modifierName	string	O apelido do modificador.	Alice
userId	string	O ID da conta Alibaba Cloud.	1234567890
dashboardUrl	string	A URL do painel do cluster Ray.	https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx
modified	boolean	Especifica se a configuração foi modificada.	false
message	string	A mensagem de erro.	ok
instanceId	string	O ID da instância do cluster Ray.	ray-uiulpgow9xljimm1-xxxxxxx
startTime	integer	A hora de início. O valor é um timestamp UNIX em milissegundos.	1723722279800
grpcEndpoint	string	O endpoint gRPC interno. Você também pode usar o nome de domínio para enviar jobs do Ray.	ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944",
  "rayClusters": [
    {
      "clusterId": "ray-uiulpgow9xljimm1",
      "name": "testRayCluster",
      "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"
      },
      "workerSpec": [
        {
          "groupName": "Group1",
          "workerType": "CPU",
          "replica": 2,
          "queueName": "root_queue",
          "cpu": "2",
          "memory": "8Gi",
          "minReplica": 1,
          "maxReplica": 10,
          "gpuSpec": "ecs.gn6i-c4g1.xlarge"
        }
      ],
      "state": "Running",
      "createTime": 1723722279800,
      "modifiedTime": 1723722279800,
      "creator": "202077646755123991",
      "creatorName": "Alice",
      "modifier": "202077646755123991",
      "modifierName": "Alice",
      "userId": "1234567890",
      "dashboardUrl": "https://emr-spark-ray-gateway-cn-hangzhou.aliyuncs.com?token=xxxxxxxxx",
      "modified": false,
      "message": "ok",
      "instanceId": "ray-uiulpgow9xljimm1-xxxxxxx",
      "startTime": 1723722279800,
      "grpcEndpoint": "ray://emr-spark-ray-gateway-cn-hanghzou-internal.emr.aliyuncs.com:80"
    }
  ]
}

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.