All Products
Search
Document Center

Security Center:DescribeHoneyPotSuspStatistics

Last Updated:Feb 20, 2024

Queries the information about top 5 virtual private clouds (VPCs) or assets for which alerts are most frequently generated.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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:DescribeHoneyPotSuspStatisticsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FromstringYes

The source of the request. Set the value to honeypot.

honeypot
StatisticsKeyTypestringYes

The type of the asset to query. Valid values:

  • vpcInstanceId: VPC
  • uuid: server
vpcInstanceId
StatisticsDaysintegerYes

The time range of the data to query. Unit: days.

30
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese.
  • en: English.
zh

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

9E3969FA-5ACC-4256-9FDE-BB6918CD0410
SuspHoneyPotStatisticsResponseobject []

An array that consists of the top 5 VPCs or assets for which alerts are most frequently generated.

Typestring

The type of the asset. Valid values:

  • vpcInstanceId: VPC
  • uuid: server
vpcInstanceId
VpcIdstring

The ID of the VPC.

Note This parameter is returned only when StatisticsKeyType is set to vpcInstanceId.
vpc-p0wwdsuutdyu1ygkt****
VpcNamestring

The name of the VPC.

Note This parameter is returned only when StatisticsKeyType is set to vpcInstanceId.
abc01
InstanceNamestring

The name of the server.

Note This parameter is returned only when StatisticsKeyType is set to uuid.
abc-launch-advisor
InstanceIdstring

The ID of the server.

Note This parameter is returned only when StatisticsKeyType is set to uuid.
i-p0whhoba24wd28p8****
Countinteger

The total number of alerts that are generated for the asset.

8793

Examples

Sample success responses

JSONformat

{
  "RequestId": "9E3969FA-5ACC-4256-9FDE-BB6918CD0410",
  "SuspHoneyPotStatisticsResponse": [
    {
      "Type": "vpcInstanceId",
      "VpcId": "vpc-p0wwdsuutdyu1ygkt****",
      "VpcName": "abc01",
      "InstanceName": "abc-launch-advisor",
      "InstanceId": "i-p0whhoba24wd28p8****",
      "Count": 8793
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParamIllegal param-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2023-03-01The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: Lang