All Products
Search
Document Center

Security Center:GetModuleConfigStatus

Last Updated:Nov 25, 2024

Checks whether the purchased Security Center features are enabled and whether related configurations take effect.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ModuleNamesarrayYes

The service modules that you want to query.

ModuleNamestringYes

The name of the check item that you want to query. Valid values:

  • Ransom: The anti-ransomware policy is enabled.
  • WebLock: The web tamper proofing feature is enabled.
  • Rasp: Applications are added to the application protection feature.
  • Image: The container images that can be scanned are specified.
  • Virus: The periodic virus scan policy is enabled.
Rasp

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

Dataobject

The data returned.

ModuleConfigResultsarray<object>

The check results of the service modules.

ModuleConfigResultobject

The check results of the service module.

Passboolean

Indicates whether the service module passed the status check. Valid values:

  • true
  • false
true
ModuleNamestring

The name of the check item. Valid values:

  • Ransom: The anti-ransomware policy is enabled.
  • WebLock: The web tamper proofing feature is enabled.
  • Rasp: Applications are added to the application protection feature.
  • Image: The container images that can be scanned are specified.
  • Virus: The periodic virus scan policy is enabled.
Ransom
RequestIdstring

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

843E4805-****-7EE12FA8DBFD

Examples

Sample success responses

JSONformat

{
  "Data": {
    "ModuleConfigResults": [
      {
        "Pass": true,
        "ModuleName": "Ransom"
      }
    ]
  },
  "RequestId": "843E4805-****-7EE12FA8DBFD"
}

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.