Queries the details about a server by using the UUID of the server.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeAssetDetailByUuid

The operation that you want to perform. Set the value to DescribeAssetDetailByUuid.

SourceIp String No 192.0.XX.XX

The source IP address of the request.

Uuid String Yes 9e6cad93-a379-46fd-a701-9bbf02f4****

The UUID of the server to query.

Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of servers.
Lang String No zh

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English

All Alibaba Cloud API operations must include common request parameters. For more information about common request parameters, see Common parameters.

For more information about sample requests, see the "Examples" section of this topic.

Response parameters

Parameter Type Example Description
RequestId String 39031E31-6BBA-5C99-A870-D807E78918CD

The ID of the request, which is used to locate and troubleshoot issues.

AssetDetail Object

The details about the server.

CpuInfo String Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz

The details about the CPU.

InternetIp String 192.168.XX.XX

The public IP address of the server.

OsDetail String Linux 64bit

The operating system version of the server.

CreateTime Long 1603863599000

The timestamp when Security Center records the details about the server. Unit: milliseconds.

Kernel String 4.18.0-80.11.2.el8_0.x86_64

The kernel version of the operating system.

Bind Boolean true

Indicates whether Security Center is authorized to scan the server. Valid values:

  • true: Security Center is authorized to scan the server.
  • false: Security Center is not authorized to scan the server.
OsName String CentOS 8.0 64-bit

The name of the operating system that the server runs.

Tag String InternetIp

The tag of the server.

ClientStatus String online

The status of the Security Center agent. Valid values:

  • pause: The Security Center agent stops protecting your server.
  • online: The Security Center agent is protecting your server.
  • offline: The Security Center agent does not protect your server.
Mem Integer 32

The memory size of the server. Unit: GB.

Memory Long 512

The memory size of the server. Unit: MB.

VpcInstanceId String vpc-bp1fs3bwonlfq503w****

The ID of the virtual private cloud (VPC) in which the server resides.

AuthVersion Integer 7

The edition of Security Center that is authorized to scan the server. Valid values:

  • 1: Basic edition
  • 6: Anti-virus edition
  • 5: Advanced edition
  • 3: Enterprise edition
  • 7: Ultimate edition
  • 10: Value-added Plan edition
InstanceName String i-fasdfasdfadfafa****

The name of the server.

Region String cn-hangzhou-dg-a01

The region in which the server resides.

GroupTrace String Ungrouped

The group to which the server belongs. By default, the servers that are not grouped belong to Ungrouped.

Ip String 192.168.XX.XX

The IP address that is assigned to the Elastic Compute Service (ECS) instance.

HostName String qewrqwerqs****

The name of the server.

Os String linux

The operating system type of the server.

AuthModifyTime Long 1627974044000

The timestamp when Security Center is authorized to scan the server. Unit: milliseconds.

InstanceId String i-uf6h7p2fgk6rkk0g****

The ID of the server.

IntranetIp String 192.168.XX.XX

The private IP address of the server.

AssetType String 0

The type of the server. 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
RegionId String cn-hanghzou

The ID of the region in which the server resides.

SysInfo String CentOS Linux 8.0.1905

The operating system information about the server.

Uuid String 9e6cad93-a379-46fd-a701-9bbf02f4****

The UUID of the server.

Cpu Integer 2

The number of CPU cores.

RegionName String China (Hangzhou)

The name of the region in which the server resides.

Flag Integer 0

Indicates whether the server is provided by Alibaba Cloud. Valid values:

  • 0: yes
  • 1: no
ClientVersion String 2.0.0

The version of the Security Center agent.

IpList Array of String ["192.168.XX.XX"]

The IP addresses of the server.

MacList Array of String ["00:16:3*:1*:9*:cf"]

The MAC address.

DiskInfoList Array of String [ { "diskName": "/dev/vda1", "totalSize": 20, "useSize": 2 } ]

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.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeAssetDetailByUuid
&SourceIp=192.0.XX.XX
&Uuid=9e6cad93-a379-46fd-a701-9bbf02f4****
&Lang=zh
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeAssetDetailByUuidResponse>
    <RequestId>39031E31-6BBA-5C99-A870-D807E78918CD</RequestId>
    <AssetDetail>
        <CpuInfo>Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz</CpuInfo>
        <InternetIp>192.168.XX.XX</InternetIp>
        <OsDetail>Linux 64bit</OsDetail>
        <CreateTime>1603863599000</CreateTime>
        <Kernel>4.18.0-80.11.2.el8_0.x86_64</Kernel>
        <Bind>true</Bind>
        <OsName>CentOS 8.0 64-bit</OsName>
        <Tag>InternetIp</Tag>
        <ClientStatus>online</ClientStatus>
        <Mem>32</Mem>
        <Memory>512</Memory>
        <VpcInstanceId>vpc-bp1fs3bwonlfq503w****</VpcInstanceId>
        <AuthVersion>7</AuthVersion>
        <InstanceName>i-fasdfasdfadfafa****</InstanceName>
        <Region>cn-hangzhou-dg-a01</Region>
        <GroupTrace>Ungrouped</GroupTrace>
        <Ip>192.168.XX.XX</Ip>
        <HostName>qewrqwerqs****</HostName>
        <Os>linux</Os>
        <AuthModifyTime>1627974044000</AuthModifyTime>
        <InstanceId>i-uf6h7p2fgk6rkk0g****</InstanceId>
        <IntranetIp>192.168.XX.XX</IntranetIp>
        <AssetType>0</AssetType>
        <RegionId>cn-hanghzou</RegionId>
        <SysInfo>CentOS Linux 8.0.1905</SysInfo>
        <Uuid>9e6cad93-a379-46fd-a701-9bbf02f4****</Uuid>
        <Cpu>2</Cpu>
        <RegionName>China (Hangzhou)</RegionName>
        <Flag>0</Flag>
        <ClientVersion>2.0.0</ClientVersion>
        <IpList>["192.168.XX.XX"]</IpList>
        <MacList>["00:16:3*:1*:9*:cf"]</MacList>
        <DiskInfoList>[ { "diskName": "/dev/vda1", "totalSize": 20, "useSize": 2 } ]</DiskInfoList>
    </AssetDetail>
</DescribeAssetDetailByUuidResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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" : "CentOS 8.0 64-bit",
    "Tag" : "InternetIp",
    "ClientStatus" : "online",
    "Mem" : 32,
    "Memory" : 512,
    "VpcInstanceId" : "vpc-bp1fs3bwonlfq503w****",
    "AuthVersion" : 7,
    "InstanceName" : "i-fasdfasdfadfafa****",
    "Region" : "cn-hangzhou-dg-a01",
    "GroupTrace" : "Ungrouped",
    "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 (Hangzhou)",
    "Flag" : 0,
    "ClientVersion" : "2.0.0",
    "IpList" : [ "[\"192.168.XX.XX\"]" ],
    "MacList" : [ "[\"00:16:3*:1*:9*:cf\"]" ],
    "DiskInfoList" : [ "[ { \"diskName\": \"/dev/vda1\", \"totalSize\": 20, \"useSize\": 2 } ]" ]
  }
}

Error codes

HTTP status code Error code Error message Description
400 NoPermission no permission The error message returned because you do not have access permissions.
500 ServerError ServerError The error message returned because a server error occurred.

For a list of error codes, visit the API Error Center.