DescribeCloudCenterInstances

Description

Call the DescribeCloudCenterInstances interface to query the asset information on the asset center page, such as the name of the asset instance and the region to which the asset instance belongs.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeCloudCenterInstances

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
PageSize	BODY	integer	No	20	the maximum number of data displayed on each page during paging query.
CurrentPage	BODY	integer	No	1	page number of the current page when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
MachineTypes	BODY	string	No	ecs	asset type. ecs: server cloud_product: cloud product
Criteria	BODY	string	No	[{\"name\":\"riskStatus\",\"value\":\"YES\"},{\"name\":\"internetIp\",\"value\":\"1.2.\"}]	search criteria. Example: instance ID/name, VPC ID, region, IP address, etc. Parameter format:{\" name\":" condition 1 name "," value ":" condition 1 value "},{" name ":" condition 2 name "," value ":" condition 2 value "},{},...
NoPage	BODY	boolean	No	true	whether to query by page. true: indicates paging query data false: indicates that no paging query data
LogicalExp	BODY	string	No	OR	The logical relationship between multiple search conditions. OR: Indicates the relationship between multiple conditions that is "or" AND: indicates the relationship between multiple conditions is "and"
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
PageSize	integer	20	displays the number of data pieces per page.
VulStatus	string	YES	whether there is a vulnerability in the asset instance. YES: Yes NO: none
Ip	string	1.2.3.4	the public IP address of the asset instance.
Count	integer	10	the number of data displayed on the current page.
IntranetIp	string	1.2.3.0	the private IP address of the asset instance.
Success	boolean	true	request status of the result. true: the request was successful false: request failed
InternetIp	string	1.2.3.4	the public IP address of the asset instance.
RegionName	string	North China 1 (Qingdao)	the name of the region to which the asset instance belongs.
Status	string	Running	the boot status of the asset instance. Running: boot notRunning: shutdown
ClientStatus	string	online	whether the client of the asset instance is online. online: online, indicates that the security status of the asset is on offline: offline, indicates that the security status of the asset is closed pause: pause, indicates that the security protection status of the asset is protection suspension
SafeEventCount	integer	5	Number of security alerts for asset instances.
OS	string	Linux	the operating system of the asset instance.
RequestId	string	32A73759-4C0F-4801-BE98-901223ACEE9A	request ID of the result.
InstanceId	string	i-m5***	asset instance ID.
OsName	string	CentOS 7.6 64 bits	the kernel version of the asset instance.
HealthCheckCount	integer	1	number of baseline check problems for asset instances.
Flag	integer	0	whether the asset instance is owned by alibaba cloud. 0: alibaba cloud assets 1: non-alibaba cloud assets
RiskStatus	string	NO	whether the asset instance is at risk. YES: Existence NO: No
GroupId	string	4120080	the group ID of the asset instance.
VulCount	integer	2	number of vulnerabilities in asset instances.
Instances	array	No sample value for this parameter.	asset details.
InstanceName	string	yztest-l***	asset instance name.
AssetType	string	ecs	asset type.
PageInfo		No sample value for this parameter.	page displays information.
TotalCount	integer	50	the total number of data.
Uuid	string	c9107c04-942f-40c1-981a-f1c1***	unique identification ID of the asset instance.
CurrentPage	integer	1	the page number of the current page.
AlarmStatus	string	NO	whether the asset instance has a security alarm. YES: Yes NO: none
Region	string	cn-hangzhou-cm***-***	the region of the asset instance.
VpcInstanceId	string	classic	the VPC ID of the asset instance.
RegionId	string	cn-hanghzou	the region ID of the asset instance.
Tag	string	InternetIp	tag name of the asset instance.
HcStatus	string	YES	whether the asset instance has a baseline problem. YES: Yes NO: none

Example

Successful Response example

{
 "PageSize":"20",
 "VulStatus":"YES",
 "Ip":"1.2.3.4",
 "Count":"10",
 "IntranetIp":"1.2.3.0",
 "Success":"true",
 "InternetIp":"1.2.3.4",
 "RegionName":"North China 1 (Qingdao)",
 "Status":"Running",
 "ClientStatus":"online",
 "SafeEventCount":"5",
 "OS":"Linux",
 "RequestId":"32A73759-4C0F-4801-BE98-901223ACEE9A",
 "InstanceId":"i-m5***",
 "OsName":"CentOS 7.6 64 bits",
 "HealthCheckCount":"1",
 "Flag":"0",
 "RiskStatus":"NO",
 "GroupId":"4120080",
 "VulCount":"2",
 "Instances":"",
 "InstanceName":"yztest-l***",
 "AssetType":"ecs",
 "PageInfo":"",
 "TotalCount":"50",
 "Uuid":"c9107c04-942f-40c1-981a-f1c1***",
 "CurrentPage":"1",
 "AlarmStatus":"NO",
 "Region":"cn-hangzhou-cm***-***",
 "VpcInstanceId":"classic",
 "RegionId":"cn-hanghzou",
 "Tag":"InternetIp",
 "HcStatus":"YES"
}

Failed Response example

{
 "errorSample":
 {
  "resultCode":-1,
  "resultMsg":"system error",
  "result":null
 }

}