DescribeFieldStatistics API Overview for Server Asset Data - Security Center - Alibaba Cloud - Security Center

Queries the statistics information of servers in your assets.

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:DescribeFieldStatistics

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the server resides.	cn-hangzhou
MachineTypes	string	No	The type of asset to query. If you do not specify an asset type, the statistics information of all asset types is queried. Valid values: ecs: server cloud_product: cloud product.	ecs
ResourceDirectoryAccountId	integer	No	The ID of the Alibaba Cloud account of the member accounts in the resource directory. Note You can invoke the DescribeMonitorAccounts operation to obtain this parameter.	1232428423234****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	7E0618A9-D5EF-4220-9471-C42B5E92719F
GroupedFields	object	The statistics of server assets.
OfflineInstanceCount	integer	The number of offline servers.	21
NoRiskInstanceCount	integer	The number of assets without risky asset issues.	10
UnKnowStatusInstanceCount	integer	The number of assets with an unknown enabling status.	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 assets.	1
GroupCount	integer	The number of server groups.	20
TencentInstanceCount	integer	The number of third-party cloud servers.	10
GeneralAssetCount	integer	The number of general assets.	10
InstanceSyncTaskCount	integer	The number of tasks under the asset type that you specified in the query. If you did not specify an asset type, this value is the total number of all servers and cloud products in your assets.	10
UnprotectedInstanceCount	integer	The number of unprotected assets.	10
ImportantAssetCount	integer	The number of important assets.	10
TestAssetCount	integer	The number of test assets.	10
VpcCount	integer	The number of virtual private clouds (VPCs).	5
InstanceCount	integer	The total number of assets under the asset type that you specified in the query. If you did not specify an asset type, this value is the total number of all servers and cloud products in your assets.	100
PauseInstanceCount	integer	The number of paused servers.	10
IdcInstanceCount	integer	The number of assets that Security Center can detect.	100
NotRunningStatusCount	integer	The number of servers that are not started (powered off).	10
AliYunInstanceCount	integer	The number of assets that belong to Alibaba Cloud server groups.	100
RiskInstanceCount	integer	The number of assets at risk.	90
HuaweiInstanceCount	integer	The number of third-party cloud servers.	0
AwsInstanceCount	integer	The number of third-party cloud servers.	100
OutMachineInstanceCount	integer	The number of instances outside the cloud.	20
TripartiteInstanceCount	integer	The number of simple application servers.	2
AzureInstanceCount	integer	The number of third-party cloud servers.	5
InstanceCoreCount	integer	The total number of compute cores of all assets under the asset type that you specified in the query. If you did not specify an asset type, this value is the total number of compute cores of all servers and cloud products in your assets.	301
RiskInstanceCoreCount	integer	The number of compute cores of assets at risk.	201
ExposedInstanceCoreCount	integer	The number of compute cores of exposed assets.	30
UnprotectedInstanceCoreCount	integer	The number of compute cores of unprotected assets.	30
NotRunningStatusCoreCount	integer	The number of compute cores of servers that are not started (powered off).	30
NewInstanceCoreCount	integer	The number of compute cores of newly added servers.	30
NotBindMachineInstanceCount	integer	The number of asset types without bound authorization under the asset type that you specified in the query.	10
VolcengineInstanceCount	integer	The number of third-party cloud servers.	10
GoogleInstanceCount	integer	The number of third-party cloud servers.	10
BaiduInstanceCount	integer	The number of third-party cloud servers.	5
UcloudInstanceCount	integer	The number of third-party cloud servers.	5
StateCloudInstanceCount	integer	The number of third-party cloud servers.	5
KingsoftInstanceCount	integer	The number of third-party cloud servers.	5

Examples

Success response

JSON format

{
  "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": 10,
    "GoogleInstanceCount": 10,
    "BaiduInstanceCount": 5,
    "UcloudInstanceCount": 5,
    "StateCloudInstanceCount": 5,
    "KingsoftInstanceCount": 5
  }
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	RdCheckInnerError	Resource directory account service internal error.
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.