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

Queries asset information that meets the conditional criteria through Settings, such as searching for specified assets by conditions like the asset instance name or the area to which the asset instance belongs. Currently, both paging and NextToken methods are provided for conditional query, and the NextToken method is recommended.

Operation description

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

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 ID of the region where the instance resides.	cn-hangzhou
Criteria	string	No	The search conditions for assets. This parameter is in JSON format. Pay attention to the case sensitivity when you specify this parameter. Note You can search for assets by conditions such as instance ID, instance name, VPC ID, region, and public IP address. You can 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 the asset to query. Valid values: ecs: server cloud_product: cloud service 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 logical relationship between multiple search conditions is OR. AND: The logical relationship between multiple search conditions is AND.	OR
PageSize	integer	No	The number of Asset entries to display on each page when you configure paging for a paged query through Settings. Default value: 20, which indicates that 20 pieces of Asset information are displayed on each page.	100
CurrentPage	integer	No	The page number of the page to return. Default value: 1.	1
Importance	integer	No	The importance of the asset. Valid values: 2: important asset 1: general asset 0: test asset	2
NoGroupTrace	boolean	No	Specifies whether to internationalize the default group Ungrouped. Default value: false. Valid values: true: does not internationalize the default group. If the value of the GroupTrace response parameter is the default group Ungrouped in Security Center, Ungrouped is still displayed as Ungrouped. false: internationalizes the default group. If the value of the GroupTrace response parameter is the default group Ungrouped in Security Center, Ungrouped 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 pull asset list data. If you use this parameter, TotalCount is not 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 query.	E17B501887A2D3AA5E8360A6EFA3B***
ResourceDirectoryAccountId	integer	No	The ID of the Alibaba Cloud account to which the member accounts in the resource folder belong. Note You can invoke the DescribeMonitorAccounts operation to obtain this parameter.	1232428423234****
Flags	string	No	The asset provider. Separate multiple asset providers with commas (,). Valid values: 0: Alibaba Cloud asset 1: non-Alibaba Cloud asset 2: IDC asset 3, 4, 5, 7, 14, and 16: asset on other cloud platforms 8: lightweight asset 9: SAE 10: PAI	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 succeeded. false: The API call failed.	true
RequestId	string	The ID of the request. This unique identifier is generated by Alibaba Cloud for the request and can be used for troubleshooting.	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 returned per page in a paging query. Default value: 20, which indicates that 20 assets are displayed on each page.	20
TotalCount	integer	The total number of queried assets.	50
Count	integer	The number of assets returned on the current page.	10
NextToken	string	The NextToken value returned when the NextToken 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: Bound. false: Unbound.	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: Online, which indicates that the Security Center agent on the asset is enabled. offline: Offline, which indicates that the Security Center agent on the asset is disabled. pause: Paused, which indicates that the Security Center agent on the asset is paused.	online
Mem	integer	The memory size. Unit: 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: Alibaba Cloud asset. 1: Non-Alibaba Cloud asset.	0
LastLoginTimestamp	integer	The timestamp when the client was last online. Unit: milliseconds.	1637592907000
AuthVersion	integer	The authorization version of the asset. Valid values: 1: Free Edition 6: Anti-virus Edition 5: Advanced 3: Enterprise Edition 7: Ultimate Edition 1: Free Edition 6: Anti-virus Edition 5: Advanced 3: Enterprise Edition 7: Ultimate Edition	1
Region	string	The ID of the region to which the instance belongs.	cn-hangzhou-cm*-*
InstanceName	string	The name of the instance.	yztest-l***
PodCount	integer	The number of pods.	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 security risks exist on the asset. Valid values: YES: Yes. NO: No.	NO
Cores	integer	The number of CPU cores of the asset.	4
VulStatus	string	Indicates whether vulnerabilities exist on the instance. Valid values: YES: Vulnerabilities exist. NO: No vulnerabilities exist.	YES
AlarmStatus	string	Indicates whether security alerts exist on the asset. Valid values: YES: Security alerts exist. NO: No security alerts exist.	NO
MacListString	string	The MAC address of the system.	00:13:3e:31:13:39,02:12:67:b8::
Importance	integer	The importance level of the asset. Valid values: 2: Important asset. 1: General asset. 0: Test asset.	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: Cloud server. 1: Load balancing. 2: NAT gateway. 3: RDS database. 4: MongoDB database. 5: Redis database. 6: Container image. 7: Container.	0
IntranetIp	string	The private IP address of the instance.	1.2.XX.XX
Vendor	integer	The vendor of the asset. Valid values: 0: Alibaba Cloud. 1: Non-Alibaba Cloud. 2: IDC. 3, 4, 5, 7, 14, 16: Other cloud providers. 8: Simple Application Server. 9: Serverless App Engine (SAE). 10: Machine Learning Platform for AI (PAI).	0
RegionId	string	The ID of the region where the asset resides.	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 name of the region where the asset resides.	China (Hangzhou)
VendorName	string	The name of the service provider for the asset. Valid values: ALIYUN: Alibaba Cloud. OUT: Third-party. IDC: IDC. TENCENT: Tencent Cloud. HUAWEICLOUD: Huawei Cloud. Microsoft: Microsoft Azure. AWS: AWS. TRIPARTITE: Simple Application Server. SAE: SAE. PAI: PAI. VOLCENGINE: Volcengine. google: Google Cloud.	IDC
AuthVersionName	string	The specific name of the authorization version of the asset. Valid values: Free Edition Anti-virus Edition Advanced Enterprise Edition Ultimate Edition	Ultimate Edition
ClusterName	string	The name of the cluster.	cluster1
ExposedStatus	integer	The exposure status of the asset. Valid values: 0: Unexposed. 1: Exposed.	0
RiskCount	string	The statistics of risk items on 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-severity 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 service configuration risks. cmsNum: The number of Web-CMS vulnerabilities. containerAsap: The number of high-severity container vulnerabilities. containerLater: The number of medium-severity container vulnerabilities. containerNntf: The number of low-severity container vulnerabilities. containerRemind: The number of reminder alerting for containers. containerSerious: The number of urgent alerting for containers. containerSuspicious: The number of suspicious alerting for containers. cveNum: The number of Linux software vulnerabilities. emgNum: The number of emergency vulnerabilities. health: The number of unhandled baseline alerting. 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 reminder malicious files in images. imageMaliciousFileSerious: The number of urgent malicious files in images. imageMaliciousFileSuspicious: The number of suspicious malicious files in images. imageVulAsap: The number of high-severity image vulnerabilities. imageVulLater: The number of medium-severity image vulnerabilities. imageVulNntf: The number of low-severity image vulnerabilities. laterVulCount: The number of medium-severity vulnerabilities. newSuspicious: The number of alerting. nntfVulCount: The number of low-severity vulnerabilities. remindNum: The number of reminder alerting. scaNum: The number of software constituency parsing vulnerabilities. seriousNum: The number of urgent alerting. suspNum: The number of suspicious alerting. suspicious: The total number of alerting. sysNum: The number of Windows system 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 list of IP addresses 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 vendor of the asset. Valid values: ALIYUN OUT IDC Tencent HUAWEICLOUD Azure AWS ASK TRIPARTITE SAE PAI google VOLCENGINE	ASK
AppId	string	The application ID. Note This field is returned only when Vendor is set to 9.	test
AppName	string	The application name. Note This field is returned only when Vendor is set to 9.	testAppName
ClientSubStatus	string	The sub-status of the client on the instance. Valid values: online: Online, which indicates that the Security Center agent on the asset is enabled. offline: Offline, which indicates that the Security Center agent on the asset is disabled. pause: Paused, which indicates that the Security Center agent on the asset is paused. uninstalled: Uninstalled, which indicates that the Security Center agent on the asset is not installed. stopped: Stopped, which indicates that the server is shut down and the Security Center agent is stopped.	online
TagResources	string	The custom tags of the Lingjun node. This field is returned only when the instance is a Lingjun instance.	app:test,type:lingjun
PostPaidFlag	integer	The billing method of the protection version attached to the asset. Valid values: 0: Subscription. 1: Pay-as-you-go.	0
HasContainer	string	Indicates whether the asset contains containers. Valid values: YES: Yes. NO: No.	YES
ServiceId	string	The service ID. This field has a value only when the instance is a serverless instance and belongs to the Machine Learning Platform for AI (PAI).	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: Yes. none: No.	block
EdrAuthVersion	string	The identifier of the EDR authorization version currently used by the asset.
FreeType	string	The type of free quota used by the asset.

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	Description
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	You are not authorized to do this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.