DescribeGroupedInstances - Security Center - Alibaba Cloud Documentation Center

Queries the statistical information about assets based on a specified filter condition.

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.

Debug

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:
- The required resource types are displayed in bold characters.
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeGroupedInstances	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
MachineTypes	string	No	The type of the assets that you want to query. Set the value to ecs, which indicates Elastic Compute Service (ECS) instances.	ecs
GroupField	string	Yes	The filter condition that you want to use to query the assets. Valid values: groupId: the group to which the assets belong regionId: the region in which the assets reside vpcInstanceId: the virtual private cloud (VPC) in which the assets reside	groupId
FieldValue	string	No	The name of the group to which the assets belong. Fuzzy search is supported.	test-01
NoPage	boolean	No	Specifies whether to enable paged query. Default value: true. Valid values: true: yes false: no	true
PageSize	integer	No	The number of entries to return on each page. Default value: 20.	20
CurrentPage	integer	No	The number of the page to return. Default value: 1.	1
Vendor	integer	No	The source of the server. Valid values: 0: an asset provided by Alibaba Cloud. 1: a third-party cloud server 2: a server in a data center 3, 4, 5, and 7: other cloud asset 8: a lightweight asset	0
Vendors	string	No	The source of the server. Separate multiple sources with commas (,).Valid values: 0: an asset provided by Alibaba Cloud. 1: a third-party cloud server 2: a server in a data center 3, 4, 5, and 7: other cloud asset 8: a lightweight asset	0,8
SaleVersionCheckCode	string	No	The edition of Security Center that protects the asset. Valid values: sas_gte_advanced: the Advanced edition or higher sas_gte_enterprise: the Enterprise edition or higher sas_gt_basic: a paid edition sas_eq_advanced: the Advanced edition sas_gt_anti_virus: an edition higher than the Anti-virus edition	sas_gt_basic

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	52A3AEE6-114A-499D-8990-4BA9B27FE0AA
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	5
PageSize	integer	The number of entries returned per page. Default value: 20.	20
TotalCount	integer	The total number of entries returned.	100
Count	integer	The number of entries returned on the current page.	20
Instances	array<object>	The information about the assets.
Instance	object	The information about the asset.
AsapVulInstanceCount	long	The number of assets on which high-risk vulnerabilities are detected.	11
UnProtectedInstanceCount	string	The number of assets that are not protected by Security Center.	32
FieldAliasName	string	The name of the server group.	testA
InstanceCount	string	The total number of assets that belong to the specified type. Note If the MachineTypes request parameter is not specified, the value of the InstanceCount parameter is the total number of your assets.	205
RiskInstanceCount	string	The number of assets that are at risk.	172
GroupFlag	integer	The type of the server group. Valid values: 0: the default group 1: other group	1
AuthVersionCheckCount	integer	The number of assets that are protected by the specified edition.	205
Os	string	The operating system type of the asset. Valid values: windows linux Note This parameter is returned only when Lang is set to zh.	windows
InstanceCoreCount	long	The number of cores of assets in the specified asset type. Note If the MachineTypes request parameter is not specified, the value of the InstanceCoreCount parameter indicates the total number of cores of assets within your account.	610

Examples

Sample success responses

JSONformat

{
  "RequestId": "52A3AEE6-114A-499D-8990-4BA9B27FE0AA",
  "PageInfo": {
    "CurrentPage": 5,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": 20
  },
  "Instances": [
    {
      "AsapVulInstanceCount": 11,
      "UnProtectedInstanceCount": "32",
      "FieldAliasName": "testA",
      "InstanceCount": "205",
      "RiskInstanceCount": "172",
      "GroupFlag": 1,
      "AuthVersionCheckCount": 205,
      "Os": "windows",
      "InstanceCoreCount": 610
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	no permission	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2024-06-07	The Error code has changed. The response structure of the API has changed	View Change Details
2023-07-06	The Error code has changed. The response structure of the API has changed	View Change Details
2023-04-07	The Error code has changed. The request parameters of the API has changed. The response structure of the API has changed	View Change Details