Updated on 2026-04-03 GMT+08:00

Querying Causes of Check Item Repair Failures

Function

This API is used to query reasons for failed repair attempts of an inspection item.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

GET /v5/{project_id}/baseline/check-rule/fail-detail

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

enterprise_project_id

No

String

Definition

Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID.

To query assets in all enterprise projects, set this parameter to all_granted_eps.

Constraints

You need to set this parameter only after the enterprise project function is enabled.

Range

The value can contain 1 to 256 characters.

Default Value

0: default enterprise project.

host_id

No

String

Definition

Unique ID of a server.

Constraints

N/A

Range

The value can contain 1 to 64 characters.

Default Value

N/A

check_name

No

String

Definition

Configuration check baseline name, for example, SSH, CentOS 7, or Windows.

Constraints

N/A

Range

The value can contain 1 to 256 characters.

Default Value

N/A

check_rule_id

Yes

String

Definition

Check item ID, which can be obtained from the return data of the API /v5/{project_id}/baseline/risk-config/{check_name}/check-rules.

Constraints

N/A

Range

The value can contain 0 to 255 characters.

Default Value

N/A

standard

No

String

Definition

Standard type.

Constraints

N/A

Range

  • cn_standard: DJCP MLPS compliance standard

  • hw_standard: Cloud security practice standard

cis_standard: general security standard

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token.

Constraints

N/A

Range

The value can contain 1 to 32,768 characters.

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

fail_detail_list

Array of CheckRuleFixFailDetailInfo objects

List of repair failure causes.

Table 5 CheckRuleFixFailDetailInfo

Parameter

Type

Description

fix_fail_reason

String

Definition

Cause of fix failure.

Range

The value can contain 0 to 65,534 characters.

host_name

String

Definition

Server name.

Range

The value can contain 1 to 256 characters.

Example Requests

None

Example Responses

Status code: 200

Request succeeded.

{
  "fail_detail_list" : [ {
    "host_name" : "host name",
    "fix_fail_reason" : "fix error"
  } ]
}

Status Codes

Status Code

Description

200

Request succeeded.

Error Codes

See Error Codes.