Create & Configure Honeypot Nodes via API for Threat Detection - Security Center - Alibaba Cloud - Security Center

Operation description

Before creating a management node, make sure that your account has a sufficient honeypot probe quota. Call DescribeHoneyPotAuth and ListHoneypotNode to query the quota and node usage. If the quota is insufficient, call DeleteHoneypotNode to release existing nodes or purchase more probe capacity.

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

create

*HoneypotNode

acs:yundun-sas:{#regionId}:{#accountId}:honeypotnode/*

None

Request parameters

Parameter	Type	Required	Description	Example
NodeName	string	Yes	The name of the management node.	manageNode
AvailableProbeNum	integer	No	The number of available probes. This parameter is required. If this parameter is not specified, the API returns InvalidParam (400). The minimum value is 20. If the value is less than 20, the API returns InvalidProbeNum (400).	20
AllowHoneypotAccessInternet	boolean	No	Specifies whether to allow the honeypot to access the Internet. Valid values: true: Allowed. false: Not allowed.	true
SecurityGroupProbeIpList	array	No	The list of allowed CIDR blocks. This parameter is required. At least one allowed CIDR block must be specified, such as 0.0.0.0/0. If this parameter is not specified, the API returns InvalidParam (400).
	string	No	The allowed CIDR block.	0.0.0.0/0

Response elements

Element	Type	Description	Example
	object	BaseResult
Success	boolean	Indicates whether the call was successful. Valid values: true: Successful. false: Failed.	true
Code	string	The result code. A value of 200 indicates success. Any other value indicates failure. You can use this field to determine the cause of the failure.	200
Message	string	The detailed information about the error code.	successful
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for this request. You can use this ID to troubleshoot issues.	028CF634-5268-5660-9575-48C9ED6BF880
HttpStatusCode	integer	The HTTP status code.	200
HoneypotNode	object	The data returned for the created honeypot management node.
NodeId	string	The ID of the management node.	37a15ff1-3475-4897-aa6c-f7fd9122****

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "028CF634-5268-5660-9575-48C9ED6BF880",
  "HttpStatusCode": 200,
  "HoneypotNode": {
    "NodeId": "37a15ff1-3475-4897-aa6c-f7fd9122****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParam	There was an error with your request.	An error occurred while processing your request. Try again later.
400	NeedBuy	This service shoule be purchased first.
400	AuthorizedProbeCannotReduce	The number of authorized probes cannot be reduced.
400	InvalidProbeNum	Invalid number of probes.
400	ProbeNumInsufficient	The number of probes remaining is insufficient.
500	ServerError	Service error, please try again later.
403	NoPermission	caller has no permission	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.