All Products
Search
Document Center

Security Center:DescribeAssetDetailByUuid

更新時間:Nov 22, 2024
This API is deprecated. You are advised to use Sas(2018-12-03) - GetAssetDetailByUuid.

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

Operation description

This operation will be discontinued soon. You must call the GetAssetDetailByUuid operation to query the details 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.

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:DescribeAssetDetailByUuidget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SourceIpstringNo

The source IP address of the request.

192.0.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
RequestIdstring

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

39031E31-6BBA-5C99-A870-D807E78918CD
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.

192.168.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: yes
  • false: no
true
OsNamestring

The name of the operating system.

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

The memory size of the server. Unit: GB.

32
Memorylong

The memory size of the server. Unit: MB.

512
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 (Unauthorized)
  • 6: Anti-virus edition
  • 5: Advanced edition
  • 3: Enterprise edition
  • 7: Ultimate edition
7
InstanceNamestring

The name of the server.

i-fasdfasdfadfafa****
Regionstring

The region in which the server resides.

cn-hangzhou-dg-a01
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.

192.168.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 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
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: yes
  • 1: no
0
ClientVersionstring

The version of the Security Center agent.

2.0.0
IpListarray

The IP addresses of the server.

Ipstring

The IP addresses of the server.

["192.168.XX.XX"]
MacListarray

The media access control (MAC) addresses of the server.

Macstring

The MAC addresses of the server.

["00:16:3*:1*:9*:cf"]
DiskInfoListarray

An array that consists of the information about the disk.

DiskInfostring

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 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
2024-07-30The API operation is deprecated. The Error code has changedView Change Details
2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details