CreateWorkgroup - Server Migration Center - Alibaba Cloud Documentation Center

Operation description

Each Alibaba Cloud account can have up to 50 workgroups.
A single workgroup can be associated with up to 50 migration sources.
A migration source can be associated with only one workgroup.

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

smc:CreateWorkgroup

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	A token to ensure the idempotence of the request. Generate a value from your client that contains up to 64 ASCII characters. This ensures that retried requests are idempotent. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-426655440000
Name	string	No	The name of the workgroup. The name must meet the following requirements: The workgroup name must be unique. The name must be 2 to 64 characters in length. It must start with a letter or a Chinese character. It cannot start with `http://` or `https://`. It can contain digits, colons (:), periods (.), underscores (_), and hyphens (-).	testWorkgroupName
Description	string	No	The description of the workgroup. It must be 2 to 256 characters in length and cannot start with `http://` or `https://`.	test
Tag	array<object>	No	An array of tags. The array can contain 1 to 20 tags. If the array contains multiple tags, the value of `Key` for each tag must be unique.
	object	No	A tag object.
Key	string	No	The tag key. It can be up to 128 characters in length and cannot be an empty string. The key cannot start with `aliyun` or `acs:`, and cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value. It can be up to 128 characters in length and can be an empty string. The value cannot contain `http://` or `https://`.	TestValue

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	C8B26B44-0189-443E-9816-D951F59623A9
WorkgroupId	string	The ID of the workgroup.	w-***

Examples

Success response

JSON format

{
  "RequestId": "C8B26B44-0189-443E-9816-D951F59623A9",
  "WorkgroupId": "w-***"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An 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.
403	Forbidden.Unauthorized	A required authorization for the specified action is not supplied.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.