All Products
Search
Document Center

Security Center:DescribeAssetDetailByUuids

Last Updated:Feb 20, 2024

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

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

Request parameters

ParameterTypeRequiredDescriptionExample
UuidsstringYes

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

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

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

92016EC8-D52D-49D8-9FF7-9EA340A950B9
AssetListobject []

An array that consists of the details of the ECS instances.

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

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

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.-
500ServerErrorServerError-

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

Change history

Change timeSummary of changesOperation
2023-07-20The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
    Added Error Codes: 500
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceDirectoryAccountId
2022-12-23API Description Update. The API operation is not deprecated.. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
API Deprecation DescriptionThe API operation is not deprecated..
Error CodesThe Error code has changed.
    delete Error Codes: 400