Todos los productos
Search
Centro de documentos

E-MapReduce:ListWorkspaces

Última actualización: Oct 28, 2026

Consulta una lista de espacios de trabajo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

  • Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.

  • API: La API que debe invocarse para llevar a cabo la acción.

  • Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.

  • Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.

    • En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.

    • Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.

  • Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.

  • Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

emr-serverless-spark:ListWorkspaces

list

*Todos los recursos.

*

Ninguna Ninguna

Sintaxis de la solicitud

GET /api/v1/workspaces HTTP/1.1

Parámetros de la solicitud

Parámetro

Tipo

Obligatorio

Descripción

Ejemplo

nextToken

string

No

El token de paginación que especifica la posición inicial para la operación de lectura actual.

1

maxResults

integer

No

El número máximo de resultados que se devuelven en una sola solicitud.

20

name

string

No

El nombre del espacio de trabajo. Se admite la búsqueda aproximada.

test_workspace

state

string

No

El estado del espacio de trabajo. Valores válidos:

  • Starting: El espacio de trabajo se está iniciando.

  • Running: El espacio de trabajo está en ejecución.

  • Stopping: El espacio de trabajo se está deteniendo.

  • Stopped: El espacio de trabajo está detenido.

  • Error: El espacio de trabajo ha fallado.

running

regionId

string

No

El ID de la región.

cn-hangzhou

tag

array<object>

No

La lista de etiquetas que se utilizan para filtrar espacios de trabajo.

object

No

La etiqueta que se utiliza para filtrar espacios de trabajo.

key

string

No

La clave de la etiqueta.

cn-shenzhen-finance.edas.config.server

value

string

No

El valor de la etiqueta.

iPhone disk space remaining rate

resourceGroupId

string

No

El ID del grupo de recursos.

rg-aek2thxggoqhmhq

Elementos de la respuesta

Elemento

Tipo

Descripción

Ejemplo

object

Los datos de respuesta.

workspaces

array<object>

La lista de espacios de trabajo.

array<object>

Los detalles del espacio de trabajo.

workspaceId

string

El ID del espacio de trabajo.

w-******

workspaceName

string

El nombre del espacio de trabajo.

spark-batch-job-workspace-1

resourceSpec

string

La especificación de recursos.

100cu

storage

string

La ruta de OSS.

spark-result

dlfCatalogId

string

La información del catálogo de DLF.

default

paymentType

string

El método de facturación.

PayAsYouGo or Subscription

paymentDurationUnit

string

La unidad del período de suscripción. Este parámetro es obligatorio para el método de facturación por suscripción.

YEAR, MONTH, WEEK, DAY, HOUR, MINUTE

duration

integer

La duración del período de suscripción. Este parámetro es obligatorio para el método de facturación por suscripción.

1

autoRenew

boolean

Especifica si se debe habilitar la renovación automática. Este parámetro es obligatorio para el método de facturación por suscripción.

true

autoRenewPeriod

integer

La duración de la renovación automática. Este parámetro es obligatorio para el método de facturación por suscripción.

1

autoRenewPeriodUnit

string

El ciclo de renovación automática. Este parámetro es obligatorio para el método de facturación por suscripción.

YEAR, MONTH, WEEK, DAY, HOUR, MINUTE

workspaceStatus

string

El estado del espacio de trabajo.

STARTING,RUNNING,TERMINATED

failReason

string

La causa de la falla.

out of stock

paymentStatus

string

El estado de pago.

PAID/UNPAID

regionId

string

El ID de la región.

cn-shanghai

createTime

integer

La hora en que se creó el espacio de trabajo. El valor es una marca de tiempo UNIX en milisegundos.

1684115879955

endTime

integer

La hora en que se liberó el espacio de trabajo. El valor es una marca de tiempo UNIX en milisegundos.

1687103999999

stateChangeReason

object

La información sobre el cambio de estado del espacio de trabajo.

code

string

El código de error.

0

message

string

El mensaje de error.

Success

releaseType

string

El motivo por el que se liberó el espacio de trabajo.

SERVICE_RELEASE

dlfType

string

El tipo de DLF asociado.

1.0

prePaidQuota

object

La información sobre la cuota de recursos de suscripción.

usedResource

string

La cantidad de recursos utilizados actualmente.

{\"cpu\":\"0\",\"memory\":\"0Gi\",\"cu\":\"0\"}

maxResource

string

La cantidad máxima de recursos que se pueden utilizar.

{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}

allocatedResource

string

La cantidad de recursos asignados actualmente.

{\"cpu\":\"1\",\"memory\":\"4Gi\",\"cu\":\"1\"}

createTime

integer

La hora en que se creó la cuota de recursos. El valor es una marca de tiempo UNIX en milisegundos.

1745683200000

expireTime

integer

La hora en que vence la cuota de recursos. El valor es una marca de tiempo UNIX en milisegundos.

1740537153000

autoRenewal

boolean

Especifica si la renovación automática está habilitada para el recurso. Valores válidos:

  • true: La renovación automática está habilitada. El recurso se renueva automáticamente al vencer.

  • false: La renovación automática está deshabilitada. El recurso deja de funcionar al vencer.

true

paymentStatus

string

El estado de pago del recurso actual. Valores válidos:

  • NORMAL: Válido.

  • WAIT_FOR_EXPIRE: Por vencer.

  • EXPIRED: Vencido.

NORMAL

instanceId

string

El ID de instancia del recurso asociado a la cuota.

i-abc12345

orderId

string

El ID del pedido.

23464687565

prePaidQuotaGpu

array<object>

La lista de cuotas de suscripción de GPU.

object

La cuota de suscripción de GPU.

orderId

string

El ID del pedido.

2534863936

instanceId

string

El ID de la instancia.

w-xxxxxxxxx-gpu-quota-xxxx

createTime

integer

La hora en que se creó la cuota de suscripción de GPU. El valor es una marca de tiempo UNIX en milisegundos.

1782292672000

expireTime

integer

La hora en que vence la cuota de suscripción de GPU. El valor es una marca de tiempo UNIX en milisegundos.

1782292772000

autoRenewal

boolean

Especifica si la renovación automática está habilitada.

true

paymentStatus

string

El estado del pedido.

NORMAL

gpuSpec

string

El tipo de instancia de GPU.

ecs.gn7i-c8g1.2xlarge

gpuNum

integer

La cantidad de GPU.

8

gpuMachineNum

integer

La cantidad de máquinas GPU.

4

instanceTypeId

string

El ID del tipo de instancia.

ecs.g5.small

instanceTypeFamily

string

La familia de instancias.

ecs.g5

cpuCoreCount

string

La cantidad de núcleos de CPU.

1

gpuAmount

integer

La cantidad de GPU.

0

memorySize

string

El tamaño de la memoria.

4096

gpuMemorySize

integer

El tamaño de la memoria GPU.

0

tags

array<object>

La lista de etiquetas del espacio de trabajo.

object

La etiqueta del espacio de trabajo.

tagKey

string

La clave de la etiqueta.

[\"COST\"]

tagValue

string

El valor de la etiqueta.

3d775731-9ec1-4fe2-a00d-061d51fce677

resourceGroupId

string

El ID del grupo de recursos.

rg-xxxxxxxxxx

gpuSpec

array

La lista de tipos de instancia de GPU.

string

El tipo de instancia de GPU.

ecs.gn7i-c8g1.2xlarge

ipWhiteList

array

La lista blanca de IP del espacio de trabajo.

string

La lista blanca de IP del espacio de trabajo.

0.0.0.1

requestId

string

El ID de la solicitud.

DD6B1B2A-5837-5237-ABE4-FF0C8944****

nextToken

string

El token siguiente.

1

maxResults

integer

El número máximo de resultados que se devuelven en una sola solicitud.

20

totalCount

integer

El número total de registros.

200

Ejemplos

Respuesta exitosa

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 error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.