All Products
Search
Document Center

Server Migration Center:ModifyWorkgroupAttribute

Last Updated:Feb 17, 2025

Modifies the name and description of a workgroup.

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
smc:ModifyWorkgroupAttributeupdate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
WorkgroupIdstringYes

The workgroup ID.

w-***
NamestringNo

The new name of the workgroup. The name must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

testMigrationTaskName
DescriptionstringNo

The new description of the workgroup.

The description must be 2 to 128 characters in length. It must start with a letter but cannot start with http:// or https://. It can contain letters, digits, colons (:), underscores (_), and hyphens (-).

test

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

3E8B9ABB-289A-44E6-942D-8AA9E493****

Examples

Sample success responses

JSONformat

{
  "RequestId": "3E8B9ABB-289A-44E6-942D-8AA9E493****"
}

Error codes

HTTP status codeError codeError messageDescription
403Forbidden.UnauthorizedA required authorization for the specified action is not supplied.-
500InternalErrorAn error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.An error occurred while processing your request. Please try again. If the problem still exists, please submit a ticket.

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