GetHoneypotNode API Reference for Honeypot Nodes - Security Center

Retrieves the details of a specified management node.

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

get

*HoneypotNode

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

None

Request parameters

Parameter	Type	Required	Description	Example
NodeId	string	Yes	The ID of the management node. Note You can call the ListHoneypotNode operation to query the IDs of management nodes.	d3dd3864-4e02-4abd-8b6a-8f5f6fec4715
Lang	string	No	The language of the content within the request and response. Valid values: zh: Chinese en: English	zh

Response elements

Element	Type	Description	Example
	object	The data returned.
HoneypotNode	object	The details of the management node.
NodeId	string	The ID of the management node.	a7409a58-bc60-41af-9d36-080d58ae****
NodeName	string	The name of the management node.	gmmc
HoneypotTotalCount	integer	The maximum number of honeypots that can be deployed to the management node.	10
HoneypotUsedCount	integer	The number of honeypots that are deployed to the management node.	5
ProbeTotalCount	integer	The maximum number of probes that can be deployed for the management node.	20
ProbeUsedCount	integer	The number of probes that are deployed for the management node.	15
TotalStatus	integer	The status of the management node. Valid values: 0: preparing 1: normal 2: abnormal 4: starting 5: upgrading	2
EcsInstanceId	string	The ID of the instance.	i-2vccskxjunf1ag6w****
CreateTime	string	The time when the management node was created.	2022-12-02 17:13:43
SecurityGroupProbeIpList	array	An array consisting of the CIDR blocks that are allowed to access the management node.
	string	The CIDR block that is allowed to access the management node.	10.0.0.0/24
AllowHoneypotAccessInternet	boolean	Indicates whether a honeypot is allowed to access the Internet. Valid values: true: The honeypot is allowed to access the Internet. false: The honeypot is not allowed to access the Internet.	true
NodeIp	string	The IP address of the management node.	101.37.XX.XX
UpgradeAvailable	boolean	Indicates whether the management node can be upgraded. Valid values: true: yes false: no	true
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 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
Message	string	The message returned.	successful
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	0A453658-070B-5554-B46C-867425BE4FD4
HttpStatusCode	integer	The HTTP status code returned.	200

Examples

Success response

JSON format

{
  "HoneypotNode": {
    "NodeId": "a7409a58-bc60-41af-9d36-080d58ae****",
    "NodeName": "gmmc",
    "HoneypotTotalCount": 10,
    "HoneypotUsedCount": 5,
    "ProbeTotalCount": 20,
    "ProbeUsedCount": 15,
    "TotalStatus": 2,
    "EcsInstanceId": "i-2vccskxjunf1ag6w****",
    "CreateTime": "2022-12-02 17:13:43",
    "SecurityGroupProbeIpList": [
      "10.0.0.0/24"
    ],
    "AllowHoneypotAccessInternet": true,
    "NodeIp": "101.37.XX.XX",
    "UpgradeAvailable": true
  },
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "RequestId": "0A453658-070B-5554-B46C-867425BE4FD4",
  "HttpStatusCode": 200
}

Error codes

HTTP status code	Error code	Error message	Description
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.