DescribeAssetDetailByUuids API Reference for ECS Asset Queries - Security Center - Alibaba Cloud - Security Center

Queries the details of an asset (ECS instance).

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Uuids	string	Yes	The UUIDs of the asset instances. Separate multiple UUIDs with commas (,). Note Call the DescribeCloudCenterInstances operation to obtain this parameter.	0687b17f-2a36-4e5**,0687b17f-2a36-4e**
Lang	string	No	The language of the content in the request and response. Default value: zh. Valid values: zh: Chinese en: English.	zh
ResourceDirectoryAccountId	integer	No	The Alibaba Cloud account ID of the member accounts in the resource folder. Note Invoke the DescribeMonitorAccounts operation to obtain this parameter.	127608589417****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	92016EC8-D52D-49D8-9FF7-9EA340A950B9
AssetList	array<object>	The list of asset details.
	object	The asset details.
InternetIp	string	The public IP address of the server.	10.10.XX.XX
OsName	string	The name of the operating system of the server asset.	CentOS 7.6 64位
Ip	string	The IP address of the server. Note If a public IP address exists, this value is the public IP address. If no public IP address exists but a private IP address exists, this value is the private IP address.	10.10.XX.XX
Os	string	The operating system type of the server.	Linux
InstanceId	string	The instance ID of the asset.	i-rj9gda4wolo0zixi****
ClientStatus	string	The status of the China China China agent client. Valid values: online: online offline: offline.	online
VpcInstanceId	string	The VPC-connected instance ID.	13231-331331
IntranetIp	string	The private IP address of the server.	192.168.XX.XX
AssetType	string	The type of the asset. The only valid value is 0, which indicates an ECS instance.	0
RegionId	string	The region in which the server resides. Note For the mapping between region IDs and region names, see Regions and zones.	cn-shanghai
Uuid	string	The UUID of the asset.	2a98f149-0256-414c-a29a-a69f8a75****
Flag	integer	The asset vendor. Valid values: 0: Alibaba Cloud asset 1: asset outside the cloud 2: IDC asset 3, 4, 5, 7: third-party cloud asset 8: lightweight asset.	0
RegionName	string	The name of the region in which the server resides.	cn-shenzhen
InstanceName	string	The instance name of the asset.	TestInstanceName
Region	string	The region in which the server resides.	cn-guangzhou
CpuInfo	string	The CPU details.	Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz
OsDetail	string	The operating system version and architecture of the server.	Linux 64bit
CreateTime	integer	The timestamp when Security Center recorded the asset information. Unit: milliseconds.	1603863599000
Kernel	string	The Milvus version of the operating system kernel.	4.18.0-80.11.2.el8_0.x86_64
Bind	boolean	Indicates whether the asset is bound to an authorization. Valid values: true: bound to an authorization false: not bound to an authorization.	true
Tag	string	The tag of the server.	test
Mem	integer	The memory size. Unit: GB.	4
Memory	integer	The memory size. Unit: MB.	1024
AuthVersion	integer	The authorization version of the asset. Valid values: 1: Free Edition (unauthorized) 6: Anti-virus Edition 5: Advanced Edition 3: Enterprise Edition 7: Ultimate Edition.	7
GroupTrace	string	The group to which the server belongs. Servers that are not assigned to a group belong to the Ungrouped group by default.	default
HostName	string	The hostname.	test
AuthModifyTime	integer	The timestamp when the asset authorization was bound. Unit: milliseconds.	1627974044000
SysInfo	string	The operating system information of the server.	CentOS Linux 8.0.1905
Cpu	integer	The number of CPU cores.	4
ClientVersion	string	The version of the agent client.	2.0.0
IpList	array	The list of IP addresses of the server.
	string	The IP address of the server.	192.168.XX.XX
MacList	array	The list of MAC addresses.
	string	The MAC address.	00:16:3:1:9*:cf
DiskInfoList	array	The list of disk information.
	string	The disk information. The following parameters describe the disk: diskName: the disk name. totalSize: the total disk capacity. Unit: GB. useSize: the used disk capacity. Unit: GB. useSizeByte: the used disk capacity. Unit: bytes. totalSizeByte: the total disk capacity. Unit: bytes.	{diskName: "/dev/vda1", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}

Examples

Success response

JSON format

{
  "RequestId": "92016EC8-D52D-49D8-9FF7-9EA340A950B9",
  "AssetList": [
    {
      "InternetIp": "10.10.XX.XX",
      "OsName": "CentOS  7.6 64位",
      "Ip": "10.10.XX.XX",
      "Os": "Linux",
      "InstanceId": "i-rj9gda4wolo0zixi****",
      "ClientStatus": "online",
      "VpcInstanceId": "13231-331331",
      "IntranetIp": "192.168.XX.XX",
      "AssetType": "0",
      "RegionId": "cn-shanghai",
      "Uuid": "2a98f149-0256-414c-a29a-a69f8a75****",
      "Flag": 0,
      "RegionName": "cn-shenzhen",
      "InstanceName": "TestInstanceName",
      "Region": "cn-guangzhou",
      "CpuInfo": "Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz",
      "OsDetail": "Linux 64bit",
      "CreateTime": 1603863599000,
      "Kernel": "4.18.0-80.11.2.el8_0.x86_64",
      "Bind": true,
      "Tag": "test",
      "Mem": 4,
      "Memory": 1024,
      "AuthVersion": 7,
      "GroupTrace": "default",
      "HostName": "test",
      "AuthModifyTime": 1627974044000,
      "SysInfo": "CentOS Linux 8.0.1905",
      "Cpu": 4,
      "ClientVersion": "2.0.0",
      "IpList": [
        "192.168.XX.XX"
      ],
      "MacList": [
        "00:16:3*:1*:9*:cf"
      ],
      "DiskInfoList": [
        "{diskName: \"/dev/vda1\", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}"
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	IllegalParam	Illegal param
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	RdCheckInnerError	Resource directory account service internal error.
500	GetAssetDetailFail	Asset detail service has failed due to some unknown error.
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.