Queries the statistics of assets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer automatically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFieldStatistics

The operation that you want to perform.

Set the value to DescribeFieldStatistics.

MachineTypes String No ecs

The type of the asset. If the asset type is not specified, statistics of all types of assets are queried. Valid values:

  • ecs: Elastic Compute Service (ECS) instances
  • cloud_product: Alibaba Cloud services

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
GroupedFields Struct

The statistics of the asset.
GeneralAssetCount Integer 10

The number of general assets.
GroupCount Integer 20

The number of asset groups.
ImportantAssetCount Integer 10

The number of important assets.
InstanceCount Integer 100

The total number of assets of the specified type. If the asset type is not specified, this parameter indicates the total number of all servers and Alibaba Cloud services under your account.

NewInstanceCount Integer 10

The number of new servers.
NotRunningStatusCount Integer 10

The number of inactive servers.
OfflineInstanceCount Integer 21

The number of offline servers.
RegionCount Integer 11

The number of regions to which the servers belong.
RiskInstanceCount Integer 90

The number of assets that are at risk.
TestAssetCount Integer 10

The number of test assets.
UnprotectedInstanceCount Integer 10

The number of unprotected assets.
VpcCount Integer 5

The number of VPCs.
RequestId String 7E0618A9-D5EF-4220-9471-C42B5E92719F

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/? Action=DescribeFieldStatistics
&<Common request parameters>

Sample success responses

XML format 

<DescribeFieldStatisticsResponse>
      <RequestId>988AF6BE-4823-436D-8339-4D9ADF7DFEB6</RequestId>
      <GroupedFields>
            <InstanceCount>200</InstanceCount>
            <OfflineInstanceCount>67</OfflineInstanceCount>
            <VpcCount>26</VpcCount>
            <GroupCount>43</GroupCount>
            <RiskInstanceCount>106</RiskInstanceCount>
            <RegionCount>27</RegionCount>
            <NotRunningStatusCount>23</NotRunningStatusCount>
            <ImportantAssetCount>11</ImportantAssetCount>
            <GeneralAssetCount>179</GeneralAssetCount>
            <NewInstanceCount>11</NewInstanceCount>
            <TestAssetCount>10</TestAssetCount>
            <UnprotectedInstanceCount>68</UnprotectedInstanceCount>
      </GroupedFields>
</DescribeFieldStatisticsResponse>

JSON format 

{
	"RequestId": "988AF6BE-4823-436D-8339-4D9ADF7DFEB6",
	"GroupedFields": {
		"InstanceCount": 200,
		"OfflineInstanceCount": 67,
		"VpcCount": 26,
		"GroupCount": 43,
		"RiskInstanceCount": 106,
		"RegionCount": 27,
		"NotRunningStatusCount": 23,
		"ImportantAssetCount": 11,
		"GeneralAssetCount": 179,
		"NewInstanceCount": 11,
		"TestAssetCount": 10,
		"UnprotectedInstanceCount": 68
	}
}

Error codes

For a list of error codes, visit the API Error Center.