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

Obtém os detalhes de uma sessão.

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

get

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces/{workspaceId}/sessionClusters/{sessionClusterId} 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
sessionClusterId	string	Não	O nome do job.	emr-spark-demo-job

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
regionId	string	Não	O ID da região.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
sessionCluster	object	O objeto da sessão.
workspaceId	string	O ID do workspace.	w-1234abcd
sessionClusterId	string	O ID da sessão do job interativo.	1234abcd-12ab-34cd-56ef-1234567890ab
userId	string	O ID do usuário.	123xxxxxxxx
queueName	string	O nome da fila.	dev_queue
state	string	O status do job. Valores válidos: Starting: O job está iniciando. Running: O job está em execução. Stopping: O job está parando. Stopped: O job está parado. Error: O job falhou.	Running
stateChangeReason	object	O motivo da mudança de estado.
code	string	O código da mudança de estado.	1000000
message	string	A mensagem da mudança de estado.	ok
autoStartConfiguration	object	A configuração de inicialização automática.
enable	boolean	Especifica se a inicialização automática está ativada. Valores válidos: true: Sim. false: Não.	false
autoStopConfiguration	object	A configuração de parada automática.
enable	boolean	Especifica se a parada automática é permitida. Valores válidos: true: Sim. false: Não.	false
idleTimeoutMinutes	integer	O tempo limite de ociosidade em minutos após o qual a sessão é parada automaticamente.	60
applicationConfigs	array<object>	A lista de configurações do aplicativo Spark.
	object	A configuração do aplicativo Spark.
configFileName	string	O nome do arquivo de configuração.	spark-defaults.conf
configItemKey	string	A chave de configuração.	spark.app.name
configItemValue	string	O valor de configuração.	test
releaseVersion	string	A versão do Serverless Spark.	esr-4.0.0 (Spark 3.5.2, Scala 2.12)
name	string	O nome da sessão.	test
userName	string	O nome do criador da sessão.	user1
kind	string	O tipo de job efetivo. Este parâmetro é obrigatório e não pode ser modificado após a criação. Valores válidos: SQLSCRIPT: Job SQL. JAR: Job JAR. PYTHON: Job Python.	SQL
webUI	string	A URL da Spark UI da sessão.	https://spark-ui/link
draftId	string	O ID do job de desenvolvimento vinculado à sessão.	TSK-xxxxxxxx
domain	string	O domínio ao qual a Spark UI da sessão pertence.	your.domain.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
envId	string	O ID do ambiente.	env-cpv569tlhtgndjl8****
gmtCreate	integer	A hora de criação.	2024-09-01 06:23:01
startTime	integer	A hora de início.	2024-09-01 06:23:01
domainInner	string	O nome de domínio interno.	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 da sessão.
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Exemplos

Resposta de sucesso

JSON formato

{
  "sessionCluster": {
    "workspaceId": "w-1234abcd",
    "sessionClusterId": "1234abcd-12ab-34cd-56ef-1234567890ab",
    "userId": "123xxxxxxxx",
    "queueName": "dev_queue",
    "state": "Running",
    "stateChangeReason": {
      "code": "1000000",
      "message": "ok"
    },
    "autoStartConfiguration": {
      "enable": false
    },
    "autoStopConfiguration": {
      "enable": false,
      "idleTimeoutMinutes": 60
    },
    "applicationConfigs": [
      {
        "configFileName": "spark-defaults.conf",
        "configItemKey": "spark.app.name",
        "configItemValue": "test"
      }
    ],
    "releaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
    "name": "test",
    "userName": "user1",
    "kind": "SQL",
    "webUI": "https://spark-ui/link",
    "draftId": "TSK-xxxxxxxx",
    "domain": "your.domain.com",
    "displayReleaseVersion": "esr-4.0.0 (Spark 3.5.2, Scala 2.12)",
    "fusion": false,
    "envId": "env-cpv569tlhtgndjl8****",
    "gmtCreate": 0,
    "startTime": 0,
    "domainInner": "emr-spark-gateway-cn-hangzhou-internal.data.aliyuncs.com",
    "extra": "{\"extraInfoKey\":\"extraInfoValue\"}",
    "publicEndpointEnabled": true,
    "connectionToken": ""
  },
  "requestId": "DD6B1B2A-5837-5237-ABE4-FF0C8944****"
}

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.