Call ListCloudAssetInstances to query cloud assets - Security Center - Alibaba Cloud - Security Center

Queries the list of cloud service assets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListCloudAssetInstances

get

*All Resources

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region where the instance resides.	cn-hangzhou
Criteria	string	No	The conditions used to search for assets. This parameter is in JSON format and contains the following fields: name: the search item. value: the value of the search item. logicalExp: the logical relationship between multiple search item values. Valid values: OR: indicates that multiple search item values have an OR relationship. AND: indicates that multiple search item values have an AND relationship. Note You can call the GetCloudAssetCriteria operation to query the supported search conditions.	[{\"name\":\"internetIp\",\"value\":\"192.168\",\"logicalExp\":\"OR\"}]
LogicalExp	string	No	The logical relationship between multiple search conditions. Valid values: OR: indicates that multiple search conditions have an OR relationship. AND: indicates that multiple search conditions have an AND relationship.	OR
PageSize	integer	No	The maximum number of rows that can be displayed per page. Maximum value: 100. Default value: 20.	20
CurrentPage	integer	No	The number of the current page to return in paginated queries.	2
CloudAssetTypes	array<object>	No	The list of assets of the cloud asset instance.
	object	No	The asset of the cloud asset instance.
AssetType	integer	No	The type of the cloud asset. Note For details, refer to AssetType in the GetCloudAssetCriteria operation.	18
AssetSubType	integer	No	The subtype of the cloud service. Note For details, refer to AssetSubType in the GetCloudAssetCriteria operation.	0
Vendor	integer	No	The server vendor. Valid values: 0: Alibaba Cloud asset 1: Off-cloud asset 2: IDC asset 3, 4, 5, 7: Other cloud assets 8: Lightweight asset	0
CloudAssetQueryData	array<object>	No	The data list queried by keyword.
	object	No
Data	string	No	The query content.	163.8.8.9
Operator	string	No	The query operator. Currently, only INCLUDE is supported.	INCLUDE
IsSaleData	boolean	No

Response elements

Element	Type	Description	Example
	object
Success	boolean	Indicates whether the API call was successful. Valid values: true: The API call was successful. false: The API call failed.	true
RequestId	string	The ID of this request, which is a unique identifier generated by Alibaba Cloud for the request. It can be used to troubleshoot and locate issues.	028CF634-5268-5660-9575-48C9ED6BF880
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in paginated queries.	2
PageSize	integer	The page size.	100
TotalCount	integer	The total number of cloud assets.	69
Count	integer	The number of data entries displayed on the current page.	20
Instances	array<object>	The list of detailed cloud asset information.
	object	The detailed cloud asset information.
RegionId	string	The ID of the region to which the asset instance belongs.	cn-hanghzou
Vendor	integer	The server vendor. Valid values: 0: Alibaba Cloud asset 1: Off-cloud asset 2: IDC asset 3, 4, 5, 7: Other cloud assets 8: Lightweight asset	0
AssetType	integer	The type of the asset. Valid values: 0: Elastic Compute Service (ECS) 1: Server Load Balancer (SLB) 3: ApsaraDB RDS 4: ApsaraDB for MongoDB 5: ApsaraDB for Tair (compatible with 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: Apsara File Storage NAS 23: Data Security Center (DSC) 24: Elastic IP Address (EIP) 25: Identity as a Service - EIAM 26: PolarDB-X 27: Elasticsearch	0
AssetSubType	string	The subtype of the cloud service. The asset type-subtype. Valid values: 0: Elastic Compute Service (ECS) 0: Instance 1: Disk (storage) 2: Security group 1: Server Load Balancer (SLB) 0: Server Load Balancer 1: Application Load Balancer 3: ApsaraDB RDS 0: Instance 4: ApsaraDB for MongoDB 0: Instance 5: ApsaraDB for Tair (compatible with Redis) 0: Instance 6: Container Registry 1: Enterprise Edition 2: Personal Edition 8: Container Service for Kubernetes (ACK) 0: Cluster 9: Virtual Private Cloud (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: Web Application Firewall (WAF) 0: Domain name 18: Object Storage Service (OSS) 0: Bucket 19: PolarDB 0: Cluster 20: ApsaraDB RDS for PostgreSQL 0: Instance 21: Microservices Engine (MSE) 0: Cluster 22: Apsara File Storage NAS 0: File system 23: Data Security Center (DSC) 0: Instance 24: Elastic IP Address (EIP) 0: Anycast EIP 25: Identity as a Service - EIAM 0: Instance 26: PolarDB-X 0: Instance 27: Elasticsearch 0: Instance	0
InstanceId	string	The ID of the cloud asset instance.	d-uf60vevzkztnflx7cny5
InstanceName	string	The instance name of the asset.	yztest-l***
CreatedTime	integer	The time when the instance was created.	1607365213000
InternetIp	string	The public IP address of the instance.	1.2.XX.XX
AlarmStatus	string	Indicates whether the cloud asset has security alerts. Valid values: YES: Security alerts exist. NO: No security alerts exist.	NO
RiskStatus	string	Indicates whether the cloud asset has security risks. Valid values: YES: Exists. NO: Does not exist.	NO
AssetTypeName	string	The name of the cloud asset type.	ECS
AssetSubTypeName	string	The name of the cloud asset subtype.	SECURITY_GROUP
SecurityInfo	string	The security information of 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}
Tags	array	The tag list.
	string	The tag.	AI
VendorUid	string	The account ID of the multi-cloud instance.	123xxx
VendorUserName	string	The username of the multi-cloud instance.	testxxx
SaleCspm	integer
AssetUuid	string
SaleType	integer

Examples

Success response

JSON format

{
  "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}",
      "Tags": [
        "AI"
      ],
      "VendorUid": "123xxx",
      "VendorUserName": "testxxx",
      "SaleCspm": 0,
      "AssetUuid": "",
      "SaleType": 0
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	AccountIdNotExist	AccountId not exist
400	NoPermission	no permission
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.