DescribeAllEntity API Reference for Asset Inventory - Security Center - Alibaba Cloud - Security Center

Retrieves the list of all server assets, including asset group IDs and asset names.

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

get

*All Resource

*

None

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
RequestId	string	The ID of the request. Alibaba Cloud generates a unique identifier for each request. You can use the ID to troubleshoot issues.	7E0618A9-D5EF-4220-9471-C42B5E92719F
EntityList	array<object>	The list of instances.
	object
Uuid	string	The UUID of the server.	4fe8e1cd-3c37-4851-b9de-124da32c****
GroupId	integer	The ID of the asset group.	281801
InternetIp	string	The public IP address.	172.19.XX.XX
InstanceName	string	The name of the server instance.	abc
Ip	string	The IP address of the server.	101.132.XX.XX
Os	string	The operating system of the server. Valid values: linux windows.	windows
IntranetIp	string	The private IP address.	100.104.XX.XX

Examples

Success response

JSON format

{
  "RequestId": "7E0618A9-D5EF-4220-9471-C42B5E92719F",
  "EntityList": [
    {
      "Uuid": "4fe8e1cd-3c37-4851-b9de-124da32c****",
      "GroupId": 281801,
      "InternetIp": "172.19.XX.XX",
      "InstanceName": "abc",
      "Ip": "101.132.XX.XX",
      "Os": "windows",
      "IntranetIp": "100.104.XX.XX"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.