Identify Failed Checks with ListCheckInstanceResult API - Security Center

Queries the instances that failed a specified check item of configuration assessment.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
CheckId	integer	Yes	The ID of the check item.	23
Statuses	array	No	The statuses of check items.
	string	No	The status of the check item. Valid values: PASS NOT_PASS CHECKING NOT_CHECK WHITELIST	PASS
InstanceIdKey	string	No	The ID of the instance.	i-uf64w4q6p9jti5gl****
InstanceNameKey	string	No	The name of the instance.	i-uf64w4q6p9jti5gl****
RegionIdKey	string	No	The region ID of the instance.	cn-qingdao
CurrentPage	integer	No	The number of the page to return.	1
PageSize	integer	No	The number of entries per page. Maximum value: 100.	20
InstanceIds	array	No	The instance IDs of cloud services.
	string	No	The instance ID of the cloud service.	i-uf64w4q6p9jti5gl****
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese en: English	zh
SortTypes	array	No	The types of the conditions based on which the check items are sorted.
	string	No	The type of the condition based on which the check items are sorted. Set the value to STATUS.	STATUS

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	3AB18264-8A1B-52A6-A9AF-A886556E0F2E
BasicData	array<object>	The basic information about the affected instances.
	array<object>	The basic information about the instance.
Id	integer	The ID of the check result for the instance.	300054
Status	string	The states of check items. Multiple states are separated with commas (,). Valid values: PASS: passed NOT_PASS: failed CHECKING: being checked NOT_CHECK: not checked WHITELIST: added to the whitelist	NOT_PASS
RegionId	string	The region ID of the instance.	ap-southeast-1
InstanceId	string	The instance ID of the server.	rm-m5es7ch1s62i4****
InstanceName	string	The instance name of the server.	sg-t4nbk2aodzio52xv****
StatusMessage	string	The exception message of the check item.	Check task failed.
InstanceInfo	object	The information about the instance on which the check item is used.
FirstUpdateTime	integer	The time of the first check.	1716447535531
LastUpdateTime	integer	The time of the last check.	1716447535531
Config	array<object>	The information about the configuration item whose risks are fixed for the instance.
	object
Name	string	The name of the configuration item, which is unique.	prot
Value	string	The value of the configuration item specified for the instance.	8080
ShowName	string	The display name of the configuration item for internationalization.	prot
VendorUserName	string	The multi-cloud provider account name.	test
Columns	array<object>	The metadata information about the search conditions that can be used to filter instances.
	array<object>	The metadata information about the search condition that can be used to filter instances.
Type	string	The type of the check result for the instance. Valid values: text link	text
Key	string	The search condition.	RegionIdShow
ShowName	string	The display name of the search condition.	Region
Search	boolean	Indicates whether the search condition is used. Valid values: true false	true
SearchKey	string	The search key.	InstanceIdKey
Grids	array<object>	The metadata information about the details of the instance.
	object	The metadata information about each item in the details of the instances.
Type	string	The format of the check result for the instance. Valid values: text link	text
Key	string	The search condition.	RegionIdShow
ShowName	string	The display name of the search condition.	Region
Checks	array<object>	The extended information about the instances.	[{ "SecurityGroupNameShow": { "value": "Sas_Malicious_Ip_Security_Group" }, "InstanceIdShow": { "link": "https://ecs.console.alibabacloud.com/#/securityGroupDetail/region/ap-southeast-1/groupId/sg-t4nbk2aodzio52xvj00s/rule/intranetIngress", "value": "sg-t4nbk2aodzio52xv****" } }]
	object	The extended information about the instance.	[{ "SecurityGroupNameShow": { "value": "Sas_Malicious_Ip_Security_Group" }, "InstanceIdShow": { "link": "https://ecs.console.alibabacloud.com/#/securityGroupDetail/region/ap-southeast-1/groupId/sg-t4nbk2aodzio52xvj00s/rule/intranetIngress", "value": "sg-t4nbk2aodzio52xv****" } }]
	any	The information about the check item.	{ "InstanceIdShow": { "link": "https://vpc.console.alibabacloud.com/vpc/cn-beijing/vpcs", "value": "ngw-2zenx8j1lf5w8rcdhdqs5" }, "RegionIdShow": { "value": "China(Beijing)" } }
PageInfo	object	The pagination information.
CurrentPage	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	20
TotalCount	integer	The total number of entries returned.	100
Count	string	The number of entries returned on the current page.	20

Examples

Success response

JSON format

{
  "RequestId": "3AB18264-8A1B-52A6-A9AF-A886556E0F2E",
  "BasicData": [
    {
      "Id": 300054,
      "Status": "NOT_PASS",
      "RegionId": "ap-southeast-1",
      "InstanceId": "rm-m5es7ch1s62i4****",
      "InstanceName": "sg-t4nbk2aodzio52xv****",
      "StatusMessage": "Check task failed.",
      "InstanceInfo": {
        "FirstUpdateTime": 1716447535531,
        "LastUpdateTime": 1716447535531,
        "Config": [
          {
            "Name": "prot",
            "Value": "8080",
            "ShowName": "prot"
          }
        ]
      },
      "VendorUserName": "test"
    }
  ],
  "Columns": [
    {
      "Type": "text",
      "Key": "RegionIdShow",
      "ShowName": "Region",
      "Search": true,
      "SearchKey": "InstanceIdKey",
      "Grids": [
        {
          "Type": "text",
          "Key": "RegionIdShow",
          "ShowName": "Region"
        }
      ]
    }
  ],
  "Checks": [
    {
      "key": "{\n      \"InstanceIdShow\": {\n        \"link\": \"https://vpc.console.alibabacloud.com/vpc/cn-beijing/vpcs\",\n        \"value\": \"ngw-2zenx8j1lf5w8rcdhdqs5\"\n      },\n      \"RegionIdShow\": {\n        \"value\": \"China(Beijing)\"\n      }\n    }"
    }
  ],
  "PageInfo": {
    "CurrentPage": 1,
    "PageSize": 20,
    "TotalCount": 100,
    "Count": "20"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
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.