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

Obtém uma lista de sessões.

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

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces/{workspaceId}/sessionClusters HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
workspaceId	string	Não	O ID do workspace.	w-1234abcd

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
nextToken	string	Não	O token que indica a posição a partir da qual iniciar a leitura.	1
maxResults	integer	Não	O número máximo de registros a serem retornados em uma única solicitação.	20
sessionClusterId	string	Não	O nome do job.	emr-spark-demo-job
queueName	string	Não	O nome da fila.	root
kind	string	Não	O tipo de sessão. Valores válidos: NOTEBOOK : NOTEBOOK. THRIFT : THRIFT. SQL : SQL.	SQL
regionId	string	Não	O ID da região.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
sessionClusters	array<object>	A lista de sessões.
	array<object>	Os detalhes da sessão.
workspaceId	string	O ID do workspace.	w-1234abcd
sessionClusterId	string	O ID da sessão.	sc-123131
userId	string	O ID do usuário.	123131
queueName	string	O nome da fila onde a sessão é executada.	dev_queue
state	string	O status da sessão. Valores válidos: Starting: Iniciando. Running: Em execução. Stopping: Parando. Stopped: Parado. Error: Falha.	Running
stateChangeReason	object	Os detalhes da alteração de status da sessão mais recente.
code	string	O código de alteração de status.	200
message	string	A mensagem de alteração de status.	ok
autoStartConfiguration	object	A configuração de inicialização automática.
enable	boolean	Especifica se a inicialização automática está ativada.	true
autoStopConfiguration	object	A configuração de parada automática.
enable	boolean	Especifica se a parada automática está ativada.	false
idleTimeoutMinutes	integer	O número de minutos de ociosidade após os quais a sessão é parada automaticamente.	45
applicationConfigs	array<object>	As configurações da sessão, que são equivalentes às configurações do job Spark subjacente.
	object	As configurações do SQL Compute, que são equivalentes às configurações do job Spark subjacente.
configFileName	string	O nome do arquivo de configuração.	spark-default.conf
configItemKey	string	A chave de configuração.	spark.app.name
configItemValue	string	O valor de configuração.	test_application
name	string	O nome da sessão.	adhoc_query
userName	string	O nome de usuário.	test_user
kind	string	O tipo de sessão. Valores válidos: NOTEBOOK : NOTEBOOK. THRIFT : THRIFT. SQL : SQL.	SQL
webUI	string	A URL da Spark UI da sessão.	http://spark-ui-xxxx
releaseVersion	string	A versão do Serverless Spark.	esr-4.0.0 (Spark 3.5.2, Scala 2.12)
draftId	string	O ID do job de desenvolvimento vinculado à sessão.	TSK-xxxxxxxxx
domain	string	O nome de domínio público do servidor Thrift.	emr-spark-gateway-cn-hangzhou.data.aliyun.com
displayReleaseVersion	string	A versão realmente exibida no console.	esr-4.0.0 (Spark 3.5.2, Scala 2.12)
fusion	boolean	Especifica se a aceleração do mecanismo Fusion está ativada.	false
gmtCreate	integer	A hora de criação.	1732267598000
startTime	integer	A hora de início. O valor é um timestamp UNIX em milissegundos.	1732267598000
domainInner	string	O nome de domínio interno do servidor Thrift.	emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com
extra	string	Os metadados extras da sessão.	{"extraInfoKey":"extraInfoValue"}
publicEndpointEnabled	boolean	Especifica se o endpoint de acesso à rede pública está ativado.	true
connectionToken	string	O token usado para conectar ao cluster de sessões.
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	O token que indica a posição dos dados retornados.	1
maxResults	integer	O número máximo de registros retornados na solicitação atual.	20
totalCount	integer	O número total de registros que atendem às condições da solicitação atual.	200

Exemplos

Resposta de sucesso

JSON formato

{
  "sessionClusters": [
    {
      "workspaceId": "w-1234abcd",
      "sessionClusterId": "sc-123131",
      "userId": "123131",
      "queueName": "dev_queue",
      "state": "Running",
      "stateChangeReason": {
        "code": "200",
        "message": "ok"
      },
      "autoStartConfiguration": {
        "enable": true
      },
      "autoStopConfiguration": {
        "enable": false,
        "idleTimeoutMinutes": 45
      },
      "applicationConfigs": [
        {
          "configFileName": "spark-default.conf",
          "configItemKey": "spark.app.name",
          "configItemValue": "test_application"
        }
      ],
      "name": "adhoc_query",
      "userName": "test_user",
      "kind": "SQL",
      "webUI": "http://spark-ui-xxxx",
      "releaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
      "draftId": "TSK-xxxxxxxxx\n",
      "domain": "emr-spark-gateway-cn-hangzhou.data.aliyun.com",
      "displayReleaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
      "fusion": false,
      "gmtCreate": 1732267598000,
      "startTime": 1732267598000,
      "domainInner": "emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com",
      "extra": "{\"extraInfoKey\":\"extraInfoValue\"}",
      "publicEndpointEnabled": true,
      "connectionToken": ""
    }
  ],
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****",
  "nextToken": "1",
  "maxResults": 20,
  "totalCount": 200
}

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.