DescribeAssetDetailByUuid - Security Center

Queries the details of a server and the extended information about the server by using the UUID of the server.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:DescribeAssetDetailByUuid	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request.	192.0.XX.XX
Uuid	string	Yes	The UUID of the server to query. Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.	9e6cad93-a379-46fd-a701-9bbf02f4****
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	39031E31-6BBA-5C99-A870-D807E78918CD
AssetDetail	object	The asset details.
CpuInfo	string	The details of the CPU.	Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz
InternetIp	string	The public IP address of the server.	192.168.XX.XX
OsDetail	string	The operating system version of the server.	Linux 64bit
CreateTime	long	The timestamp when Security Center records the details of the server. Unit: milliseconds.	1603863599000
Kernel	string	The kernel version of the operating system.	4.18.0-80.11.2.el8_0.x86_64
Bind	boolean	Indicates whether Security Center is authorized to protect the asset. Valid values: true: yes false: no	true
OsName	string	The name of the operating system.	-
Tag	string	The tag that is added to the server.	InternetIp
ClientStatus	string	The status of the Security Center agent. Valid values: pause: The Security Center agent suspends protection for your server. online: The Security Center agent is protecting your server. offline: The Security Center agent does not protect your server.	online
Mem	integer	The memory size of the server. Unit: GB.	32
Memory	long	The memory size of the server. Unit: MB.	512
VpcInstanceId	string	The ID of the virtual private cloud (VPC) in which the server resides.	vpc-bp1fs3bwonlfq503w****
AuthVersion	integer	The edition of Security Center that is authorized to protect the asset. Valid values: 1: Basic edition (Unauthorized) 6: Anti-virus edition 5: Advanced edition 3: Enterprise edition 7: Ultimate edition 10: Value-added Plan edition	7
InstanceName	string	The name of the server.	i-fasdfasdfadfafa****
Region	string	The region in which the server resides.	cn-hangzhou-dg-a01
GroupTrace	string	The group to which the server belongs. By default, the servers that are not grouped belong to the Default group.	default
Ip	string	The IP address that is assigned to the Elastic Compute Service (ECS) instance.	192.168.XX.XX
HostName	string	The name of the host.	qewrqwerqs****
Os	string	The operating system type of the server.	linux
AuthModifyTime	long	The timestamp when Security Center is authorized to protect the asset. Unit: milliseconds.	1627974044000
InstanceId	string	The ID of the server.	i-uf6h7p2fgk6rkk0g****
IntranetIp	string	The private IP address of the server.	192.168.XX.XX
AssetType	string	The type of the asset. Valid values: 0: ECS instance 1: Server Load Balancer (SLB) instance 2: NAT gateway 3: ApsaraDB RDS database 4: ApsaraDB for MongoDB database 5: ApsaraDB for Redis database 6: image 7: container	0
RegionId	string	The ID of the region in which the asset resides.	cn-hanghzou
SysInfo	string	The operating system information about the server.	CentOS Linux 8.0.1905
Uuid	string	The UUID of the server.	9e6cad93-a379-46fd-a701-9bbf02f4****
Cpu	integer	The number of CPU cores.	2
RegionName	string	The name of the region in which the server resides.	China (Hohhot)
Flag	integer	Indicates whether the asset is provided by Alibaba Cloud. Valid values: 0: yes 1: no	0
ClientVersion	string	The version of the Security Center agent.	2.0.0
IpList	array	The IP addresses of the server.
Ip	string	The IP addresses of the server.	["192.168.XX.XX"]
MacList	array	The Media Access Control (MAC) addresses.
Mac	string	The MAC addresses of the server.	["00:16:3:1:9*:cf"]
DiskInfoList	array	An array that consists of the information about the disk.
DiskInfo	string	The information about the disk. This parameter contains the following fields: diskName: the name of the disk. totalSize: the total amount of the disk space. Unit: GB. useSize: the amount of the used disk space. Unit: GB. useSizeByte: the amount of the used disk space. Unit: bytes. totalSizeByte: the total amount of the disk space. Unit: bytes.	{diskName: "/dev/vda1", useSizeByte: 2998996992, totalSize: 40, useSize: 2, totalSizeByte: 42140479488}

Examples

Sample success responses

JSONformat

{
  "RequestId": "39031E31-6BBA-5C99-A870-D807E78918CD",
  "AssetDetail": {
    "CpuInfo": "Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz",
    "InternetIp": "192.168.XX.XX",
    "OsDetail": "Linux 64bit",
    "CreateTime": 1603863599000,
    "Kernel": "4.18.0-80.11.2.el8_0.x86_64",
    "Bind": true,
    "OsName": "-",
    "Tag": "InternetIp",
    "ClientStatus": "online",
    "Mem": 32,
    "Memory": 512,
    "VpcInstanceId": "vpc-bp1fs3bwonlfq503w****",
    "AuthVersion": 7,
    "InstanceName": "i-fasdfasdfadfafa****",
    "Region": "cn-hangzhou-dg-a01",
    "GroupTrace": "default",
    "Ip": "192.168.XX.XX",
    "HostName": "qewrqwerqs****",
    "Os": "linux",
    "AuthModifyTime": 1627974044000,
    "InstanceId": "i-uf6h7p2fgk6rkk0g****",
    "IntranetIp": "192.168.XX.XX",
    "AssetType": "0",
    "RegionId": "cn-hanghzou",
    "SysInfo": "CentOS Linux 8.0.1905",
    "Uuid": "9e6cad93-a379-46fd-a701-9bbf02f4****",
    "Cpu": 2,
    "RegionName": "China (Hohhot)",
    "Flag": 0,
    "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	Description
400	NoPermission	no permission	-
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2024-07-30	The API operation is deprecated. The Error code has changed	View Change Details
2022-12-23	API Description Update. The API operation is not deprecated.. The Error code has changed	View Change Details