ListCheckInstanceResult - 获取检测项下的实例 - 云安全中心

获取云平台配置未通过检测项下的实例。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
yundun-sas:ListCheckInstanceResult	get	全部资源 ``	无	无

请求参数

名称	类型	必填	描述	示例值
CheckId	long	是	检查项 ID。	23
Statuses	array	否	检查项的状态集合。
	string	否	检查项的状态。取值： PASS：通过 NOT_PASS：未通过 CHECKING：检查中 NOT_CHECK：未检查 WHITELIST：加白	PASS
InstanceIdKey	string	否	检查项实例 ID。	i-uf64w4q6p9jti5gl****
InstanceNameKey	string	否	检查项实例名称。	i-uf64w4q6p9jti5gl****
RegionIdKey	string	否	实例所在的地域 ID。	cn-qingdao
CurrentPage	integer	否	分页查询时，显示的当前页的页码。	1
PageSize	integer	否	分页查询时，显示的每页数据的最大条数，最大 100。	20
InstanceIds	array	否	需要查询的云产品实例 ID 集合。
	string	否	需要查询的云产品实例 ID。	i-uf64w4q6p9jti5gl****
Lang	string	否	请求和接收消息的语言类型，默认值 zh。取值： zh：中文 en：英文	zh
SortTypes	array	否	检查项的排序类型列表。
	string	否	检查项的排序类型，当前固定取值 STATUS。	STATUS

返回参数

名称	类型	描述	示例值
	object	响应结构。
RequestId	string	本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。	3AB18264-8A1B-52A6-A9AF-A886556E0F2E
BasicData	array<object>	影响实例基础信息列表。
BasicData	object	影响实例基础信息。
Id	long	检查实例结果 ID。	300054
Status	string	检查项的状态列表。多个状态之间使用半角逗号（,）分隔。取值： PASS：通过 NOT_PASS：未通过 CHECKING：检查中 NOT_CHECK：未检查 WHITELIST：加白	NOT_PASS
RegionId	string	实例所在的地域的 ID。	ap-southeast-1
InstanceId	string	服务器实例 ID。	rm-m5es7ch1s62i4****
InstanceName	string	服务器实例的名称。	sg-t4nbk2aodzio52xv****
StatusMessage	string	检查项异常状态信息。	检查任务失败。
InstanceInfo	object	对应检查项展示实例的信息。
FirstUpdateTime	long	首次检查时间。	1716447535531
LastUpdateTime	long	最新检查时间。	1716447535531
Config	array<object>	对应修复配置展示当前实例信息。
config	object	实例信息的结构体。
Name	string	对应配置的名称，唯一。	prot
Value	string	当前资产对应配置的值。	8080
ShowName	string	对应配置项的国际化名称。	prot
Columns	array<object>	影响实例信息展示列表元数据。
Columns	object	影响实例信息展示列表元数据信息。
Type	string	检查实例结果属性类型。取值： text：文本 link：链接	text
Key	string	列表属性的键。	RegionIdShow
ShowName	string	展示名称。	Region
Search	boolean	是否支持搜索。取值： true：是 false：否	true
SearchKey	string	搜索使用的键。	InstanceIdKey
Grids	array<object>	列表类型元数据列表。
Grids	object	列表类型元数据。
Type	string	检查实例结果类型。取值： text：文本 link：链接	text
Key	string	搜索值。	RegionIdShow
ShowName	string	搜索展示名称。	Region
Checks	array<object>	影响实例扩展信息列表。	[{ "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****" } }]
Checks	object	影响实例扩展信息。
	any	检查项信息。	{ "InstanceIdShow": { "link": "https://vpcnext.console.aliyun.com/vpc/cn-beijing/vpcs", "value": "ngw-2zenx8j1lf5w8rcdhdqs5" }, "RegionIdShow": { "value": "China(Beijing)" } }
PageInfo	object	分页查询时页面显示的信息。
CurrentPage	integer	分页查询时，显示的当前页的页码。	1
PageSize	integer	分页查询时，显示的每页数据的最大条数。	20
TotalCount	integer	数据的总条数。	100
Count	string	返回结果的当前页显示数据条数。	20

示例

正常返回示例

JSON格式

{
  "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"
          }
        ]
      }
    }
  ],
  "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"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	caller has no permission	当前操作未被授权，请联系主账号在RAM控制台进行授权后再执行操作。
500	ServerError	ServerError	服务故障，请稍后重试！

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2024-04-29	OpenAPI 返回结构发生变更	查看变更详情
2024-03-14	API 内部配置变更，不影响调用	查看变更详情
2023-07-17	OpenAPI 返回结构发生变更	查看变更详情
2022-07-26	OpenAPI 返回结构发生变更	查看变更详情
2022-07-25	OpenAPI 返回结构发生变更	查看变更详情
2022-07-25	OpenAPI 返回结构发生变更	查看变更详情
2022-07-22	新增 OpenAPI	查看变更详情