All Products
Search
Document Center

Security Center:ListCheckInstanceResult

Last Updated:Mar 14, 2024

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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
yundun-sas:ListCheckInstanceResultRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CheckIdlongYes

The ID of the check item.

23
StatusesarrayNo

The statuses of check items.

stringNo

The status of the check item. Valid values:

  • PASS
  • NOT_PASS
  • CHECKING
  • NOT_CHECK
  • WHITELIST
PASS
InstanceIdKeystringNo

The ID of the instance.

i-uf64w4q6p9jti5gl****
InstanceNameKeystringNo

The name of the instance.

i-uf64w4q6p9jti5gl****
RegionIdKeystringNo

The region ID of the instance.

cn-qingdao
CurrentPageintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value : 100.

20
InstanceIdsarrayNo

The instance IDs of cloud services.

stringNo

The instance ID of the cloud service.

i-uf64w4q6p9jti5gl****
LangstringNo

The language of the content within the request and response. Default value: zh. Valid values:

  • zh: Chinese
  • en: English
zh
SortTypesarrayNo

The types of the conditions based on which the check items are sorted.

stringNo

The type of the condition based on which the check items are sorted. Set the value to STATUS.

STATUS

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The ID of the request, which is used to locate and troubleshoot issues.

3AB18264-8A1B-52A6-A9AF-A886556E0F2E
BasicDataobject []

The basic information about the affected instances.

Idlong

The check result ID of the instance.

300054
Statusstring

The states of check items. Multiple states are separated with commas (,). Valid values:

  • PASS: The instance passed the check.
  • NOT_PASS: The instance failed to pass the check.
  • CHECKING: The instance is being checked.
  • NOT_CHECK: The instance is not checked.
  • WHITELIST: The instance is in the whitelist.
NOT_PASS
RegionIdstring

The ID of the region in which the instance resides.

ap-southeast-1
InstanceIdstring

The instance ID of the server.

rm-m5es7ch1s62i4****
InstanceNamestring

The instance name.

sg-t4nbk2aodzio52xv****
StatusMessagestring

The exception message of the check item.

Task is failed.
Columnsobject []

The metadata information about the search conditions that can be used to filter instances.

Typestring

The type of the check result for the instance. Valid values:

  • text
  • link
text
Keystring

The search condition.

RegionIdShow
ShowNamestring

The display name of the search condition.

Region
Searchboolean

Indicates whether the search condition is used. Valid values:

  • true
  • false
true
SearchKeystring

The search key.

InstanceIdKey
Gridsobject []

The metadata information about the details of the instance.

Typestring

The format of the check result for the instance. Valid values:

  • text
  • link
text
Keystring

The search condition.

RegionIdShow
ShowNamestring

The display name of the search condition.

Region
Checksobject []

The extended information about the instances.

[{ "SecurityGroupNameShow": { "value": "Sas_Malicious_Ip_Security_Group" }, "InstanceIdShow": { "link": "https://ecs.console.aliyun.com/#/securityGroupDetail/region/ap-southeast-1/groupId/sg-t4nbk2aodzio52xvj00s/rule/intranetIngress", "value": "sg-t4nbk2aodzio52xv****" } }]
object

The extended information about the instance.

any

The information about the check item.

{ "InstanceIdShow": { "link": "https://vpcnext.console.aliyun.com/vpc/cn-beijing/vpcs", "value": "ngw-2zenx8j1lf5w8rcdhdqs5" }, "RegionIdShow": { "value": "China(Beijing)" } }
PageInfoobject

The pagination information.

CurrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20
TotalCountinteger

The total number of entries returned.

100
Countstring

The number of entries returned on the current page.

20

Examples

Sample success responses

JSONformat

{
  "RequestId": "3AB18264-8A1B-52A6-A9AF-A886556E0F2E",
  "BasicData": [
    {
      "Id": 300054,
      "Status": "NOT_PASS",
      "RegionId": "ap-southeast-1",
      "InstanceId": "rm-m5es7ch1s62i4****",
      "InstanceName": "sg-t4nbk2aodzio52xv****",
      "StatusMessage": "Task is failed."
    }
  ],
  "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://vpcnext.console.aliyun.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 codeError codeError messageDescription
403NoPermissioncaller has no permissionYou are not authorized to do this operation.
500ServerErrorServerError-

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-14The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.
2023-07-17The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-07-26The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-07-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-07-25The response structure of the API has changedsee changesets
Change itemChange content
Output ParametersThe response structure of the API has changed.
2022-07-22Add Operationsee changesets