DescribeCloudCenterInstances API Overview - Security Center - Alibaba Cloud - Security Center

Queries asset information by settings conditional query criteria, such as asset instance name or asset instance region. Both paging and NextToken methods are supported. The NextToken method is recommended.

Operation description

You can search for assets by instance ID, instance name, VPC ID, region, public IP address, and other conditions. You can also set logical relationships between different search conditions to search for assets that meet multiple criteria.

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:DescribeCloudCenterInstances

get

*Asset

acs:yundun-sas:{#regionId}:{#accountId}:asset/*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId `deprecated`	string	No	The region ID of the instance to query.	cn-hangzhou
Criteria	string	No	The conditions for searching assets. This parameter is in JSON format. Note that the parameter values are case-sensitive. Note You can search for assets by instance ID, instance name, VPC ID, region, public IP address, and other conditions. Call the DescribeCriteria operation to query the supported search conditions.	[{"name":"riskStatus","value":"YES"},{"name":"internetIp","value":"1.2.XX.XX"}]
MachineTypes	string	No	The type of asset to query. Valid values: ecs: server. cloud_product: cloud product. eci: elastic container instance. rund: RunD container instance. runc: RunC container instance.	ecs
LogicalExp	string	No	The logical relationship between multiple search conditions. Default value: OR. Valid values: OR: The search conditions have an OR relationship. AND: The search conditions have an AND relationship.	OR
PageSize	integer	No	The number of assets to display on each page in a paged conditional query. Default value: 20, which indicates that 20 asset records are displayed on each page.	100
CurrentPage	integer	No	The page number of the first page to return. Default value: 1, which indicates that the query results are returned starting from page 1.	1
Importance	integer	No	The importance level of the asset. Valid values: 2: Important asset. 1: General asset. 0: Test asset.	2
NoGroupTrace	boolean	No	Specifies whether to disable internationalization for the default group name 未分组. Default value: false. Valid values: true: Internationalization is disabled. If the value of the GroupTrace response parameter is the default Security Center group 未分组, the value is still displayed as 未分组. false: Internationalization is enabled. If the value of the GroupTrace response parameter is the default Security Center group 未分组, the value is displayed as default.	false
Lang	string	No	The language of the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
UseNextToken	boolean	No	Specifies whether to use the NextToken method to retrieve asset list data. If this parameter is set to true, TotalCount is no longer returned. Valid values: true: Uses the NextToken method. false: Does not use the NextToken method.	false
NextToken	string	No	The NextToken value returned when the NextToken method is used. Leave this parameter empty for the first request.	E17B501887A2D3AA5E8360A6EFA3B***
ResourceDirectoryAccountId	integer	No	The ID of the Alibaba Cloud account that corresponds to the member account in the resource directory. Note Call the DescribeMonitorAccounts operation to obtain this parameter.	1232428423234****
Flags	string	No	The asset vendor. Separate multiple asset vendors with commas (,). Valid values:	1,2,3

Response elements

Element	Type	Description	Example
	object
Success	boolean	The result status of the API call. Valid values: true: The API call was successful. false: The API call failed.	true
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for the request. You can use this ID to troubleshoot issues.	32A73759-4C0F-4801-BE98-901223ACEE9A
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the current page in a paging query.	1
PageSize	integer	The number of assets displayed per page in a paging query. Default value: 20, which indicates that 20 asset records are displayed per page.	20
TotalCount	integer	The total number of assets returned by the query.	50
Count	integer	The number of assets displayed on the current page.	10
NextToken	string	The value of NextToken returned when the NextToken-based pagination method is used.	B604532DEF982B875E8360A6EFA3B***
Instances	array<object>	The list of asset details.
	object	The asset details.
Status	string	The running status of the instance. Valid values: Running: Running. notRunning: Stopped.	Running
CpuInfo	string	The CPU information of the asset.	Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz
InternetIp	string	The public IP address of the instance.	1.2.XX.XX
Kernel	string	The kernel version information.	3.10.0-1127.19.1.el7.x86_64
Bind	boolean	Indicates whether the asset is bound to an authorization. Valid values:	true
OsName	string	The kernel version of the instance.	-
Tag	string	The tag name of the asset instance.	InternetIp,test
ClientStatus	string	The online status of the client on the instance. Valid values:	online
Mem	integer	The memory size, in MB.	1024
VpcInstanceId	string	The ID of the VPC to which the instance belongs.	vpc-uf60agqq65bs98zoo****
TagId	string	The tag ID of the asset.	121313,41412
Flag	integer	Indicates whether the instance is an Alibaba Cloud asset. Valid values:	0
LastLoginTimestamp	integer	The timestamp when the client last went online. Unit: milliseconds.	1637592907000
AuthVersion	integer	The authorization version of the asset. Valid values:	1
Region	string	The region ID of the instance.	cn-hangzhou-cm*-*
InstanceName	string	The instance name.	yztest-l***
PodCount	integer	The number of pod groups.	1
VulCount	integer	The number of vulnerabilities on the instance.	2
HcStatus	string	Indicates whether baseline risks are detected on the instance. Valid values: YES: Baseline risks are detected. NO: No baseline risks are detected.	YES
CreatedTime	integer	The timestamp when the cluster was created. Unit: milliseconds.	1607365213000
GroupTrace	string	The name of the group to which the asset belongs.	default
ClusterId	string	The cluster ID.	c690a0789419f4284a4e0a29e12fe****
RiskStatus	string	Indicates whether the asset has security risks. Valid values:	NO
Cores	integer	The number of CPU cores of the asset.	4
VulStatus	string	Indicates whether vulnerabilities exist on the instance. Valid values:	YES
AlarmStatus	string	Indicates whether security alerts exist on the asset. Valid values:	NO
MacListString	string	The MAC address of the system.	00:13:3e:31:13:39,02:12:67:b8::
Importance	integer	The importance of the asset. Valid values:	2
HealthCheckCount	integer	The number of baseline risks on the instance.	1
Ip	string	The public IP address of the instance.	1.2.XX.XX
Os	string	The operating system of the instance.	Linux
AuthModifyTime	integer	The timestamp when the authorization was bound to the asset. Unit: milliseconds.	1627974044000
SafeEventCount	integer	The number of security alerts on the asset.	5
InstanceId	string	The instance ID.	i-m5***
AssetType	string	The type of the asset. Valid values:	0
IntranetIp	string	The private IP address of the instance.	1.2.XX.XX
Vendor	integer	The asset vendor. Valid values: 0: Alibaba Cloud asset. 1: Non-cloud asset. 2: IDC asset. 3, 4, 5, 7, 14, 16: Third-party cloud asset. 8: Lightweight asset. 9: SAE. 10: PAI.	0
RegionId	string	The region ID of the asset.	cn-hanghzou
Uuid	string	The UUID of the instance.	c9107c04-942f-40c1-981a-f1c1***
GroupId	integer	The ID of the group to which the instance belongs.	4120080
RegionName	string	The region name of the asset.	China (Hangzhou)
VendorName	string	The service provider name of the asset.	IDC
AuthVersionName	string	The authorization version name of the asset. Valid values:	Ultimate Edition
ClusterName	string	The cluster name.	cluster1
ExposedStatus	integer	The exposure status of the asset. Valid values:	0
RiskCount	string	Statistics on risk items of the asset. The value is in JSON format and contains the following fields: account: The number of accounts with unusual logons and successful brute-force attacks. appNum: The number of scanner vulnerabilities. asapVulCount: The total number of high-priority vulnerabilities. baselineHigh: The number of high-risk baseline risks. baselineLow: The number of low-risk baseline risks. baselineMedium: The number of medium-risk baseline risks. baselineNum: The total number of cloud product configuration risks. cmsNum: The number of Web-CMS vulnerabilities. containerAsap: The number of high-priority container vulnerabilities. containerLater: The number of medium-priority container vulnerabilities. containerNntf: The number of low-priority container vulnerabilities. containerRemind: The number of container reminder alerts. containerSerious: The number of container critical alerts. containerSuspicious: The number of container suspicious alerts. cveNum: The number of Linux vulnerabilities. emgNum: The number of emergency vulnerabilities. health: The number of unhandled baseline alerts. imageBaselineHigh: The number of high-risk image baseline risks. imageBaselineLow: The number of low-risk image baseline risks. imageBaselineMedium: The number of medium-risk image baseline risks. imageBaselineNum: The total number of image baseline risks. imageMaliciousFileRemind: The number of image reminder-level malicious files. imageMaliciousFileSerious: The number of image critical-level malicious files. imageMaliciousFileSuspicious: The number of image suspicious-level malicious files. imageVulAsap: The number of high-priority image vulnerabilities. imageVulLater: The number of medium-priority image vulnerabilities. imageVulNntf: The number of low-priority image vulnerabilities. laterVulCount: The number of medium-priority vulnerabilities. newSuspicious: The number of alerts. nntfVulCount: The number of low-priority vulnerabilities. remindNum: The number of reminder alerts. scaNum: The number of software composition analysis vulnerabilities. seriousNum: The number of critical alerts. suspNum: The number of suspicious alerts. suspicious: The total number of alerts. sysNum: The number of Windows vulnerabilities. trojan: The number of trojans. uuid: The UUID of the asset. vul: The number of vulnerabilities. weakPWNum: The number of weak passwords.	{ "account": 0, "appNum": 0, "asapVulCount": 0, "baselineHigh": 0, "baselineLow": 0, "baselineMedium": 0, "baselineNum": 0, "cmsNum": 0, "containerAsap": 0, "containerLater": 0, "containerNntf": 0, "containerRemind": 0, "containerSerious": 0, "containerSuspicious": 0, "cveNum": 0, "emgNum": 0, "health": 0, "imageBaselineHigh": 0, "imageBaselineLow": 0, "imageBaselineMedium": 0, "imageBaselineNum": 0, "imageMaliciousFileRemind": 0, "imageMaliciousFileSerious": 0, "imageMaliciousFileSuspicious": 0, "imageVulAsap": 0, "imageVulLater": 0, "imageVulNntf": 0, "laterVulCount": 0, "newSuspicious": 0, "nntfVulCount": 0, "remindNum": 0, "scaNum": 0, "seriousNum": 0, "suspNum": 0, "suspicious": 0, "sysNum": 0, "trojan": 0, "uuid": "inet-37316411-37fe-4b72-b245-346a2721****", "vul": 0, "weakPWNum": 0 }
IpListString	string	The IP address list of the system.	172.31.XX.XX,172.171.XX.XX
AssetTypeName	string	The type name of the asset.	Elastic Compute Service
FlagName	string	The asset vendor. Valid values:	ASK
AppId	string	The application ID.	test
AppName	string	The application name.	testAppName
ClientSubStatus	string	The sub-status of the client on the instance. Valid values:	online
TagResources	string	The custom tags of the Lingjun node. This field is returned only when the machine is a Lingjun machine.	app:test,type:lingjun
PostPaidFlag	integer	The billing method of the protection edition bound to the current asset. Valid values:	0
HasContainer	string	Indicates whether the asset contains containers. Valid values:	YES
ServiceId	string	The service ID. This field has a value only when the instance is a serverless instance that belongs to the PAI platform.	dsw-76jlywunsif09bp15p
VendorUid	string	The account ID of the multi-cloud instance.	123
VendorUserName	string	The account name of the multi-cloud instance.	VendorUserName
Namespace	string	The namespace.	crm-test
BindFileProtectType	string	Indicates whether the tamper-proofing authorization is bound. Valid values:	block
EdrAuthVersion	string
FreeType	string

Examples

Success response

JSON format

{
  "Success": true,
  "RequestId": "32A73759-4C0F-4801-BE98-901223ACEE9A",
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 50,
    "Count": 10,
    "NextToken": "B604532DEF982B875E8360A6EFA3B***"
  },
  "Instances": [
    {
      "Status": "Running",
      "CpuInfo": "Intel(R) Xeon(R) Platinum 8269CY CPU @ 2.50GHz",
      "InternetIp": "1.2.XX.XX",
      "Kernel": "3.10.0-1127.19.1.el7.x86_64",
      "Bind": true,
      "OsName": "-",
      "Tag": "InternetIp,test",
      "ClientStatus": "online",
      "Mem": 1024,
      "VpcInstanceId": "vpc-uf60agqq65bs98zoo****",
      "TagId": "121313,41412",
      "Flag": 0,
      "LastLoginTimestamp": 1637592907000,
      "AuthVersion": 1,
      "Region": "cn-hangzhou-cm***-***",
      "InstanceName": "yztest-l***",
      "PodCount": 1,
      "VulCount": 2,
      "HcStatus": "YES",
      "CreatedTime": 1607365213000,
      "GroupTrace": "default",
      "ClusterId": "c690a0789419f4284a4e0a29e12fe****",
      "RiskStatus": "NO",
      "Cores": 4,
      "VulStatus": "YES",
      "AlarmStatus": "NO",
      "MacListString": "00:13:3e:31:13:39,02:12:67:b8:**:**",
      "Importance": 2,
      "HealthCheckCount": 1,
      "Ip": "1.2.XX.XX",
      "Os": "Linux",
      "AuthModifyTime": 1627974044000,
      "SafeEventCount": 5,
      "InstanceId": "i-m5***",
      "AssetType": "0",
      "IntranetIp": "1.2.XX.XX",
      "Vendor": 0,
      "RegionId": "cn-hanghzou",
      "Uuid": "c9107c04-942f-40c1-981a-f1c1***",
      "GroupId": 4120080,
      "RegionName": "China (Hangzhou)",
      "VendorName": "IDC",
      "AuthVersionName": "Ultimate Edition",
      "ClusterName": "cluster1",
      "ExposedStatus": 0,
      "RiskCount": "{\n      \"account\": 0,\n      \"appNum\": 0,\n      \"asapVulCount\": 0,\n      \"baselineHigh\": 0,\n      \"baselineLow\": 0,\n      \"baselineMedium\": 0,\n      \"baselineNum\": 0,\n      \"cmsNum\": 0,\n      \"containerAsap\": 0,\n      \"containerLater\": 0,\n      \"containerNntf\": 0,\n      \"containerRemind\": 0,\n      \"containerSerious\": 0,\n      \"containerSuspicious\": 0,\n      \"cveNum\": 0,\n      \"emgNum\": 0,\n      \"health\": 0,\n      \"imageBaselineHigh\": 0,\n      \"imageBaselineLow\": 0,\n      \"imageBaselineMedium\": 0,\n      \"imageBaselineNum\": 0,\n      \"imageMaliciousFileRemind\": 0,\n      \"imageMaliciousFileSerious\": 0,\n      \"imageMaliciousFileSuspicious\": 0,\n      \"imageVulAsap\": 0,\n      \"imageVulLater\": 0,\n      \"imageVulNntf\": 0,\n      \"laterVulCount\": 0,\n      \"newSuspicious\": 0,\n      \"nntfVulCount\": 0,\n      \"remindNum\": 0,\n      \"scaNum\": 0,\n      \"seriousNum\": 0,\n      \"suspNum\": 0,\n      \"suspicious\": 0,\n      \"sysNum\": 0,\n      \"trojan\": 0,\n      \"uuid\": \"inet-37316411-37fe-4b72-b245-346a2721****\",\n      \"vul\": 0,\n      \"weakPWNum\": 0\n}",
      "IpListString": "172.31.XX.XX,172.171.XX.XX",
      "AssetTypeName": "Elastic Compute Service",
      "FlagName": "ASK",
      "AppId": "test",
      "AppName": "testAppName",
      "ClientSubStatus": "online",
      "TagResources": "app:test,type:lingjun",
      "PostPaidFlag": 0,
      "HasContainer": "YES",
      "ServiceId": "dsw-76jlywunsif09bp15p",
      "VendorUid": "123",
      "VendorUserName": "VendorUserName",
      "Namespace": "crm-test",
      "BindFileProtectType": "block",
      "EdrAuthVersion": "",
      "FreeType": ""
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	NoPermission	no permission
400	RdCheckNoPermission	Resource directory account verification has no permission.
500	ServerError	ServerError
500	RdCheckInnerError	Resource directory account service internal error.
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.