Call CreateHoneypotProbe to create a honeypot probe - Security Center - Alibaba Cloud - Security Center

Creates a honeypot probe.

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

create

*HoneypotProbe

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

None

Request parameters

Parameter	Type	Required	Description	Example
ControlNodeId	string	Yes	The ID of the management node. Note You can call the ListHoneypotNode operation to query the IDs of management nodes.	a882e590-b87b-45a6-87b9-d0a3e5a0****
ProbeType	string	Yes	The type of the probe. Valid values: host_probe: host probe vpc_black_hole_probe: virtual private cloud (VPC) probe	host_probe
DisplayName	string	Yes	The name of the probe.	testHoneyPotProbe
ProbeVersion	string	No	The version of the probe.	0.0.0
Uuid	string	No	The UUID of the instance. Note If ProbeType is set to host_probe, this parameter is required.	e4af3620-6895-4e2f-a641-a9d8fb53****
BusinessGroupId	string	No	The ID of the business group.	2022011817324588686
HoneypotBindList	array<object>	No	The configuration of the probe.
	array<object>	No	The details of the configuration.
BindPortList	array<object>	No	The listener ports.
	object	No	The listener port.
TargetPort	integer	No	The destination port. Note If HoneypotId is specified, this parameter is required.	80
StartPort	integer	No	The start of the port range.	80
EndPort	integer	No	The end of the port range.	90
Fixed	boolean	No	Specifies whether the port is a fixed port. Valid values: 0: no 1: yes	0
BindPort	boolean	No	Specifies whether to bind a port. Valid values: true: yes false: no	true
HoneypotId	string	No	The ID of the honeypot. Note You can call the ListHoneypot operation to query the IDs of honeypots.	1a5eda2d40f92ac87d6b63e1a5ad4b76fe0d4110c4a3e2fa85438a29ae55****
Ping	boolean	No	Specifies whether to enable ping scan. Valid values: true: yes false: no	true
Arp	boolean	No	Specifies whether to enable Address Resolution Protocol (ARP) spoofing. Valid values: true: yes false: no	true
VpcId	string	No	The ID of the VPC. Note If ProbeType is set to vpc_black_hole_probe, this parameter is required. You can call the DescribeVpcHoneyPotList operation to query the IDs of VPCs.	vpc-zm0asrkpv1q8gnk7mn4dn
ProxyIp	string	No	The IP address of the proxy.	192.168.XX.XX

Response elements

Element	Type	Description	Example
	object	The returned result.
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The status code. A value of 200 indicates success. Other values indicate failure.	200
Message	string	The message returned.	successful
RequestId	string	The request ID for troubleshooting.	B7A839E8-70AE-591D-8D9E-C5419A2240DB
HttpStatusCode	integer	The HTTP status code returned.	200
HoneypotProbe	object	The information about the probe.
ProbeId	string	The ID of the probe.	b69e9aa8-2ea8-4c5a-836a-c1fbacff****

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "B7A839E8-70AE-591D-8D9E-C5419A2240DB",
  "HttpStatusCode": 200,
  "HoneypotProbe": {
    "ProbeId": "b69e9aa8-2ea8-4c5a-836a-c1fbacff****"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	AgentNotOnline	The agent not online.	The error message returned because the Security Center agent is offline. Make sure that the Security Center agent is online and try again.
400	IllegalParam	Illegal param
400	NodeNotExist	The control node does not exist.
400	BindPortAlreadyExist	The specified service port already exists.
400	MachineNotExist	The machine does not exist.
400	ProbeAlreadyCreate	The probe has been created.
400	ProbeNameAlreadyExists	The probe name already exists.
500	ServerError	ServerError
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.