DescribePropertyUserDetail

Description

call the DescribePropertyUserDetail interface to obtain the details of an account in the account list.

Request Method

POST

Request Path

/apsara/route/aegis/DescribePropertyUserDetail

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
IsRoot	BODY	string	No	0	whether you have ROOT permission. Valid values include: 0: no 1: Yes
User	BODY	string	No	test	specify the name of the account to be queried.
Uuid	BODY	string	No	50d213b4-3a35-427a-b8a5-04b0c7e1f4d2	Specify the UUID of the asset to be queried.
PageSize	BODY	integer	No	2	specifies the number of data items displayed on each page of the list.
CurrentPage	BODY	integer	No	1	specifies the current page number of the returned result.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api
Remark	BODY	string	No	0.0.0.0	server name or IP.

Return data

Name	Type	Sample value	Description
Status	string	0	returns the login status of the account. Valid values include: 0: no login 1: login
Propertys	array	No sample value for this parameter.	returned account details list.
IsRoot	string	0	returns whether the account is ROOT permission. 0: no 1: Yes
GroupNames	list	adm	user group.
User	string	adm	account name.
RequestId	string	FAA793EF-5B14-4CDD-B3E0-B14D4342C422	request ID.
PageSize	integer	2	The number of data pieces per page in the returned result.
LastLoginIp	string	N/A	Last login source.
InstanceId	string	02c4a5dc-c2d2-483a-9015-f972b44d2cd9	return the asset ID in the result.
Ip	string	null	returns the IP address in the result.
Count	integer	2	the number of data displayed on the current page of the returned result.
AccountsExpirationDate	string	never	returns the expiration time of the account.
IntranetIp	string	0.0.0.0	returns the private IP address of the asset in the result.
InstanceName	string	null	returns the asset name in the result.
LastLoginTime	string	xxxx	last login time.
PageInfo	struct	No sample value for this parameter.	the page that returns the result displays information.
TotalCount	integer	384	returns the total number of data.
Uuid	string	02c4a5dc-c2d2-483a-9015-f972b44d2cd9	return the asset UUID in the result.
InternetIp	string	0.0.0.0	returns the public IP address of the asset in the result.
CurrentPage	integer	1	returns the current page number displayed in the result.
Create	string	1565644643000	the latest acquisition time in the return result.
CreateTimestamp	long	1565644643000	returns the acquisition timestamp in the result.
PasswordExpirationDate	string	never	returns the expiration time of the account password.

Example

Successful Response example

{
 "Status":"0",
 "Propertys":"",
 "IsRoot":"0",
 "GroupNames":"adm",
 "User":"adm",
 "RequestId":"FAA793EF-5B14-4CDD-B3E0-B14D4342C422",
 "PageSize":"2",
 "LastLoginIp":"N/A",
 "InstanceId":"02c4a5dc-c2d2-483a-9015-f972b44d2cd9",
 "Ip":"null",
 "Count":"2",
 "AccountsExpirationDate":"never",
 "IntranetIp":"0.0.0.0",
 "InstanceName":"null",
 "LastLoginTime":"xxxx",
 "PageInfo":"",
 "TotalCount":"384",
 "Uuid":"02c4a5dc-c2d2-483a-9015-f972b44d2cd9",
 "InternetIp":"0.0.0.0",
 "CurrentPage":"1",
 "Create":"1565644643000",
 "CreateTimestamp":"1565644643000",
 "PasswordExpirationDate":"never"
}

Failed Response example

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

}

---

title: DescribePropertyUserItem

sidebar_position: 3

DescribePropertyUserItem

Description

call the DescribePropertyUserItem interface to obtain the account information of the asset.

Request Method

POST

Request Path

/apsara/route/aegis/DescribePropertyUserItem

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
User	BODY	string	No	adm	account information of asset fingerprint.
PageSize	BODY	integer	No	2	when paging query, the maximum number of pieces of data is displayed on each page.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
version	BODY	string	No	2016-01-01	version of api
ForceFlush	BODY	boolean	No	true	whether to force refresh the data to be queried.

Return data

Name	Type	Sample value	Description
PageInfo		No sample value for this parameter.	page displays information.
TotalCount	integer	114	the total number of data.
User	string	adm	account name.
PageSize	integer	2	The maximum number of pieces of data per page displayed during a paged query.
RequestId	string	76068BE2-F9C4-4EDD-967B-F503B8CCDD3D	request ID of the result.
CurrentPage	integer	1	the page number of the current page displayed when paging query.
Count	integer	384	the number of servers corresponding to the account.
PropertyItems	array	No sample value for this parameter.	account information.

Example

Successful Response example

{
 "PageInfo":"",
 "TotalCount":"114",
 "User":"adm",
 "PageSize":"2",
 "RequestId":"76068BE2-F9C4-4EDD-967B-F503B8CCDD3D",
 "CurrentPage":"1",
 "Count":"384",
 "PropertyItems":""
}

Failed Response example

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

}

---

title: DescribeRiskCheckItemResult

sidebar_position: 3

DescribeRiskCheckItemResult

Description

invoke DescribeRiskCheckItemResult paging query for assets affected by risk items of cloud platform configuration check.

Request Method

POST

Request Path

/apsara/route/Sas/DescribeRiskCheckItemResult

Request Parameters Common Parameters

Name	Location	Type	Required	Sample value	Description
SourceIp	BODY	string	No	1.2.3.4	access the IP address of the source.
PageSize	BODY	integer	No	20	When paging query, the maximum number of pieces of data per page is displayed.
CurrentPage	BODY	integer	No	1	the page number of the current page displayed when paging query.
regionId	BODY	string	Yes	No sample value for this parameter.	region id
Lang	BODY	string	No	zh	the language type of the request and receive message. Value: zh: Chinese en: English
ItemId	BODY	long	No	2	check item ID.
version	BODY	string	No	2016-01-01	version of api

Return data

Name	Type	Sample value	Description
TotalCount	integer	1	the total number of data.
ContentResource	json	{"resultStatus":[{"id":32183150,"status":"failed"}],"columns":[{"title":"zone","key":"RegionId"},{"title":"database instance ID","key":"DBInstanceId"},{"title":"problem entry value","key":"VulValue"}],"values":[{"DBInstanceId":{"type":"link","value":"dds-bp144b42843fed14\n","url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843fed14/basicInfo"},"VulValue":{"type":"link","value":"0.0.0.0/0","url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843fed14/whiteList"},"RegionId":{"type":"text","value":"East China 1 (Hangzhou)\n"}}],"emptyGridValue":{"type":"text","value":"No data"},"type":"grid"}	paging data of dynamic tables affecting assets.
PageCount	integer	3	total number of pages of data.
PageSize	integer	10	When paging query, the maximum number of pieces of data per page is displayed.
RequestId	string	3BFB4989-A108-46A4-954E-FF7EF02D1078	the unique identifier generated by alibaba cloud for this request.
CurrentPage	integer	1	the page number of the current page displayed when paging query.
PageContentResource	struct	No sample value for this parameter.	affects asset paging information.
Count	integer	1	the number of data on the current page displayed during paging query.

Example

Successful Response example

{
 "TotalCount":"1",
 "ContentResource":
 {
  "resultStatus":
  [
   {
    "id":32183150,
    "status":"failed"
   }

  ],
  "columns":
  [
   {
    "title":"zone",
    "key":"RegionId"
   },
   {
    "title":"database instance ID",
    "key":"DBInstanceId"
   },
   {
    "title":"problem entry value",
    "key":"VulValue"
   }

  ],
  "values":
  [
   {
    "DBInstanceId":
    {
     "type":"link",
     "value":"dds-bp144b42843fed14\n",
     "url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843fed14/basicInfo"
    },
    "VulValue":
    {
     "type":"link",
     "value":"0.0.0.0/0",
     "url":"https://mongodb.console.aliyun.com/replicate/cn-hangzhou/instances/dds-bp144b42843fed14/whiteList"
    },
    "RegionId":
    {
     "type":"text",
     "value":"East China 1 (Hangzhou)\n"
    }

   }

  ],
  "emptyGridValue":
  {
   "type":"text",
   "value":"No data"
  },
  "type":"grid"
 },
 "PageCount":"3",
 "PageSize":"10",
 "RequestId":"3BFB4989-A108-46A4-954E-FF7EF02D1078",
 "CurrentPage":"1",
 "PageContentResource":"",
 "Count":"1"
}

Failed Response example

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

}