DescribeWorkgroups - Server Migration Center - Alibaba Cloud Documentation Center

After a workgroup is created, you can view its information, such as the workgroup name, description, and alert 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

smc:DescribeWorkgroups

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
WorkgroupId	array	No	A list of workgroup IDs. You can specify up to 50 workgroup IDs.
	string	No	The workgroup ID.	w-***
Name	string	No	The name of the workgroup.	test
Status	string	No	The status of the workgroup. Valid values: NotStarted: The workgroup is not started. InProgress: The workgroup is in progress. Cutover: The workgroup is being cut over. Completed: The workgroup is completed.	InProgress
PageNumber	integer	No	The page number of the workgroup list. The value starts from 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page for a paged query. Maximum value: 50. Default value: 10.	10
Tag	array<object>	No	The array of tags. The array can contain 1 to 20 tags. If the array contains multiple tag objects, the tag keys cannot be the same.
	object	No	The tag object.
Key	string	No	The tag key of the workgroup. The key can be up to 128 characters in length. If you specify this parameter, the value 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 of the workgroup. The value can be up to 128 characters in length. If you specify this parameter, the value can be an empty string. The value cannot contain `http://` or `https://`.	TestValue

Response elements

Element	Type	Description	Example
	object	The returned parameters.
RequestId	string	The request ID.	2D69A58F-345C-4FDE-88E4-BF518948****
TotalCount	integer	The total number of workgroups.	1
PageSize	integer	The number of entries returned on each page. Maximum value: 50. Default value: 10.	10
PageNumber	integer	The page number of the workgroup list.	1
Workgroups	object
Workgroup	array<object>	The details of the workgroups.
	object	The workgroup object.
WorkgroupId	string	The workgroup ID.	w-***
Name	string	The name of the workgroup.	testWorkgroupName
Description	string	The description of the workgroup.	test
Status	string	The status of the workgroup. Possible values: NotStarted: The workgroup is not started. InProgress: The workgroup is in progress. Cutover: The workgroup is being cut over. Completed: The workgroup is completed.	InProgress
Warnings	object
Warning	array<object>	A list of alert information for the workgroup. The list may contain multiple types of alerts.
	object	The alert information.
WarningType	string	The alert type. Possible values: InError: One or more migration tasks have failed. UnRelated: One or more migration sources are not associated with migration tasks. NotPassed: One or more migration task drills have failed.	InError
SourceIds	object
SourceId	array	A list of migration sources that have issues.
	string	The ID of the migration source that has an issue.	s-bp1h7ymebl7swbt4****
Tags	object
Tag	array<object>	The tag information of the workgroup.
	object	The tag information of the workgroup.
Key	string	The tag key of the workgroup.	TestKey
Value	string	The tag value of the workgroup.	TestValue

Examples

Success response

JSON format

{
  "RequestId": "2D69A58F-345C-4FDE-88E4-BF518948****",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "Workgroups": {
    "Workgroup": [
      {
        "WorkgroupId": "w-***",
        "Name": "testWorkgroupName",
        "Description": "test",
        "Status": "InProgress",
        "Warnings": {
          "Warning": [
            {
              "WarningType": "InError",
              "SourceIds": {
                "SourceId": [
                  "s-bp1h7ymebl7swbt4****"
                ]
              }
            }
          ]
        },
        "Tags": {
          "Tag": [
            {
              "Key": "\t\nTestKey",
              "Value": "TestValue"
            }
          ]
        }
      }
    ]
  }
}

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.