All Products
Search
Document Center

Security Center:GetCheckDetail

最終更新日:Nov 25, 2024

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.

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:GetCheckDetailget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CheckIdlongYes

The ID of the check item.

2
LangstringNo

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

  • zh: Chinese
  • en: English
en
RegionIdstringNo

The ID of the region in which the server resides.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

GetCheckDetailResponse

Descriptionobject

The description of the check item.

Typestring

The type of the description of the check item. The value is fixed as text.

text
Valuestring

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.
Solutionobject

The solution to handle the risk item.

Typestring

The type of the solution to handle the risk item. Valid values:

  • text
  • link
text
Valuestring

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.
AssistInfoobject

The help information about the check item.

Typestring

The type of the help information about the risk item. Valid values:

  • text
  • link
text
Valuestring

The content in the help information about the risk item when the Type parameter is set to text.

Configure an IP address whitelist
RequestIdstring

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

15A6ED6A-DBFE-5255-A248-289907809BEC
CustomConfigsarray<object>

The custom configuration items of the check item.

CustomConfigsobject
Namestring

The name of the custom configuration item. The name of a custom configuration item is unique in a check item.

SessionTimeMax
TypeDefinestring

The type of the custom configuration item. The value is a JSON string.

{\"type\":\"NUMBER\",\"range\":[1,24]}
DefaultValuestring

The default value of the custom configuration item. The value is a string.

12
Valuestring

The value of the custom configuration item. The value is a string.

11
ShowNamestring

The keyword that identifies the custom configuration item for internationalization.

Maximum session time

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

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-06-21The response structure of the API has changedView Change Details
2024-04-29The response structure of the API has changedView Change Details
2023-01-11API Description Update. The API operation is not deprecated.View Change Details
2022-07-22Add OperationView Change Details