GetModuleConfigStatus API Reference & Parameters - Security Center - Alibaba Cloud - Security Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-sas:GetModuleConfigStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ModuleNames	array	Yes	The service modules that you want to query.
	string	No	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 elements

Element	Type	Description	Example
	object	The response parameters.
Data	object	The data returned.
ModuleConfigResults	array<object>	The check results of the service modules.
	object	The check results of the service module.
Pass	boolean	Indicates whether the service module passed the status check. Valid values: true false	true
ModuleName	string	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
RequestId	string	The request ID, which is used to locate and troubleshoot issues.	843E4805-****-7EE12FA8DBFD

Examples

Success response

JSON format

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

Error codes

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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.