All Products
Search
Document Center

Security Center:DescribeFieldStatistics

Last Updated:Jan 28, 2023

Queries the statistics of assets that belong to your account.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The ID of the region in which the asset resides.

cn-hangzhou
MachineTypesstringNo

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

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

7E0618A9-D5EF-4220-9471-C42B5E92719F
GroupedFieldsobject

The information about servers that are returned.

OfflineInstanceCountinteger

The number of servers whose Security Center agent status is Offline.

21
NoRiskInstanceCountinteger

The number of assets that do not pose risks.

10
UnKnowStatusInstanceCountinteger

The number of assets whose statuses are unknown.

1
RegionCountinteger

The number of regions to which the servers belong.

11
NewInstanceCountinteger

The number of newly added servers.

10
ExposedInstanceCountinteger

The number of exposed servers.

1
GroupCountinteger

The number of server groups.

20
TencentInstanceCountinteger

The total number of cloud services that are protected by Security Center.

10
GeneralAssetCountinteger

The number of assets whose importance is common.

10
InstanceSyncTaskCountinteger

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
UnprotectedInstanceCountinteger

The number of unprotected assets.

10
ImportantAssetCountinteger

The number of assets whose importance is important.

10
TestAssetCountinteger

The number of assets whose importance is test.

10
VpcCountinteger

The number of virtual private clouds (VPCs).

5
InstanceCountinteger

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
PauseInstanceCountinteger

The number of servers for which the Security Center agent suspends protection.

10
IdcInstanceCountinteger

The number of assets that can be protected by Security Center.

100
NotRunningStatusCountinteger

The number of servers that are shut down.

10
AliYunInstanceCountinteger

The number of assets that are deployed on Alibaba Cloud.

100
RiskInstanceCountinteger

The number of assets that are at risk.

90
HuaweiInstanceCountinteger

The number of instances that are provisioned by third-party providers.

0
AwsInstanceCountinteger

The number of servers.

100
OutMachineInstanceCountinteger

The number of servers outside the cloud.

20
TripartiteInstanceCountinteger

The number of simple application servers.

2

Example

Normal return example

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
  }
}

Error codes

Http codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the API error center.

Change history

Change timeSummary of changesOperate
No change history