All Products
Search
Document Center

Security Center:GetAssetDetailByUuid

Last Updated:Feb 20, 2024

Queries the details of a server and the extended information about the 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:GetAssetDetailByUuidRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request. The system specifies this parameter.

120.245.XX.XX
UuidstringYes

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****
LangstringNo

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

  • zh: Chinese
  • en: English
zh

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

4892B68B-47BC-5E56-B327-9C2ACC6C1C09
AssetDetailobject

The details of the server.

CpuInfostring

The details of the CPU.

Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz
InternetIpstring

The public IP address of the server.

120.47.XX.XX
OsDetailstring

The operating system version of the server.

Linux 64bit
CreateTimelong

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

1603863599000
Kernelstring

The kernel version of the operating system.

4.18.0-80.11.2.el8_0.x86_64
Bindboolean

Indicates whether Security Center is authorized to protect the asset. Valid values:

  • true: Security Center is authorized to protect the asset.
  • false: Security Center is not authorized to protect the asset.
true
OsNamestring

The name of the operating system that the server runs.

CentOS 7.4 64bit
Tagstring

The tag that is added to the server.

InternetIp
ClientStatusstring

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.
online
Meminteger

The memory size of the server. Unit: GB.

16
Memorylong

The memory size of the server. Unit: MB.

16384
VpcInstanceIdstring

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

vpc-bp1fs3bwonlfq503w****
AuthVersioninteger

The edition of Security Center that is authorized to protect the asset. Valid values:

  • 1: Basic edition
  • 6: Anti-virus edition
  • 5: Advanced edition
  • 3: Enterprise edition
  • 7: Ultimate edition
  • 10: Value-added Plan edition
7
InstanceNamestring

The name of the server.

i-fasdfasdfadfafa****
Regionstring

The region in which the server resides.

cn-shanghai
GroupTracestring

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

default
Ipstring

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

120.47.XX.XX
HostNamestring

The name of the host.

qewrqwerqs****
Osstring

The operating system type of the server.

linux
AuthModifyTimelong

The timestamp when Security Center is authorized to protect the asset. Unit: milliseconds.

1627974044000
InstanceIdstring

The ID of the server.

i-uf6h7p2fgk6rkk0g****
IntranetIpstring

The private IP address of the server.

192.168.XX.XX
AssetTypestring

The type of the server. Valid values:

  • 0: ECS instance
  • 1: Server Load Balancer (SLB) instance
  • 2: NAT gateway
  • 3: ApsaraDB RDS instance
  • 4: ApsaraDB for MongoDB instance
  • 5: ApsaraDB for Redis instance
  • 6: image
  • 7: container
0
RegionIdstring

The ID of the region in which the asset resides.

cn-hanghzou
SysInfostring

The operating system information about the server.

CentOS Linux 8.0.1905
Uuidstring

The UUID of the server.

9e6cad93-a379-46fd-a701-9bbf02f4****
Cpuinteger

The number of CPU cores.

2
RegionNamestring

The name of the region in which the server resides.

China (Hohhot)
Flaginteger

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

  • 0: The server is provided by Alibaba Cloud.
  • 1: The server is not provided by Alibaba Cloud.
0
ClientVersionstring

The version of the Security Center agent.

2.0.0
IpListarray

An array that consists of the IP addresses of the server.

string

The IP address of the server.

120.47.XX.XX
MacListarray

An array that consists of the media access control (MAC) addresses of the server.

string

The MAC addresses of the server.

00:16:3*:1*:9*:cf
DiskInfoListobject []

The list of information about the disk.

DiskNamestring

The name of the disk.

/dev/vda1
UseSizeBytelong

The amount of the used disk space. Unit: bytes.

2998996992
TotalSizelong

The total disk space. Unit: GB.

40
UseSizelong

The amount of the used disk space. Unit: GB.

2
TotalSizeBytelong

The total disk space. Unit: bytes.

42140479488

Examples

Sample success responses

JSONformat

{
  "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
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
400NoPermissionno permission-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
No change history