All Products
Search
Document Center

Security Center:DescribeAssetDetailByUuids

Last Updated:Nov 25, 2024

Queries the details of Elastic Compute Service (ECS) instances.

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

Request parameters

ParameterTypeRequiredDescriptionExample
UuidsstringYes

The UUIDs of the instances. Separate multiple UUIDs with commas (,).

Note You can call the DescribeCloudCenterInstances operation to query the UUIDs of instances.
0687b17f-2a36-4e5****,0687b17f-2a36-4e****
LangstringNo

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

  • zh: Chinese
  • en: English
zh
ResourceDirectoryAccountIdlongNo

The Alibaba Cloud account ID of the member in the resource directory.

Note You can call the DescribeMonitorAccounts operation to query the IDs of Alibaba Cloud accounts.
127608589417****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

92016EC8-D52D-49D8-9FF7-9EA340A950B9
AssetListarray<object>

An array that consists of the details of the instances.

Assetobject

The details of the instance.

InternetIpstring

The public IP address of the ECS instance.

10.10.XX.XX
OsNamestring

The name of the operating system run by the ECS instance.

CentOS 7.6 64-bit
Ipstring

The IP address of the ECS instance.

Note If the ECS instance has a public IP address, the value of this parameter is the public IP address of the ECS instance. If the ECS instance does not have a public IP address, the value of this parameter is the private IP address of the ECS instance.
10.10.XX.XX
Osstring

The operating system of the ECS instance.

Linux
InstanceIdstring

The ID of the ECS instance.

i-rj9gda4wolo0zixi****
ClientStatusstring

The status of the Security Center agent. Valid values:

  • online
  • offline
online
VpcInstanceIdstring

The ID of the virtual private cloud (VPC).

13231-331331
IntranetIpstring

The private IP address of the ECS instance.

192.168.XX.XX
AssetTypestring

The type of the asset.

The value is fixed as 0, which indicates ECS instances.

0
RegionIdstring

The region in which the ECS instance resides.

Note For more information about the mapping between region IDs and region names, see Regions and zones.
cn-shanghai
Uuidstring

The UUID of the ECS instance.

2a98f149-0256-414c-a29a-a69f8a75****
Flaginteger

The type of the asset by source. Valid values:

  • 0: The asset is provided by Alibaba Cloud.
  • 1: The asset is not provided by Alibaba Cloud.
  • 2: The asset resides in a data center.
  • 3, 4, 5, and 7: other cloud asset.
  • 8: light-weight assets.
0
RegionNamestring

The name of the region in which the ECS instance resides.

cn-shenzhen
InstanceNamestring

The name of the ECS instance.

TestInstanceName
Regionstring

The region in which the ECS instance resides.

cn-guangzhou
CpuInfostring

The details of the CPU.

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

The operating system version of the instance.

Linux 64bit
CreateTimelong

The timestamp when Security Center records the details of the instance. 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 instance. Valid values:

  • true
  • false
true
Tagstring

The tag added to the instance.

test
Meminteger

The memory size of the instance. Unit: GB.

4
Memorylong

The memory size of the instance. Unit: MB.

1024
AuthVersioninteger

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

  • 1: Basic edition (Unauthorized)
  • 6: Anti-virus edition
  • 5: Advanced edition
  • 3: Enterprise edition
  • 7: Ultimate edition
7
GroupTracestring

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

default
HostNamestring

The hostname.

test
AuthModifyTimelong

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

1627974044000
SysInfostring

The operating system information about the instance.

CentOS Linux 8.0.1905
Cpuinteger

The number of CPU cores.

4
ClientVersionstring

The version of the Security Center agent.

2.0.0
IpListarray

The IP addresses of the instances.

IpListArrstring

The IP address of the instance.

192.168.XX.XX
MacListarray

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

MacListArrstring

The MAC address of the instance.

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": "92016EC8-D52D-49D8-9FF7-9EA340A950B9",
  "AssetList": [
    {
      "InternetIp": "10.10.XX.XX",
      "OsName": "CentOS 7.6 64-bit\n",
      "Ip": "10.10.XX.XX",
      "Os": "Linux",
      "InstanceId": "i-rj9gda4wolo0zixi****",
      "ClientStatus": "online",
      "VpcInstanceId": "13231-331331",
      "IntranetIp": "192.168.XX.XX",
      "AssetType": "0",
      "RegionId": "cn-shanghai",
      "Uuid": "2a98f149-0256-414c-a29a-a69f8a75****",
      "Flag": 0,
      "RegionName": "cn-shenzhen",
      "InstanceName": "TestInstanceName",
      "Region": "cn-guangzhou",
      "CpuInfo": "Intel(R) Xeon(R) Platinum 8163 CPU @ 2.50GHz",
      "OsDetail": "Linux 64bit",
      "CreateTime": 1603863599000,
      "Kernel": "4.18.0-80.11.2.el8_0.x86_64",
      "Bind": true,
      "Tag": "test",
      "Mem": 4,
      "Memory": 1024,
      "AuthVersion": 7,
      "GroupTrace": "default",
      "HostName": "test",
      "AuthModifyTime": 1627974044000,
      "SysInfo": "CentOS Linux 8.0.1905",
      "Cpu": 4,
      "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
400IllegalParamIllegal param-
400RdCheckNoPermissionResource directory account verification has no permission.-
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500RdCheckInnerErrorResource directory account service internal error.-
500GetAssetDetailFailAsset detail service has failed due to some unknown error.An error occurred while processing the get asset details request. Please try again later. If the error persists, submit the ticket.
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2024-10-15The Error code has changedView Change Details
2024-10-11API Description Update. The Error code has changed. The response structure of the API has changedView Change Details
2023-07-20The Error code has changed. The request parameters of the API has changedView Change Details
2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedView Change Details