All Products
Search
Document Center

Security Center:ListCloudAssetInstances

Last Updated:Nov 13, 2024

Queries cloud service assets.

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

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID of the instance.

cn-hangzhou
CriteriastringNo

The search conditions for assets. The value of this parameter is in the JSON format and contains the following fields:

  • name: the name of the search condition.

  • value: the value of the search condition.

  • logicalExp: the logical relation for multiple search conditions. Valid values:

    • OR: The search conditions use a logical OR.
    • AND: The search conditions use a logical AND.
Note You can call the GetCloudAssetCriteria operation to query supported search conditions.
[{\"name\":\"internetIp\",\"value\":\"192.168\",\"logicalExp\":\"OR\"}]
LogicalExpstringNo

The logical relation for multiple search conditions. Valid values:

  • OR: The search conditions use a logical OR.
  • AND: The search conditions use a logical AND.
OR
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 20.

20
CurrentPageintegerNo

The number of the page to return.

2
CloudAssetTypesarray<object>No

The details of the cloud asset.

objectNo

The cloud service asset.

AssetTypeintegerNo

The type of the cloud asset.

You can call the GetCloudAssetCriteria operation to query the cloud asset type.

18
AssetSubTypeintegerNo

The subtype of the cloud asset.

You can call the GetCloudAssetCriteria operation to query the subtype of the cloud asset.

0
VendorintegerNo

The server type. Valid values:

  • 0: a cloud asset provided by Alibaba Cloud
  • 1: a cloud asset outside Alibaba Cloud
  • 2: a cloud asset in a data center
  • 3, 4, 5, and 7: a cloud asset provided by a third-party service provider
  • 8: a lightweight cloud asset
0

Response parameters

ParameterTypeDescriptionExample
object
Successboolean

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
RequestIdstring

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

028CF634-5268-5660-9575-48C9ED6BF880
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

2
PageSizeinteger

The number of entries returned per page.

100
TotalCountinteger

The total number of cloud assets.

69
Countinteger

The number of entries returned on the current page.

20
Instancesarray<object>

The details of the cloud assets.

Instancesobject

The details of the cloud asset.

RegionIdstring

The ID of the region to which the cloud asset belongs.

cn-hanghzou
Vendorinteger

The service provider (SP) of the cloud asset. Valid values:

  • 0: a cloud asset provided by Alibaba Cloud
  • 1: a third-party cloud asset
  • 2: a cloud asset in a data center
  • 3, 4, 5, and 7: other cloud asset
  • 8: a lightweight cloud asset
0
AssetTypeinteger

The type of the cloud asset. Valid values:

  • 0: Elastic Compute Service (ECS)
  • 1: Server Load Balancer (SLB)
  • 3: ApsaraDB RDS
  • 4: ApsaraDB for MongoDB
  • 5: ApsaraDB for Redis
  • 6: Container Registry
  • 8: Container Service for Kubernetes (ACK)
  • 9: Virtual Private Cloud (VPC)
  • 11: ActionTrail
  • 12: Alibaba Cloud CDN
  • 13: Certificate Management Service (formerly SSL Certificates Service)
  • 14: Apsara Devops
  • 16: Anti-DDoS
  • 17: Web Application Firewall (WAF)
  • 18: Object Storage Service (OSS)
  • 19: PolarDB
  • 20: ApsaraDB RDS for PostgreSQL
  • 21: Microservices Engine (MSE)
  • 22: File Storage NAS (NAS)
  • 23: Data Security Center (DSC)
  • 24: Elastic IP Address (EIP)
  • 25: Identity as a Service (IDaaS) Employee Identity and Access Management (EIAM)
  • 26: PolarDB-X
  • 27: Elasticsearch
0
AssetSubTypestring

The subtype of the cloud service. The subtype of the cloud asset. Valid values:

  • 0: ECS

    • 0: instance
    • 1: disk (storage)
    • 2: security group
  • 1: SLB

    • 0: SLB
    • 1: Application Load Balancer (ALB)
  • 3: ApsaraDB RDS

    • 0: instance
  • 4: ApsaraDB for MongoDB

    • 0: instance
  • 5: ApsaraDB for Redis

    • 0: instance
  • 6: Container Registry

    • 1: Enterprise Edition
    • 2: Personal Edition
  • 8: ACK

    • 0: cluster
  • 9: VPC

    • 0: NAT gateway
    • 1: EIP
    • 2: VPN
    • 3: FLOW_LOG
  • 11: ActionTrail

    • 0: trail
  • 12: Alibaba Cloud CDN

    • 0: instance
  • 13: Certificate Management Service (formerly SSL Certificates Service)

    • 0: certificate
  • 14: Apsara Devops

    • 0: organization
  • 16: Anti-DDoS

    • 0: instance
  • 17: WAF

    • 0: domain name
  • 18: OSS

    • 0: bucket
  • 19: PolarDB

    • 0: cluster
  • 20: ApsaraDB RDS for PostgreSQL

    • 0: instance
  • 21: MSE

    • 0: cluster
  • 22: NAS

    • 0: file system
  • 23: DSC

    • 0: instance
  • 24: EIP

    • 0: Anycast EIP
  • 25: IDaaS EIAM

    • 0: instance
  • 26: PolarDB-X

    • 0: instance
  • 27: Elasticsearch

    • 0: instance
0
InstanceIdstring

The instance ID of the cloud asset.

d-uf60vevzkztnflx7cny5
InstanceNamestring

The instance name of the cloud asset.

yztest-l***
CreatedTimelong

The time when the instance was created.

1607365213000
InternetIpstring

The public IP address of the cloud asset.

1.2.XX.XX
AlarmStatusstring

Indicates whether alerts are generated for the cloud asset. Valid values:

  • YES
  • NO
NO
RiskStatusstring

Indicates whether risks are detected on the cloud asset. Valid values:

  • YES
  • NO
NO
AssetTypeNamestring

The type name of the cloud asset.

ECS
AssetSubTypeNamestring

The subtype name of the cloud asset.

SECURITY_GROUP
SecurityInfostring

The security information about the cloud asset.

{"seriousNum":0,"appNum":0,"baselineMedium":0,"remindNum":0,"imageVulNntf":0,"cveNum":0,"vul":0,"uuid":"yuejia-test","emgNum":0,"weakPWNum":0,"imageMaliciousFileRemind":0,"imageBaselineMedium":0,"laterVulCount":0,"cmsNum":0,"imageMaliciousFileSerious":0,"agentlessMalicious":0,"suspNum":0,"imageBaselineHigh":0,"asapVulCount":0,"imageVulLater":0,"agentlessAll":0,"sysNum":0,"containerLater":0,"containerSuspicious":0,"imageBaselineNum":0,"newSuspicious":0,"nntfVulCount":0,"scaNum":0,"containerNntf":0,"health":0,"trojan":0,"suspicious":0,"imageMaliciousFileSuspicious":0,"containerRemind":0,"baselineLow":0,"imageVulAsap":0,"imageBaselineLow":0,"containerAsap":0,"agentlessBaseline":0,"agentlessVulSca":0,"agentlessVulCve":0,"containerSerious":0,"baselineHigh":0,"account":0,"baselineNum":5}

Examples

Sample success responses

JSONformat

{
  "Success": true,
  "RequestId": "028CF634-5268-5660-9575-48C9ED6BF880",
  "PageInfo": {
    "CurrentPage": 2,
    "PageSize": 100,
    "TotalCount": 69,
    "Count": 20
  },
  "Instances": [
    {
      "RegionId": "cn-hanghzou",
      "Vendor": 0,
      "AssetType": 0,
      "AssetSubType": "0",
      "InstanceId": "d-uf60vevzkztnflx7cny5",
      "InstanceName": "yztest-l***",
      "CreatedTime": 1607365213000,
      "InternetIp": "1.2.XX.XX",
      "AlarmStatus": "NO",
      "RiskStatus": "NO",
      "AssetTypeName": "ECS",
      "AssetSubTypeName": "SECURITY_GROUP",
      "SecurityInfo": "{\"seriousNum\":0,\"appNum\":0,\"baselineMedium\":0,\"remindNum\":0,\"imageVulNntf\":0,\"cveNum\":0,\"vul\":0,\"uuid\":\"yuejia-test\",\"emgNum\":0,\"weakPWNum\":0,\"imageMaliciousFileRemind\":0,\"imageBaselineMedium\":0,\"laterVulCount\":0,\"cmsNum\":0,\"imageMaliciousFileSerious\":0,\"agentlessMalicious\":0,\"suspNum\":0,\"imageBaselineHigh\":0,\"asapVulCount\":0,\"imageVulLater\":0,\"agentlessAll\":0,\"sysNum\":0,\"containerLater\":0,\"containerSuspicious\":0,\"imageBaselineNum\":0,\"newSuspicious\":0,\"nntfVulCount\":0,\"scaNum\":0,\"containerNntf\":0,\"health\":0,\"trojan\":0,\"suspicious\":0,\"imageMaliciousFileSuspicious\":0,\"containerRemind\":0,\"baselineLow\":0,\"imageVulAsap\":0,\"imageBaselineLow\":0,\"containerAsap\":0,\"agentlessBaseline\":0,\"agentlessVulSca\":0,\"agentlessVulCve\":0,\"containerSerious\":0,\"baselineHigh\":0,\"account\":0,\"baselineNum\":5}"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400AccountIdNotExistAccountId not exist-
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
2023-09-20The Error code has changedView Change Details