All Products
Search

This Product

    Security Center:CreateHoneypotProbe

    Document Center

    Security Center:CreateHoneypotProbe

    Last Updated:Nov 25, 2024

    Creates a probe.

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

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ControlNodeIdstringYes

    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****
    ProbeTypestringYes

    The type of the probe. Valid values:

    • host_probe: host probe
    • vpc_black_hole_probe: virtual private cloud (VPC) probe
    		host_probe
    DisplayNamestringYes

    The name of the probe.

    		testHoneyPotProbe
    ProbeVersionstringNo

    The version of the probe.

    		0.0.0
    UuidstringNo

    The UUID of the instance.

    Note If ProbeType is set to host_probe, this parameter is required.
    		e4af3620-6895-4e2f-a641-a9d8fb53****
    BusinessGroupIdstringNo

    The ID of the business group.

    		2022011817324588686
    HoneypotBindListarray<object>No

    The configuration of the probe.

    HoneypotBindListobjectNo

    The details of the configuration.

    BindPortListarray<object>No

    The listener ports.

    BindPortListobjectNo

    The listener port.

    TargetPortintegerNo

    The destination port.

    Note If HoneypotId is specified, this parameter is required.
    		80
    StartPortintegerNo

    The start of the port range.

    		80
    EndPortintegerNo

    The end of the port range.

    		90
    FixedbooleanNo

    Specifies whether the port is a fixed port. Valid values:

    • 0: no
    • 1: yes
    		0
    BindPortbooleanNo

    Specifies whether to bind a port. Valid values:

    • true: yes
    • false: no
    		true
    HoneypotIdstringNo

    The ID of the honeypot.

    Note You can call the ListHoneypot operation to query the IDs of honeypots.
    		1a5eda2d40f92ac87d6b63e1a5ad4b76fe0d4110c4a3e2fa85438a29ae55****
    PingbooleanNo

    Specifies whether to enable ping scan. Valid values:

    • true: yes
    • false: no
    		true
    ArpbooleanNo

    Specifies whether to enable Address Resolution Protocol (ARP) spoofing. Valid values:

    • true: yes
    • false: no
    		true
    VpcIdstringNo

    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
    ProxyIpstringNo

    The IP address of the proxy.

    		192.168.XX.XX

    Response parameters

    ParameterTypeDescriptionExample
    object

    The returned result.

    Successboolean

    Indicates whether the request was successful. Valid values:

    • true: The request was successful.
    • false: The request failed.
    		true
    Codestring

    The status code returned. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed. You can identify the cause of the failure based on the status code.

    		200
    Messagestring

    The message returned.

    		successful
    RequestIdstring

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

    		B7A839E8-70AE-591D-8D9E-C5419A2240DB
    HttpStatusCodeinteger

    The HTTP status code returned.

    		200
    HoneypotProbeobject

    The information about the probe.

    ProbeIdstring

    The ID of the probe.

    		b69e9aa8-2ea8-4c5a-836a-c1fbacff****

    Examples

    Sample success responses

    JSONformat

    {
  "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 codeError codeError messageDescription
    400AgentNotOnlineThe 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.
    400IllegalParamIllegal param-
    400NodeNotExistThe control node does not exist.-
    400BindPortAlreadyExistThe specified service port already exists.-
    400MachineNotExistThe machine does not exist.-
    400ProbeAlreadyCreateThe probe has been created.-
    400ProbeNameAlreadyExistsThe probe name already exists.-
    403NoPermissioncaller has no permissionYou are not authorized to do this operation.
    500ServerErrorServerError-

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