GetDataAgentWorkspaceInfo-阿里云帮助中心

Retrieves the details of a collaborative workspace.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dms:GetDataAgentWorkspaceInfo

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
DMSUnit	string	No	The current DMS unit.	cn-hangzhou
WorkspaceId	string	No	The ID of the collaborative workspace.	20923*****7291

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	E0D2-*****-A63B6
Success	boolean	Indicates whether the request is successful.	true
ErrorCode	string	The error code.	DMS-DA-40114
ErrorMessage	string	The error message.	Specified parameter is not valid.
Data	object	The response struct.
WorkspaceId	string	The ID of the collaborative workspace.	20923*****7291
WorkspaceName	string	The name of the workspace.	workspaceTest
WorkspaceStatus	string	The status of the workspace.	active
Creator	string	The UID of the workspace creator.	20282*****7591
RoleName	string	The role name of the user in the workspace.	admin
CreateTime	string	The creation time of the session. Unit: seconds. The value is a UNIX timestamp.	1765960516
ModifyTime	string	The most recent modification time of the workspace. Unit: seconds. The value is a UNIX timestamp.	1765961516
WorkspaceDesc	string	The description of the collaborative workspace.	space for test
TotalMember	string	The number of members in the workspace.	11
IsSessionShareEnabled	boolean
Type	string

Examples

Success response

JSON format

{
  "RequestId": "E0D2-*****-A63B6",
  "Success": true,
  "ErrorCode": "DMS-DA-40114",
  "ErrorMessage": "Specified parameter is not valid.",
  "Data": {
    "WorkspaceId": "20923*****7291",
    "WorkspaceName": "workspaceTest",
    "WorkspaceStatus": "active",
    "Creator": "20282*****7591",
    "RoleName": "admin",
    "CreateTime": "1765960516",
    "ModifyTime": "1765961516",
    "WorkspaceDesc": "space for test",
    "TotalMember": "11",
    "IsSessionShareEnabled": false
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.