Use DescribeGroupStruct to query server group structure - Security Center - Alibaba Cloud - Security Center

Retrieves the group structure.

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

yundun-sas:DescribeGroupStruct

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.	9FBC6E47-7508-58C9-9E76-528E118C****
GroupId	integer	The ID of the asset group.	958****
GroupName	string	The name of the server group.	TestGroupName
MachineNum	integer	The number of servers.	30
GroupIndex	integer	The sort order number.	1
GroupFather	integer	The parent node of the group.	958****
GroupLevel	integer	The level of the application group.	2
GroupFlag	integer	The type of the server group. Valid values: 0: default group 1: other group.	0
Groups	array	The collection of child groups.
	string	The fields are the same as those of the parent level.	[ { "groupName": "testfuxian", "groupFather": 0, "groupId": 11501234, "childGroups": [], "groupLevel": 1, "groupIndex": 100, "groupFlag": 1 }, { "groupName": "testfuxian", "groupFather": 0, "groupId": 11501234, "childGroups": [], "groupLevel": 1, "groupIndex": 100, "groupFlag": 1 } ]

Examples

Success response

JSON format

{
  "RequestId": "9FBC6E47-7508-58C9-9E76-528E118C****",
  "GroupId": 0,
  "GroupName": "TestGroupName",
  "MachineNum": 30,
  "GroupIndex": 1,
  "GroupFather": 0,
  "GroupLevel": 2,
  "GroupFlag": 0,
  "Groups": [
    "[\n\t{\n\t\t\"groupName\": \"testfuxian\",\n\t\t\"groupFather\": 0,\n\t\t\"groupId\": 11501234,\n\t\t\"childGroups\": [],\n\t\t\"groupLevel\": 1,\n\t\t\"groupIndex\": 100,\n\t\t\"groupFlag\": 1\n\t},\n\t{\n\t\t\"groupName\": \"testfuxian\",\n\t\t\"groupFather\": 0,\n\t\t\"groupId\": 11501234,\n\t\t\"childGroups\": [],\n\t\t\"groupLevel\": 1,\n\t\t\"groupIndex\": 100,\n\t\t\"groupFlag\": 1\n\t}\n]"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.