ListWorkspaces - Data Management - Centro de documentación de Alibaba Cloud

Consulta una lista de espacios de trabajo del inquilino.

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

dms:ListWorkspaces

list

*All Resource

*

Ninguna

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
AlreadyJoined	boolean	No	Especifica si el usuario actual se ha unido al espacio de trabajo.	true
SearchKey	string	No	La palabra clave de búsqueda. Se admite la coincidencia aproximada.	poc_test
Region	string	No	La región en la que se encuentra el bucket.	cn-hangzhou
ServiceAccountId	integer	No	El ID de la cuenta de servicio.	12345
WorkspaceId	integer	No	El ID del espacio de trabajo.	12****
PageNumber	integer	No	El número de página.	1
PageSize	integer	No	El número de entradas por página.	10
VpcId	string	No	El ID de la nube privada virtual (VPC). Nota Este parámetro no se puede utilizar como filtro.	vpc-bp10wnlcmor****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object
RequestId	string	El ID de la solicitud.	EE214ECD-4330-503A-82F0-FFB03975****
ErrorCode	string	El código de error.	UserNotExist
ErrorMessage	string	El mensaje de error que se devuelve si la solicitud falló.	UnknownError
Success	boolean	Indica si la llamada fue exitosa. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true
TotalCount	integer	El número total de espacios de trabajo que cumplen las condiciones.	10
Data	object
BaseWorkspaces	array<object>	El conjunto de datos.
	object
Description	string	La descripción del espacio de trabajo.	Test
CreatorId	integer	El ID del creador.	123
OwnerUid	string	El UID de Alibaba Cloud del propietario.	15608564799****
WorkspaceId	integer	El ID del espacio de trabajo.	8652340494****
GmtModified	string	La hora de actualización.	2025-01-01 00:00:00
ServiceAccountId	integer	El ID de la cuenta de servicio.	12345
CreatorUid	string	El UID de la cuenta de Alibaba Cloud del creador.	1344****
ServiceAccountNickName	string	El apodo de la cuenta de servicio.	testname
Name	string	El nombre del espacio de trabajo.	workspace-xxxx
AlreadyJoined	boolean	Indica si el usuario actual se ha unido al espacio de trabajo.	true
TenantId	integer	El ID del inquilino al que pertenece el espacio de trabajo.	23456
GmtCreate	string	La hora de creación.	2025-01-01 00:00:00
ServiceAccountUid	string	El UID de la cuenta de Alibaba Cloud de la cuenta de servicio.	1422****
OwnerId	integer	El ID del propietario.	123****
VpcId	string	El ID de la VPC.	vpc-25fl3qjqb****
Region	string	El ID de la región.	cn-hangzhou
WorkspaceName	string	El nombre del espacio de trabajo.	test-workspace
CreatorNickName	string	El apodo del creador.	work*****
OwnerNickName	string	El apodo del propietario.	hel****
NextToken	string	NextToken no surte efecto.	token-xxx
MaxResults	integer	El número total de espacios de trabajo que cumplen la condición, que es igual al parámetro TotalCount.	10

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "EE214ECD-4330-503A-82F0-FFB03975****",
  "ErrorCode": "UserNotExist",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "TotalCount": 10,
  "Data": {
    "BaseWorkspaces": [
      {
        "Description": "Test",
        "CreatorId": 123,
        "OwnerUid": "15608564799****",
        "WorkspaceId": 0,
        "GmtModified": "2025-01-01 00:00:00",
        "ServiceAccountId": 12345,
        "CreatorUid": "1344****",
        "ServiceAccountNickName": "testname",
        "Name": "workspace-xxxx",
        "AlreadyJoined": true,
        "TenantId": 23456,
        "GmtCreate": "2025-01-01 00:00:00",
        "ServiceAccountUid": "1422****",
        "OwnerId": 0,
        "VpcId": "vpc-25fl3qjqb****",
        "Region": "cn-hangzhou",
        "WorkspaceName": "test-workspace",
        "CreatorNickName": "work*****",
        "OwnerNickName": "hel****"
      }
    ]
  },
  "NextToken": "token-xxx",
  "MaxResults": 10
}

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.