All Products
Search
Document Center

Security Center:DescribeFieldStatistics

更新時間:Nov 13, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:DescribeFieldStatisticsget
  • All Resources
    *
    none
none

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
ResourceDirectoryAccountIdlongNo

The ID of the primary account of the Resource Directory member account.

Note call the DescribeMonitorAccounts interface to obtain this parameter.
1232428423234****

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

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 servers on which no risks are detected.

10
UnKnowStatusInstanceCountinteger

The number of servers that are in the Unknown state.

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
AzureInstanceCountinteger

The number of third-party cloud servers.

5
InstanceCoreCountlong

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
RiskInstanceCoreCountlong

The number of cores of vulnerable assets.

201
ExposedInstanceCoreCountlong

The number of cores of exposed assets.

30
UnprotectedInstanceCoreCountlong

The number of cores of unprotected assets.

30
NotRunningStatusCoreCountlong

The number of cores of servers that are not started.

30
NewInstanceCoreCountlong

The number of cores of new servers.

30

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

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500RdCheckInnerErrorResource directory account service internal error.-
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2024-08-02The Error code has changed. The response structure of the API has changedView Change Details
2024-06-07The Error code has changed. The response structure of the API has changedView Change Details
2023-07-20The Error code has changed. The request parameters of the API has changedView Change Details
2023-03-30The Error code has changed. The response structure of the API has changedView Change Details