GetCheckDetail - Security Center - Alibaba Cloud Documentation Center

Queries the details about a check item that is used for configuration assessment.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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:
- For mandatory resource types, indicate with a prefix of * .
- 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.

Operation	Access level	Resource type	Condition key	Associated operation
yundun-sas:GetCheckDetail	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
CheckId	long	Yes	The ID of the check item. Note You can call the ListCheckResult operation to query the IDs of check items.	2
Lang	string	No	The language of the content within the request and response. Default value: zh. Valid values: zh: Chinese. en: English.	en
RegionId	string	No	The region ID of the instance. Note You can call the ListCloudAssetInstances operation to query the region ID.	cn-hangzhou

Response parameters

Parameter	Type	Description	Example
	object	GetCheckDetailResponse
Description	object	The description of the check item.
Type	string	The description type of the check item. The value is fixed as text.	text
Value	string	The content in the description of the check item.	The MSE instance does not enable authentication by default. If public network access is enabled at the same time, the data in the configuration center may be dragged and there is a security risk.
Link	string	The link to the description of the check item.	https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies
Solution	object	The solution to handle the risk item.
Type	string	The type of the solution to handle the risk item. Valid values: text link	text
Value	string	The content of the solution to handle the risk item when the Type parameter is set to text.	Enter the MSE product console - registration and configuration center - instance list, click the corresponding instance name to enter the instance details, find the public network whitelist setting option in the basic information, and configure the whitelist according to business needs. It is forbidden to configure 0.0.0.0 or the whitelist as null.
Link	string	The link to the solution to handle the risk item when the Type parameter is set to link.	https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies
AssistInfo	object	The help information about the check item.
Type	string	The type of the help information about the risk item. Valid values: text link	text
Value	string	The content in the help information about the risk item when the Type parameter is set to text.	Configure an IP address whitelist
Link	string	The link to the help information about the risk item when the Type parameter is set to link.	https://www.alibabacloud.com/help/en/resource-access-management/latest/faq-about-ram-users
RequestId	string	The request ID.	15A6ED6A-DBFE-5255-A248-289907809BEC
CustomConfigs	array<object>	The custom configuration items of the check item.
CustomConfigs	object
Name	string	The name of the custom configuration item, which is unique in a check item.	SessionTimeMax
TypeDefine	string	The type of the custom configuration item. The value is a JSON string.	{\"type\":\"NUMBER\",\"range\":[1,24]}
DefaultValue	string	The default value of the custom configuration item. The value is a string.	12
Value	string	The value of the custom configuration item. The value is a string.	11
ShowName	string	The display name of the custom configuration item for internationalization.	Maximum session time
RepairReset`deprecated`	string	Note This parameter is deprecated.	true
RepairSupportType`deprecated`	integer	Note This parameter is deprecated.	1
RepairSetting	object	The fixing parameter configurations of the check item.
RepairSupport	boolean	Indicates whether the check item supports the quick fix feature. Valid values: true false	true
RepairSupportType	integer	The fixing type that is supported. Valid values: 1: The fixing and rollback are supported. 2: The fixing is supported, but the rollback is not supported. 3: The fixing must be performed on a third-party platform.	1
RepairReset	boolean	Indicates whether a restart is required after the fixing. Valid values: true false	true
RepairConfigs	array<object>	The configurations of the fixing parameters.
RepairConfigs	object
Name	string	The name of the parameter. The name must be unique within the check item.	navicat
TypeDefine	string	The type of the parameter. The value is a JSON string.	{\"type\":\"NUMBER\",\"range\":[1,24]}
DefaultValue	string	The default value of the parameter. The value is a string.	1
Value	string	The user-configured value of the parameter. The value is a string.	2
ShowName	string	The display name of the parameter.	port
FlowId	string	The ID of the fixing workflow.	64312d3ee19d470a9b54393dab****
CustomFlag	boolean	Indicates whether custom configurations of the fixing parameters are supported. Valid values: true false	true
ExclusiveName	array	The fixing parameters that are not compatible with this parameter.
exclusiveName	string	The fixing parameter that is not compatible with this parameter. You cannot configure the two parameters at the same time.	["port"]
ConsoleParamType	string	Indicates whether the value of the parameter is displayed in the console. Valid values: 0: The historical value and real-time value of the parameter are displayed. 1: Only the real-time value of the parameter is displayed. 2: The value of the parameter is not displayed in the console.	0
DataTransformType	string	Indicates whether data needs to be encrypted during transmission. Valid values: 0: Data does not need to be encrypted during transmission. 1: Data needs to be encrypted during transmission. 2: Data needs to be encrypted during transmission, and the user must perform secondary confirmation.	1
UsageType	string	The type of the parameter. Valid values: 1: asset parameters that are required during fixing. 2: user-provided parameters that are required during fixing. 3: parameters that are temporarily provided by the user.	1
EmptyParamSwitch	string	Indicates whether this parameter is specified by the user. Valid values: 0: The default value is used. 1: This parameter is required, and no default value is specified. 2: This parameter can be left empty.	1
FlowStep	array<object>	The description of the fixing workflow.
flowStep	object
Step	string	The sequence number of the fixing step.	1
ShowText	string	The text description of the fixing step.	The first step is to open the calling interface.

Examples

Sample success responses

JSONformat

{
  "Description": {
    "Type": "text",
    "Value": "The MSE instance does not enable authentication by default. If public network access is enabled at the same time, the data in the configuration center may be dragged and there is a security risk.",
    "Link": "https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies"
  },
  "Solution": {
    "Type": "text",
    "Value": "Enter the MSE product console - registration and configuration center - instance list, click the corresponding instance name to enter the instance details, find the public network whitelist setting option in the basic information, and configure the whitelist according to business needs. It is forbidden to configure 0.0.0.0 or the whitelist as null.",
    "Link": "https://www.alibabacloud.com/help/en/object-storage-service/latest/tutorial-implement-data-sharing-across-departments-based-on-bucket-policies"
  },
  "AssistInfo": {
    "Type": "text",
    "Value": "Configure an IP address whitelist",
    "Link": "https://www.alibabacloud.com/help/en/resource-access-management/latest/faq-about-ram-users"
  },
  "RequestId": "15A6ED6A-DBFE-5255-A248-289907809BEC",
  "CustomConfigs": [
    {
      "Name": "SessionTimeMax",
      "TypeDefine": "{\\\"type\\\":\\\"NUMBER\\\",\\\"range\\\":[1,24]}",
      "DefaultValue": "12",
      "Value": "11",
      "ShowName": "Maximum session time\n"
    }
  ],
  "RepairReset": "true",
  "RepairSupportType": 1,
  "RepairSetting": {
    "RepairSupport": true,
    "RepairSupportType": 1,
    "RepairReset": true,
    "RepairConfigs": [
      {
        "Name": "navicat",
        "TypeDefine": "{\\\"type\\\":\\\"NUMBER\\\",\\\"range\\\":[1,24]}\n",
        "DefaultValue": "1",
        "Value": "2",
        "ShowName": "port",
        "FlowId": "64312d3ee19d470a9b54393dab****",
        "CustomFlag": true,
        "ExclusiveName": [
          "[\"port\"]"
        ],
        "ConsoleParamType": "0",
        "DataTransformType": "1",
        "UsageType": "1",
        "EmptyParamSwitch": "1"
      }
    ],
    "FlowStep": [
      {
        "Step": "1",
        "ShowText": "The first step is to open the calling interface."
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
403	NoPermission	caller has no permission	You are not authorized to do this operation.
500	ServerError	ServerError	-

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

Change history

Change time	Summary of changes	Operation
2024-06-21	The response structure of the API has changed	View Change Details
2024-04-29	The response structure of the API has changed	View Change Details
2023-01-11	API Description Update. The API operation is not deprecated.	View Change Details
2022-07-22	Add Operation	View Change Details