Use GetAssetDetailByUuid to query server details - Security Center - Alibaba Cloud - Security Center

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

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the request. You do not need to specify this parameter. The system automatically obtains this value.	120.245.XX.XX
Uuid	string	Yes	The UUID of the asset that you want to query. Note Call the DescribeCloudCenterInstances operation to obtain this parameter.	9e6cad93-a379-46fd-a701-9bbf02f4****
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English.	zh

Response elements

Element	Type	Description	Example
	object	The response parameters.
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.	4892B68B-47BC-5E56-B327-9C2ACC6C1C09
AssetDetail	object	The asset details.
CpuInfo	string	The CPU details.	Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz
InternetIp	string	The public IP address of the server.	120.47.XX.XX
OsDetail	string	The operating system version and architecture of the server.	Linux 64bit
CreateTime	integer	The timestamp when Security Center recorded the asset information, in 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 the asset is bound to an authorization. Valid values: true: The asset is bound to an authorization. false: The asset is not bound to an authorization.	true
OsName	string	The operating system name of the server.	CentOS 7.4 64bit
Tag	string	The tag of the server.	InternetIp
ClientStatus	string	The status of the Security Center agent. Valid values: pause: Protection paused. online: Protected. offline: Not protected.	online
Mem	integer	The memory size, in GB.	16
Memory	integer	The memory size, in MB.	16384
VpcInstanceId	string	The instance ID of the VPC-connected instance where the server resides.	vpc-bp1fs3bwonlfq503w****
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
InstanceName	string	The name of the server.	i-fasdfasdfadfafa****
Region	string	The region where the server resides.	cn-shanghai
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
Ip	string	The IP address assigned by ECS.	120.47.XX.XX
HostName	string	The hostname.	qewrqwerqs****
Os	string	The operating system type of the server.	linux
AuthModifyTime	integer	The timestamp when the asset authorization was bound, in 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 asset type. Valid values: 0: Elastic Compute Service (ECS) server. 1: Server Load Balancer (SLB). 2: NAT gateway. 3: ApsaraDB RDS database. 4: ApsaraDB for MongoDB database. 5: ApsaraDB for Redis database. 6: container image. 7: container.	0
RegionId	string	The region ID of the asset.	cn-hanghzou
SysInfo	string	The operating system information of 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 where the server resides.	China (Hohhot)
Flag	integer	Indicates whether the asset is an Alibaba Cloud asset. Valid values: 0: Alibaba Cloud asset. 1: Non-Alibaba Cloud asset.	0
ClientVersion	string	The version of the Security Center agent.	2.0.0
IpList	array	The list of IP addresses of the server.
	string	The list of IP addresses of the server.	120.47.XX.XX
MacList	array	The MAC address.
	string	The MAC address.	00:16:3:1:9*:cf
DiskInfoList	array<object>	The list of disk information.
	object	The disk information.
DiskName	string	The name of the disk.	/dev/vda1
UseSizeByte	integer	The amount of the used disk space. Unit: bytes.	2998996992
TotalSize	integer	The total disk space. Unit: GB.	40
UseSize	integer	The amount of the used disk space. Unit: GB.	2
TotalSizeByte	integer	The total disk space. Unit: bytes.	42140479488
ClientSubStatus	string	The sub-status of the client on the instance. Valid values: online: Online. The Security Center agent is enabled. offline: Offline. The Security Center agent is disabled. pause: Paused. The Security Center agent is in protection paused state. uninstalled: Not installed. The Security Center agent is not installed. stopped: Server shut down. The Security Center agent is in server shut down state.	online
VendorAuthAlias	string	The name of the account to which the AccessKey pair belongs. Note This parameter is returned only for third-party host assets. If the value is empty, this parameter is not returned.	test

Examples

Success response

JSON format

{
  "RequestId": "4892B68B-47BC-5E56-B327-9C2ACC6C1C09",
  "AssetDetail": {
    "CpuInfo": "Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz",
    "InternetIp": "120.47.XX.XX",
    "OsDetail": "Linux 64bit",
    "CreateTime": 1603863599000,
    "Kernel": "4.18.0-80.11.2.el8_0.x86_64",
    "Bind": true,
    "OsName": "CentOS  7.4 64bit",
    "Tag": "InternetIp",
    "ClientStatus": "online",
    "Mem": 16,
    "Memory": 16384,
    "VpcInstanceId": "vpc-bp1fs3bwonlfq503w****",
    "AuthVersion": 7,
    "InstanceName": "i-fasdfasdfadfafa****",
    "Region": "cn-shanghai",
    "GroupTrace": "default",
    "Ip": "120.47.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": [
      "120.47.XX.XX"
    ],
    "MacList": [
      "00:16:3*:1*:9*:cf"
    ],
    "DiskInfoList": [
      {
        "DiskName": "/dev/vda1",
        "UseSizeByte": 2998996992,
        "TotalSize": 40,
        "UseSize": 2,
        "TotalSizeByte": 42140479488
      }
    ],
    "ClientSubStatus": "online",
    "VendorAuthAlias": "test"
  }
}

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.