Retrieves the details of the risk items that are detected in the configuration checks on cloud services.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| StandardIds |
array |
No |
The standard IDs. |
|
|
integer |
No |
The standard ID. |
2 |
|
| RequirementIds |
array |
No |
The IDs of the requirements. |
|
|
integer |
No |
The ID of the requirement. |
2 |
|
| Statuses |
array |
No |
The statuses of check items. Separate multiple statuses with commas (,). Valid values:
|
|
|
string |
No |
The statuses of check items. Separate multiple states with commas (,). Valid values:
|
PASS |
|
| RiskLevels |
array |
No |
The risk levels of check items. Separate multiple risk levels with commas (,). Valid values:
|
|
|
string |
No |
The risk levels of check items. Separate multiple risk levels with commas (,). Valid values:
|
HIGH |
|
| Vendors |
array |
No |
The cloud service providers. Valid values:
|
|
|
string |
No |
The cloud service provider. Valid values:
|
ALIYUN |
|
| InstanceTypes |
array |
No |
The asset type of the cloud services. Valid values:
|
|
|
string |
No |
The asset type of the cloud service. Valid values:
|
ECS |
|
| CheckKey |
string |
No |
The key that you want to use to search for check items in fuzzy match mode. |
OSS |
| CurrentPage |
integer |
No |
The page number. |
2 |
| PageSize |
integer |
No |
The number of entries per page. Maximum value: 100. |
50 |
| InstanceIds |
array |
No |
The instance IDs of the cloud services that you want to query. Separate multiple IDs with commas (,). |
|
|
string |
No |
The instance IDs of the cloud services that you want to query. Separate multiple IDs with commas (,). |
i-bp1du66x6w07z4yya**** |
|
| Lang |
string |
No |
The language of the content within the request and response. Default value: zh. Valid values:
|
zh |
| SortTypes |
array |
No |
The types of the conditions based on which check items are sorted. Valid values:
|
|
|
string |
No |
The type of the condition based on which check items are sorted. Valid values:
|
STATUS |
|
| Types |
array |
No |
The types of check standards. |
|
|
string |
No |
The type of the check standard. Valid values:
|
RISK |
|
| RegionId |
string |
No |
The region ID of the instance. Valid values:
|
cn-hangzhou |
| CustomParam |
boolean |
No |
Specifies whether the check item supports custom parameters. Valid values:
|
true |
| CheckIds |
array |
No |
The IDs of the check items. |
|
|
integer |
No |
The ID of the check item. |
358 |
|
| OperationTypes |
array |
No |
Specifies whether fixing is supported. Valid values:
|
|
|
string |
No |
Specifies whether fixing is supported. Valid values:
|
SUPPORT_REPAIR |
|
| CheckTypes |
array |
No |
Source type of the situation awareness check item. |
|
|
string |
No |
The source type of the Situation Awareness check item:
|
SYSTEM |
|
| TaskSources |
array |
No |
Delete the custom category in a custom inspection item. |
|
|
string |
No |
Task source. The value can be:
|
YAO_CHI |
|
| ResourceDirectoryAccountId |
integer |
No |
The Alibaba Cloud account ID of the member in the resource directory. Note
You can call the DescribeMonitorAccounts operation to obtain the IDs. |
127608589417**** |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
ListCheckResultResponse |
||
| Checks |
array<object> |
The check items. |
|
|
array<object> |
The check result. |
||
| CheckPolicies |
array<object> |
The check policies. |
|
|
object |
The information about the standards, requirement items, and sections that are associated with the check result. |
||
| StandardId |
integer |
The standard ID of the check item. |
1 |
| StandardShowName |
string |
The standard display name of the check item. |
Best security practices |
| RequirementId |
integer |
The ID of the requirement item for the check item. |
2 |
| RequirementShowName |
string |
The display name of the requirement item for the check item. |
Alibaba cloud OSS best security practices |
| SectionId |
integer |
The ID of the section for the check item. |
3 |
| SectionShowName |
string |
The display name of the section for the check item. |
Log Audit |
| CheckId |
integer |
The ID of the check item. |
5 |
| CheckShowName |
string |
The name of the check item. |
OSS-PublicReadOpenManifestFileWithoutEncryption |
| Vendor |
string |
The cloud service provider. |
ALIYUN |
| VendorShowName |
string |
The name of the cloud service provider. |
Aliyun |
| InstanceType |
string |
The asset type of the cloud service. Valid values:
|
ECS |
| InstanceSubType |
string |
The asset subtype of the cloud service. Valid values:
|
DISK |
| RiskLevel |
string |
The risk level of the check item. Valid values:
|
HIGH |
| Status |
string |
The status of the check item. Valid values:
|
PASS |
| TaskId |
string |
The ID of the check task. |
64 |
| LastCheckTime |
integer |
The timestamp when the last check was performed. Unit: milliseconds. |
1657793398000 |
| TrialPermission |
boolean |
Indicates whether the TRIAL permission is required. |
true |
| StatusMessage |
string |
The message returned if the status of the check item is abnormal. |
TIMEOUT |
| CheckSaleType |
integer |
The type of the check item. Valid values:
|
1 |
| AssetVendor |
integer |
The service provider of the asset. Valid values:
|
3 |
| CheckType |
string |
The source type of the situation awareness check item:
|
SYSTEM |
| AssetType |
integer |
The type of the asset. Valid values:
|
0 |
| AssetSubType |
integer |
The subtype of the cloud service. |
0 |
| OperationType |
string |
Indicates whether fixing is supported. Valid values:
|
NOT_SUPPORT_REPAIR |
| TrialPermissionType |
integer |
Check whether the data delivery period for ActionTrail is enabled for more than 30 days to establish a baseline of behaviour.
|
1 |
| PageInfo |
object |
The pagination information. |
|
| CurrentPage |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
20 |
| TotalCount |
integer |
The total number of entries returned. |
100 |
| Count |
integer |
The number of entries returned on the current page. |
2 |
| RequestId |
string |
The ID of the request. |
F9B6DD67-B289-5406-B35C-B0F4A217S23 |
Examples
Success response
JSON format
{
"Checks": [
{
"CheckPolicies": [
{
"StandardId": 1,
"StandardShowName": "Best security practices",
"RequirementId": 2,
"RequirementShowName": "Alibaba cloud OSS best security practices",
"SectionId": 3,
"SectionShowName": "Log Audit"
}
],
"CheckId": 5,
"CheckShowName": "OSS-PublicReadOpenManifestFileWithoutEncryption",
"Vendor": "ALIYUN",
"VendorShowName": "Aliyun",
"InstanceType": "ECS",
"InstanceSubType": "DISK",
"RiskLevel": "HIGH",
"Status": "PASS",
"TaskId": "64",
"LastCheckTime": 1657793398000,
"TrialPermission": true,
"StatusMessage": "TIMEOUT",
"CheckSaleType": 1,
"AssetVendor": 3,
"CheckType": "SYSTEM",
"AssetType": 0,
"AssetSubType": 0,
"OperationType": "NOT_SUPPORT_REPAIR",
"TrialPermissionType": 1
}
],
"PageInfo": {
"CurrentPage": 1,
"PageSize": 20,
"TotalCount": 100,
"Count": 2
},
"RequestId": "F9B6DD67-B289-5406-B35C-B0F4A217S23"
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | IllegalParam | Illegal param | |
| 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.