All Products
Search
Document Center

Security Center:GetCheckConfig

Last Updated:Feb 20, 2024

Queries the information about an automatic configuration check on cloud services.

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

Request parameters

ParameterTypeRequiredDescriptionExample
The current API does not require request parameters

Response parameters

ParameterTypeDescriptionExample
object

GetCheckConfigResponse

CycleDaysarray

The days in a week on which an automatic check is performed.

integer

The day of a week on which an automatic check is performed.

[1, 2, 3, 4, 5]
StartTimeinteger

The start time of the check. The value indicates a point in time.

0
EndTimeinteger

The end time of the check. The value indicates a point in time. The time period that is specified by the start time and end time must be one of the following time periods:

  • 00:00 to 06:00: If StartTime is set to 00:00, EndTime must be set to 06:00.
  • 06:00 to 12:00: If StartTime is set to 06:00, EndTime must be set to 12:00.
  • 12:00 to 18:00: If StartTime is set to 12:00, EndTime must be set to 18:00.
  • 18:00 to 24:00: If StartTime is set to 18:00, EndTime must be set to 24:00.
6
Standardsobject []

The information about the check items.

Idlong

The ID of the check item.

1
ShowNamestring

The name of the check item.

Cloud service configuration management
Typestring

The type of the check item. Valid values:

  • RISK: cloud service configuration management
  • IDENTITY_PERMISSION: identity and permission management
  • COMPLIANCE: compliance
RISK
Statusstring

The status of the check item. Valid values:

  • ON: The check item is enabled.
  • OFF: The check item is disabled.
ON
RequestIdstring

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

5A3D5C8F-2A42-5477-BDD8-27E64B5F1739
EnableAutoCheckboolean

Indicates whether the automatic check is enabled. Valid values:

  • true
  • false
true
EnableAddCheckboolean

Indicates whether the check for new check items in the selected requirement item is enabled by default. Valid values:

  • true
  • false
false
SelectedChecksobject []

The check items selected in the policy.

CheckIdlong

The ID of the check item.

3
SectionIdlong

The section ID of the check item.

69

Examples

Sample success responses

JSONformat

{
  "CycleDays": [
    0
  ],
  "StartTime": 0,
  "EndTime": 6,
  "Standards": [
    {
      "Id": 1,
      "ShowName": "Cloud service configuration management\n",
      "Type": "RISK",
      "Status": "ON"
    }
  ],
  "RequestId": "5A3D5C8F-2A42-5477-BDD8-27E64B5F1739",
  "EnableAutoCheck": true,
  "EnableAddCheck": false,
  "SelectedChecks": [
    {
      "CheckId": 3,
      "SectionId": 69
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParamIllegal param-
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
2023-07-17The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-01-11API Description Update. The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: CheckGroupId
    delete Input Parameters: Lang