All Products
Search
Document Center

Data Management:GetWorkspace

Last Updated:Jan 13, 2026

Queries the details of a workspace.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • For mandatory resource types, indicate with a prefix of * .
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:GetWorkspaceget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WorkspaceIdlongYes

The ID of the DMS workspace.

12****

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID. You can use the request ID to locate logs and troubleshoot issues.

FE8EE2F1-4880-46BC-A704-5CF63EAF****
Messagestring

The error message that is returned if the request failed.

UnknownError
Dataobject

The data returned.

WorkspaceIdlong

The workspace ID.

863020290155****
WorkspaceNamestring

The name of the workspace.

workspace_xxx
Descriptionstring

The description of the workspace.

Test
RegionIdstring

The ID of the region to which the workspace belongs.

cn-hangzhou
OwnerIdstring

The owner ID.

12345****
ServiceAccountIdstring

The ID of the service account.

12345****
Tidlong

The ID of the tenant.

Note To view the tenant ID, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.
3322****
VpcIdstring

The VPC ID.

vpc-xxxx
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true

Examples

Sample success responses

JSONformat

{
  "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
}

Error codes

HTTP status codeError codeError messageDescription
404WorkspaceNotExistThe specified workspace not exist.The workspace does not exist.

For a list of error codes, visit the Service error codes.