DocsICP FilingConsole
Documentation

UpdateDataAgentSpaceInfo

Updated at:
Copy as MD
Product
My Favorites

Updates workspace information.

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:UpdateDataAgentSpaceInfo

update

*All Resource

*

 None 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 workspace.

20923*****7291
WorkspaceName

string

No

The new name for the workspace.

yunqitest_v2
WorkspaceDesc

string

No

The new description for the workspace.

space for test new
IsSessionShareEnabled

boolean

No

Specifies whether to enable session sharing for the workspace. Valid values: true and false.

Valid values:

  • false :

true

Response elements

Element

Type

Description

Example

object

The returned data.

RequestId

string

The request ID.

67E910F2-***-695C
Success

string

Indicates whether the request was successful.

true
ErrorCode

string

The error code returned if the request fails.

DMS-DA-40114
ErrorMessage

string

The error message returned if the request fails.

Specified parameter is not valid.
Data

object

The returned data.

WorkspaceId

string

The ID of the workspace.

20923*****7291
WorkspaceName

string

The updated name of the workspace.

yunqitest_v2
WorkspaceStatus

string

The updated status of the workspace.

space for test new
Creator

string

The user ID (UID) of the workspace creator.

20282*****7591
RoleName

string

The user role in the workspace.

active
CreateTime

string

The time when the workspace was created, specified as a UNIX timestamp in seconds.

1765960516
ModifyTime

string

The time when the workspace was last modified, specified as a UNIX timestamp in seconds.

1765962516
Description

string

The description of the workspace.

space for test new
TotalMember

string

The total number of members in the workspace.

20
IsSessionShareEnabled

boolean

Indicates whether session sharing is enabled in the workspace.

Valid values:

  • true :

  • false :

true

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-***-695C",
  "Success": "true",
  "ErrorCode": "DMS-DA-40114",
  "ErrorMessage": "Specified parameter is not valid.",
  "Data": {
    "WorkspaceId": "20923*****7291",
    "WorkspaceName": "yunqitest_v2",
    "WorkspaceStatus": "space for test new",
    "Creator": "20282*****7591",
    "RoleName": "active",
    "CreateTime": "1765960516",
    "ModifyTime": "1765962516",
    "Description": "space for test new",
    "TotalMember": "20",
    "IsSessionShareEnabled": true
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.