DescribeExportInfo
Description
call DescribeExportInfo to view the progress of excel 'export' of asset results.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeExportInfo
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| ExportId | BODY | long | Yes | 111 | 'export' task ID. |
| regionId | BODY | string | Yes | No sample value for this parameter. | region 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 pieces of information in the 'export'ed excel table. |
| Progress | integer | 100 | 'export' progress percentage (%). |
| RequestId | string | 4C1AE3F3-18FA-4108-BBB9-AFA1A032756C | request ID of the result. |
| Message | string | success | 'export' result prompt information. fixed value: success. Indicates that the 'export' was successful. |
| FileName | string | health_check_'export'_20171123 | the name of the 'export'ed excel file. |
| ExportStatus | string | success | status of excel 'export' of baseline check results. Value: init: 'export' initialization 'export'ing: 'export' in progress success: 'export' successfully |
| CurrentCount | integer | 1 | the number of pieces of information currently 'export'ed. |
| Id | long | 11 | 'export' ID. |
| Link | string | http://www.aliyun.com | download link of excel after 'export'. |
Example
Successful Response example
{
"TotalCount":"1",
"Progress":"100",
"RequestId":"4C1AE3F3-18FA-4108-BBB9-AFA1A032756C",
"Message":"success",
"FileName":"health_check_'export'_20171123",
"ExportStatus":"success",
"CurrentCount":"1",
"Id":"11",
"Link":"http://www.aliyun.com"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}
title: DescribeFieldStatistics
sidebar_position: 3
DescribeFieldStatistics
Description
call the DescribeFieldStatistics interface to query the statistics of the asset instance.
Request Method
POST
Request Path
/apsara/route/Sas/DescribeFieldStatistics
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| MachineTypes | BODY | string | No | ecs | asset type. If the asset type is not specified, the statistics of all types of assets are queried. ecs: server cloud_product: cloud product |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| InstanceCount | integer | 100 | number of all assets. |
| OfflineInstanceCount | integer | 21 | number of offline servers. |
| RequestId | string | 7E0618A9-D5EF-4220-9471-C42B5E92719F | request ID of the result. |
| VpcCount | integer | 5 | VPC number. |
| GroupCount | integer | 20 | number of server groups. |
| RegionCount | integer | 11 | the number of regions to which the server belongs. |
| RiskInstanceCount | integer | 90 | number of assets at risk. |
| NotRunningStatusCount | integer | 10 | number of servers not started. |
| GroupedFields | - | - | asset information. |
| NewInstanceCount | integer | 10 | Number of new servers. |
| UnprotectedInstanceCount | integer | 10 | number of unprotected assets. |
Example
Successful Response example
{
"InstanceCount":"100",
"OfflineInstanceCount":"21",
"RequestId":"7E0618A9-D5EF-4220-9471-C42B5E92719F",
"VpcCount":"5",
"GroupCount":"20",
"RegionCount":"11",
"RiskInstanceCount":"90",
"NotRunningStatusCount":"10",
"GroupedFields":"-",
"NewInstanceCount":"10",
"UnprotectedInstanceCount":"10"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}