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

Consulta los detalles de un espacio 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

dms:GetWorkspace

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

POST  HTTP/1.1

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	integer	Sí	El ID del espacio de trabajo de DMS.	12****

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
RequestId	string	El ID de la solicitud. Puede utilizar el ID de la solicitud para localizar registros y solucionar problemas.	FE8EE2F1-4880-46BC-A704-5CF63EAF****
Message	string	El mensaje de error que se devuelve si la solicitud falla.	UnknownError
Data	object	Los datos devueltos.
WorkspaceId	integer	El ID del espacio de trabajo.	863020290155****
WorkspaceName	string	El nombre del espacio de trabajo.	workspace_xxx
Description	string	La descripción del espacio de trabajo.	Test
RegionId	string	El ID de la región a la que pertenece el espacio de trabajo.	cn-hangzhou
OwnerId	string	El ID del propietario.	12345****
ServiceAccountId	string	El ID de la cuenta de servicio.	12345****
Tid	integer	El ID del inquilino. Nota Para ver el ID del inquilino, vaya a la consola de Data Management (DMS) y pase el puntero sobre la foto de perfil en la esquina superior derecha. Para obtener más información, consulte la sección Ver información sobre el inquilino actual del tema "Gestionar inquilinos de DMS".	3322****
VpcId	string	El ID de la VPC.	vpc-xxxx
Success	boolean	Indica si la solicitud se realizó correctamente. Valores válidos: true: La solicitud se realizó correctamente. false: La solicitud falló.	true

Ejemplos

Respuesta exitosa

JSON Formato

{
  "RequestId": "FE8EE2F1-4880-46BC-A704-5CF63EAF****",
  "Message": "UnknownError",
  "Data": {
    "WorkspaceId": 0,
    "WorkspaceName": "workspace_xxx",
    "Description": "Test",
    "RegionId": "cn-hangzhou",
    "OwnerId": "12345****",
    "ServiceAccountId": "12345****",
    "Tid": 0,
    "VpcId": "vpc-xxxx"
  },
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
404	WorkspaceNotExist	The specified workspace not exist.	The workspace does not exist.

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.