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

Obtém os detalhes de um espaço de trabalho.

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

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
workspaceId	string	Sim	O ID do espaço de trabalho.	w-***

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.
workspace	object	O objeto do workspace.
workspaceId	string	O ID do espaço de trabalho.	w-******
workspaceName	string	O nome do workspace.	Spark batch job workspace-1
resourceSpec	string	As especificações de recursos.	{"cu": 100}
storage	string	O caminho do OSS.	spark-result
dlfCatalogId	string	As informações do catálogo DLF.	default
paymentType	string	O método de cobrança.	PayAsYouGo or Subscription
paymentDurationUnit	string	A unidade da duração da assinatura. Este parâmetro é obrigatório para instâncias de assinatura.	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
duration	integer	A duração da assinatura. Este parâmetro é obrigatório para instâncias de assinatura.	1
autoRenew	boolean	Especifica se a renovação automática deve ser ativada. Este parâmetro é obrigatório para instâncias de assinatura.	true
autoRenewPeriod	integer	A duração da renovação automática. Este parâmetro é obrigatório para instâncias de assinatura.	1
autoRenewPeriodUnit	string	O ciclo de renovação automática. Este parâmetro é obrigatório para instâncias de assinatura.	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
workspaceStatus	string	O status do workspace.	STARTING,RUNNING,TERMINATED
failReason	string	O motivo da falha.	out of stock
paymentStatus	string	O status do pagamento.	PAID/UNPAID
regionId	string	O ID da região.	cn-beijing
createTime	integer	A hora em que o workspace foi criado. A hora é exibida como um timestamp UNIX em milissegundos.	1776824869000
endTime	integer	A hora em que o workspace foi liberado.	1786586477000
stateChangeReason	object	As informações sobre a alteração de status do workspace.
code	string	O código de erro.	1000000
message	string	As informações de status do pod do nó.	ok
releaseType	string	O motivo pelo qual o workspace foi liberado.	stable
ramRoleName	string	O nome da função do RAM usada para executar jobs do Spark.	Aliyun
dlfType	string	O tipo do DLF vinculado.	DLF-NEXT
prePaidQuota	object	As informações sobre a cota de recursos de assinatura.
usedResource	string	A quantidade de recursos atualmente em uso.	{"cu": 50}
maxResource	string	A quantidade máxima de recursos que pode ser utilizada.	{"cu": 100}
allocatedResource	string	A quantidade de recursos atualmente alocada.	{"cu": 100}
createTime	integer	A hora em que o workspace foi criado. A hora é exibida como um timestamp UNIX em milissegundos.	1791802817000
expireTime	integer	A hora de expiração da cota de assinatura de GPU. A hora é exibida como um timestamp UNIX em milissegundos.	1779768979586
autoRenewal	boolean	Especifica se a renovação automática está ativada para o recurso. Valores válidos:\n- true: A renovação automática está ativada. O recurso é renovado automaticamente após a expiração.\n- false: A renovação automática está desativada. O recurso é interrompido após a expiração.	False
paymentStatus	string	O status do pedido.	NORMAL
instanceId	string	O ID da instância.	ray-df0tghlhat1776wy-klbifz8l
orderId	string	O ID do pedido.	298581757170384
prePaidQuotaGpu	array<object>	A lista de recursos de assinatura de GPU.
	object	O recurso de assinatura de GPU.
orderId	string	O ID do pedido.	2345634254
instanceId	string	O ID da instância.	w-xxxxxx-quota-gpu-xxxx
createTime	integer	A hora em que o recurso foi criado.	1782292672000
expireTime	integer	A hora de expiração do recurso.	1782292772000
autoRenewal	boolean	Especifica se a renovação automática está ativada.	False
paymentStatus	string	O status do pedido.	NORMAL
gpuSpec	string	O modelo de GPU.	ecs.gn7i-c8g1.2xlarge
gpuNum	integer	O número de instâncias de GPU.	8
instanceTypeId	string	O ID do tipo de instância.	ecs.g5.small
instanceTypeFamily	string	A família de instâncias.	ecs.g5
cpuCoreCount	string	O número de núcleos de CPU.	1
gpuAmount	integer	O número de GPUs.	1
memorySize	string	O tamanho da memória.	4096
gpuMemorySize	integer	O tamanho da memória da GPU.	4096
gpuMachineNum	integer	O número de instâncias de GPU.	1
tags	array<object>	A chave da tag.
	object	A chave da tag.
tagKey	string	A chave da tag.	[\"COST\"]
tagValue	string	O valor da tag.	3d775731-9ec1-4fe2-a00d-061d51fce677
resourceGroupId	string	O ID do grupo de recursos.	rg-aek4f7uj74wdthi
resourceOwnerId	string	O UID do criador.	13*************
gpuSpec	array	A lista de tipos de instância GPU.
	string	O modelo de GPU.	ecs.gn6e-c12g1.3xlarge
ipWhiteList	array	A lista de permissões de IP do workspace.
	string	A lista de permissões de IP do workspace.	10.0.0.1
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944****

Exemplos

Resposta de sucesso

JSON formato

{
  "workspace": {
    "workspaceId": "w-******",
    "workspaceName": "Spark batch job workspace-1",
    "resourceSpec": "{\"cu\": 100}",
    "storage": "spark-result",
    "dlfCatalogId": "default",
    "paymentType": "PayAsYouGo or Subscription",
    "paymentDurationUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
    "duration": 1,
    "autoRenew": true,
    "autoRenewPeriod": 1,
    "autoRenewPeriodUnit": "YEAR, MONTH, WEEK, DAY, HOUR, MINUTE",
    "workspaceStatus": "STARTING,RUNNING,TERMINATED",
    "failReason": "out of stock",
    "paymentStatus": "PAID/UNPAID",
    "regionId": "cn-beijing",
    "createTime": 1776824869000,
    "endTime": 1786586477000,
    "stateChangeReason": {
      "code": "1000000",
      "message": "ok"
    },
    "releaseType": "stable",
    "ramRoleName": "Aliyun",
    "dlfType": "DLF-NEXT",
    "prePaidQuota": {
      "usedResource": "{\"cu\": 50}",
      "maxResource": "{\"cu\": 100}",
      "allocatedResource": "{\"cu\": 100}",
      "createTime": 1791802817000,
      "expireTime": 1779768979586,
      "autoRenewal": true,
      "paymentStatus": "NORMAL",
      "instanceId": "ray-df0tghlhat1776wy-klbifz8l",
      "orderId": "298581757170384"
    },
    "prePaidQuotaGpu": [
      {
        "orderId": "2345634254",
        "instanceId": "w-xxxxxx-quota-gpu-xxxx",
        "createTime": 1782292672000,
        "expireTime": 1782292772000,
        "autoRenewal": true,
        "paymentStatus": "NORMAL",
        "gpuSpec": "ecs.gn7i-c8g1.2xlarge",
        "gpuNum": 8,
        "instanceTypeId": "ecs.g5.small",
        "instanceTypeFamily": "ecs.g5",
        "cpuCoreCount": "1",
        "gpuAmount": 1,
        "memorySize": "4096",
        "gpuMemorySize": 4096,
        "gpuMachineNum": 1
      }
    ],
    "tags": [
      {
        "tagKey": "[\\\"COST\\\"]",
        "tagValue": "3d775731-9ec1-4fe2-a00d-061d51fce677"
      }
    ],
    "resourceGroupId": "rg-aek4f7uj74wdthi",
    "resourceOwnerId": "13*************",
    "gpuSpec": [
      "ecs.gn6e-c12g1.3xlarge"
    ],
    "ipWhiteList": [
      "10.0.0.1"
    ]
  },
  "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.