DescribeFieldStatistics - Security Center - Alibaba Cloud Documentation Center

Queries the statistics of servers.

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

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region in which the asset resides.	cn-hangzhou
MachineTypes	string	No	The type of the asset to query. If no asset types are specified, all types of assets are returned. Valid values: ecs: server cloud_product: Alibaba Cloud service	ecs
ResourceDirectoryAccountId	long	No	The ID of the primary account of the Resource Directory member account. Note call the DescribeMonitorAccounts interface to obtain this parameter.	1232428423234****

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.	7E0618A9-D5EF-4220-9471-C42B5E92719F
GroupedFields	object	The information about servers that are returned.
OfflineInstanceCount	integer	The number of servers whose Security Center agent status is Offline.	21
NoRiskInstanceCount	integer	The number of servers on which no risks are detected.	10
UnKnowStatusInstanceCount	integer	The number of servers that are in the Unknown state.	1
RegionCount	integer	The number of regions to which the servers belong.	11
NewInstanceCount	integer	The number of newly added servers.	10
ExposedInstanceCount	integer	The number of exposed servers.	1
GroupCount	integer	The number of server groups.	20
TencentInstanceCount	integer	The total number of cloud services that are protected by Security Center.	10
GeneralAssetCount	integer	The number of assets whose importance is common.	10
InstanceSyncTaskCount	integer	The total number of tasks for the specified type of assets. If no asset types are specified, this parameter indicates the total number of all servers and Alibaba Cloud services within your account.	10
UnprotectedInstanceCount	integer	The number of unprotected assets.	10
ImportantAssetCount	integer	The number of assets whose importance is important.	10
TestAssetCount	integer	The number of assets whose importance is test.	10
VpcCount	integer	The number of virtual private clouds (VPCs).	5
InstanceCount	integer	The total number of assets of the specified type. If no asset types are specified, this parameter indicates the total number of all servers and Alibaba Cloud services within your account.	100
PauseInstanceCount	integer	The number of servers for which the Security Center agent suspends protection.	10
IdcInstanceCount	integer	The number of assets that can be protected by Security Center.	100
NotRunningStatusCount	integer	The number of servers that are shut down.	10
AliYunInstanceCount	integer	The number of assets that are deployed on Alibaba Cloud.	100
RiskInstanceCount	integer	The number of assets that are at risk.	90
HuaweiInstanceCount	integer	The number of instances that are provisioned by third-party providers.	0
AwsInstanceCount	integer	The number of servers.	100
OutMachineInstanceCount	integer	The number of servers outside the cloud.	20
TripartiteInstanceCount	integer	The number of simple application servers.	2
AzureInstanceCount	integer	The number of third-party cloud servers.	5
InstanceCoreCount	long	The number of cores of assets in the specified asset type. If the asset type is not specified, the value of this parameter indicates the total number of cores of servers and Alibaba Cloud services within your account.	301
RiskInstanceCoreCount	long	The number of cores of vulnerable assets.	201
ExposedInstanceCoreCount	long	The number of cores of exposed assets.	30
UnprotectedInstanceCoreCount	long	The number of cores of unprotected assets.	30
NotRunningStatusCoreCount	long	The number of cores of servers that are not started.	30
NewInstanceCoreCount	long	The number of cores of new servers.	30
NotBindMachineInstanceCount	integer	The number of assets that are not added to Security Center of the specified asset type.	10
VolcengineInstanceCount	integer	The number of instances that are provisioned by third-party providers.	20

Examples

Sample success responses

JSONformat

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "GroupedFields": {
    "OfflineInstanceCount": 21,
    "NoRiskInstanceCount": 10,
    "UnKnowStatusInstanceCount": 1,
    "RegionCount": 11,
    "NewInstanceCount": 10,
    "ExposedInstanceCount": 1,
    "GroupCount": 20,
    "TencentInstanceCount": 10,
    "GeneralAssetCount": 10,
    "InstanceSyncTaskCount": 10,
    "UnprotectedInstanceCount": 10,
    "ImportantAssetCount": 10,
    "TestAssetCount": 10,
    "VpcCount": 5,
    "InstanceCount": 100,
    "PauseInstanceCount": 10,
    "IdcInstanceCount": 100,
    "NotRunningStatusCount": 10,
    "AliYunInstanceCount": 100,
    "RiskInstanceCount": 90,
    "HuaweiInstanceCount": 0,
    "AwsInstanceCount": 100,
    "OutMachineInstanceCount": 20,
    "TripartiteInstanceCount": 2,
    "AzureInstanceCount": 5,
    "InstanceCoreCount": 301,
    "RiskInstanceCoreCount": 201,
    "ExposedInstanceCoreCount": 30,
    "UnprotectedInstanceCoreCount": 30,
    "NotRunningStatusCoreCount": 30,
    "NewInstanceCoreCount": 30,
    "NotBindMachineInstanceCount": 10,
    "VolcengineInstanceCount": 20
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	NoPermission	no permission	-
400	RdCheckNoPermission	Resource directory account verification has no permission.	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	RdCheckInnerError	Resource directory account service internal error.	-
500	ServerError	ServerError	-

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

Change history

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