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

Consulta uma lista de workspaces.

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

list

*Todos os recursos.

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/workspaces HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
nextToken	string	Não	O token de paginação que especifica a posição inicial para a operação de leitura atual.	1
maxResults	integer	Não	O número máximo de resultados a serem retornados em uma única solicitação.	20
name	string	Não	O nome do workspace. A pesquisa aproximada é suportada.	test_workspace
state	string	Não	O estado do workspace. Valores válidos: Starting: O workspace está iniciando. Running: O workspace está em execução. Stopping: O workspace está parando. Stopped: O workspace está parado. Error: O workspace falhou.	running
regionId	string	Não	O ID da região.	cn-hangzhou
tag	array<object>	Não	A lista de tags usada para filtrar workspaces.
	object	Não	A tag usada para filtrar workspaces.
key	string	Não	A chave da tag.	cn-shenzhen-finance.edas.config.server
value	string	Não	O valor da tag.	iPhone disk space remaining rate
resourceGroupId	string	Não	O ID do grupo de recursos.	rg-aek2thxggoqhmhq

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os dados da resposta.
workspaces	array<object>	A lista de workspaces.
	array<object>	Os detalhes do workspace.
workspaceId	string	O ID do workspace.	w-******
workspaceName	string	O nome do workspace.	spark-batch-job-workspace-1
resourceSpec	string	A especificação do recurso.	100cu
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 do período de assinatura. Este parâmetro é obrigatório para o método de cobrança por assinatura.	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
duration	integer	A duração do período de assinatura. Este parâmetro é obrigatório para o método de cobrança por assinatura.	1
autoRenew	boolean	Especifica se a renovação automática deve ser ativada. Este parâmetro é obrigatório para o método de cobrança por assinatura.	true
autoRenewPeriod	integer	A duração da renovação automática. Este parâmetro é obrigatório para o método de cobrança por assinatura.	1
autoRenewPeriodUnit	string	O ciclo de renovação automática. Este parâmetro é obrigatório para o método de cobrança por assinatura.	YEAR, MONTH, WEEK, DAY, HOUR, MINUTE
workspaceStatus	string	O status do workspace.	STARTING,RUNNING,TERMINATED
failReason	string	A causa da falha.	out of stock
paymentStatus	string	O status do pagamento.	PAID/UNPAID
regionId	string	O ID da região.	cn-shanghai
createTime	integer	A hora em que o workspace foi criado. O valor é um carimbo de data/hora UNIX em milissegundos.	1684115879955
endTime	integer	A hora em que o workspace foi liberado. O valor é um carimbo de data/hora UNIX em milissegundos.	1687103999999
stateChangeReason	object	As informações sobre a alteração de status do workspace.
code	string	O código de erro.	0
message	string	A mensagem de erro.	Success
releaseType	string	O motivo pelo qual o workspace foi liberado.	SERVICE_RELEASE
dlfType	string	O tipo do DLF associado.	1.0
prePaidQuota	object	As informações sobre a cota de recursos por assinatura.
usedResource	string	A quantidade de recursos atualmente utilizados.	{\"cpu\":\"0\",\"memory\":\"0Gi\",\"cu\":\"0\"}
maxResource	string	A quantidade máxima de recursos que podem ser utilizados.	{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
allocatedResource	string	A quantidade de recursos atualmente alocados.	{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}
createTime	integer	A hora em que a cota de recursos foi criada. O valor é um carimbo de data/hora UNIX em milissegundos.	1745683200000
expireTime	integer	A hora em que a cota de recursos expira. O valor é um carimbo de data/hora UNIX em milissegundos.	1740537153000
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 para de funcionar após a expiração.	true
paymentStatus	string	O status de pagamento do recurso atual. Valores válidos:\n- NORMAL: Válido.\n- WAIT_FOR_EXPIRE: Expirando.\n- EXPIRED: Expirado.	NORMAL
instanceId	string	O ID da instância do recurso associado à cota.	i-abc12345
orderId	string	O ID do pedido.	23464687565
prePaidQuotaGpu	array<object>	A lista de cotas de assinatura de GPU.
	object	A cota de assinatura de GPU.
orderId	string	O ID do pedido.	2534863936
instanceId	string	O ID da instância.	w-xxxxxxxxx-gpu-quota-xxxx
createTime	integer	A hora em que a cota de assinatura de GPU foi criada. O valor é um carimbo de data/hora UNIX em milissegundos.	1782292672000
expireTime	integer	A hora em que a cota de assinatura de GPU expira. O valor é um carimbo de data/hora UNIX em milissegundos.	1782292772000
autoRenewal	boolean	Especifica se a renovação automática está ativada.	true
paymentStatus	string	O status do pedido.	NORMAL
gpuSpec	string	O tipo de instância de GPU.	ecs.gn7i-c8g1.2xlarge
gpuNum	integer	O número de GPUs.	8
gpuMachineNum	integer	O número de máquinas GPU.	4
instanceTypeId	string	O ID do tipo de instância.	ecs.g5.small
instanceTypeFamily	string	A família da instância.	ecs.g5
cpuCoreCount	string	O número de núcleos de CPU.	1
gpuAmount	integer	O número de GPUs.	0
memorySize	string	O tamanho da memória.	4096
gpuMemorySize	integer	O tamanho da memória da GPU.	0
tags	array<object>	A lista de tags do workspace.
	object	A tag do workspace.
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-xxxxxxxxxx
gpuSpec	array	A lista de tipos de instância de GPU.
	string	O tipo de instância de GPU.	ecs.gn7i-c8g1.2xlarge
ipWhiteList	array	A lista de permissões de IP do workspace.
	string	A lista de permissões de IP do workspace.	0.0.0.1
requestId	string	O ID da solicitação.	DD6B1B2A-5837-5237-ABE4-FF0C8944****
nextToken	string	O próximo token.	1
maxResults	integer	O número máximo de resultados a serem retornados em uma única solicitação.	20
totalCount	integer	O número total de registros.	200

Exemplos

Resposta de sucesso

JSON formato

{
  "workspaces": [
    {
      "workspaceId": "w-******",
      "workspaceName": "spark-batch-job-workspace-1",
      "resourceSpec": "100cu",
      "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-shanghai",
      "createTime": 1684115879955,
      "endTime": 1687103999999,
      "stateChangeReason": {
        "code": "0",
        "message": "Success"
      },
      "releaseType": "SERVICE_RELEASE",
      "dlfType": "1.0",
      "prePaidQuota": {
        "usedResource": "{\\\"cpu\\\":\\\"0\\\",\\\"memory\\\":\\\"0Gi\\\",\\\"cu\\\":\\\"0\\\"}",
        "maxResource": "{\\\"cpu\\\":\\\"1\\\",\\\"memory\\\":\\\"4Gi\\\",\\\"cu\\\":\\\"1\\\"}",
        "allocatedResource": "{\\\"cpu\\\":\\\"1\\\",\\\"memory\\\":\\\"4Gi\\\",\\\"cu\\\":\\\"1\\\"}",
        "createTime": 1745683200000,
        "expireTime": 1740537153000,
        "autoRenewal": true,
        "paymentStatus": "NORMAL",
        "instanceId": "i-abc12345",
        "orderId": "23464687565"
      },
      "prePaidQuotaGpu": [
        {
          "orderId": "2534863936",
          "instanceId": "w-xxxxxxxxx-gpu-quota-xxxx",
          "createTime": 1782292672000,
          "expireTime": 1782292772000,
          "autoRenewal": true,
          "paymentStatus": "NORMAL",
          "gpuSpec": "ecs.gn7i-c8g1.2xlarge",
          "gpuNum": 8,
          "gpuMachineNum": 4,
          "instanceTypeId": "ecs.g5.small",
          "instanceTypeFamily": "ecs.g5",
          "cpuCoreCount": "1",
          "gpuAmount": 0,
          "memorySize": "4096",
          "gpuMemorySize": 0
        }
      ],
      "tags": [
        {
          "tagKey": "[\\\"COST\\\"]",
          "tagValue": "3d775731-9ec1-4fe2-a00d-061d51fce677"
        }
      ],
      "resourceGroupId": "rg-xxxxxxxxxx",
      "gpuSpec": [
        "ecs.gn7i-c8g1.2xlarge"
      ],
      "ipWhiteList": [
        "0.0.0.1"
      ]
    }
  ],
  "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.