Identify Failed Checks with ListCheckInstanceResult API - Security Center - Alibaba Cloud - Security Center

Retrieves instances that failed a cloud platform configuration check item.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:ListCheckInstanceResult

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CheckId	integer	Yes	The check item ID.	23
Statuses	array	No	The collection of check item statuses.
	string	No	The status of the check item. Valid values: PASS: Passed. NOT_PASS: Failed. CHECKING: Being checked. NOT_CHECK: Not checked. WHITELIST: Whitelisted. FAILED: Failed.	PASS
InstanceIdKey	string	No	The instance ID of the check item.	i-uf64w4q6p9jti5gl****
InstanceNameKey	string	No	The instance name of the check item.	i-uf64w4q6p9jti5gl****
RegionIdKey	string	No	The region ID of the instance.	cn-qingdao
CurrentPage	integer	No	The page number of the current page in a paged query. This parameter is used for paging.	1
PageSize	integer	No	The maximum number of entries per page in a paged query. Maximum value: 100. This parameter is used for paging.	20
InstanceIds	array	No	The collection of cloud service instance IDs to query.
	string	No	The cloud service instance ID to query.	i-uf64w4q6p9jti5gl****
Lang	string	No	The language type for the request and response messages. Default value: zh. Valid values: zh: Chinese en: English	zh
SortTypes	array	No	The list of sort types for the check item.
	string	No	The sort type of the check item. Currently, the value is fixed to STATUS.	STATUS

Response elements

Element	Type	Description	Example
	object	The response struct.
RequestId	string	The request ID, which is a unique identifier generated by Alibaba Cloud for this request. You can use it to troubleshoot issues.	3AB18264-8A1B-52A6-A9AF-A886556E0F2E
BasicData	array<object>	The list of basic information about affected instances.
	array<object>	The basic information about an affected instance.
Id	integer	The check result ID of the instance.	300054
Status	string	The status list of the check item. Multiple statuses are separated by commas (,). Valid values: PASS: Passed. NOT_PASS: Failed. CHECKING: Being checked. NOT_CHECK: Not checked. WHITELIST: Whitelisted. FAILED: Failed.	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 name of the server instance.	sg-t4nbk2aodzio52xv****
StatusMessage	string	The exception status message of the check item.	Check task failed
InstanceInfo	object	The instance information displayed for the corresponding check item.
FirstUpdateTime	integer	The time of the first check. The value is a UNIX timestamp. Unit: milliseconds.	1716447535531
LastUpdateTime	integer	The time of the latest check. The value is a UNIX timestamp. Unit: milliseconds.	1716447535531
Config	array<object>	The current instance information displayed for the corresponding remediation configuration.
	object	The instance information struct.
Name	string	The unique name of the corresponding configuration.	prot
Value	string	The value of the corresponding configuration for the current asset.	8080
ShowName	string	The internationalized name of the corresponding configuration item.	prot
VendorUserName	string	The multi-cloud vendor account name.	test
Columns	array<object>	The metadata of the affected instance information display list.
	array<object>	The metadata information of the affected instance information display list.
Type	string	The property type of the check instance result. Valid values: text: text link: link	text
Key	string	The key of the list property.	RegionIdShow
ShowName	string	The display name.	Region
Search	boolean	Indicates whether search is supported. Valid values: true: Supported. false: Not supported.	true
SearchKey	string	The key used for search.	InstanceIdKey
Grids	array<object>	The list of list-type metadata.
	object	The list-type metadata.
Type	string	The type of the check instance result. Valid values: text: text link: link	text
Key	string	The search value.	RegionIdShow
ShowName	string	The search display name.	Region
Checks	array<object>	The list of extended information about affected 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 an affected 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 check item information.	{ "InstanceIdShow": { "link": "https://vpc.console.alibabacloud.com/vpc/cn-beijing/vpcs", "value": "ngw-2zenx8j1lf5w8rcdhdqs5" }, "RegionIdShow": { "value": "China(Beijing)" } }
PageInfo	object	The paging information displayed on the page in a paged query.
CurrentPage	integer	The page number of the current page in a paged query. This parameter is used for paging.	1
PageSize	integer	The maximum number of entries per page in a paged query. This parameter is used for paging.	20
TotalCount	integer	The total number of entries.	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": "检查任务失败。",
      "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.