All Products
Search
Document Center

Security Center:GetClusterRuleSummary

Last Updated:Nov 25, 2024

Queries the overall information about cluster defense rules that are configured for the container firewall feature.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterIdstringYes

The ID of the container cluster.

Note You can call the DescribeGroupedContainerInstances operation to query the IDs of container clusters.
cc49d88d1exxx

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

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

291B49F9-xxx
ClusterRuleSummaryobject

The overall information about the cluster defense rules.

InterceptionSwitchinteger

The status of the container firewall feature. Valid values:

  • 0: disabled
  • 1: enabled
0
CloseRuleCountinteger

The number of disabled cluster defense rules.

1
InterceptionTypeinteger

The interception mode.

0
RuleCountinteger

The total number of configured cluster defense rules.

10
OpenRuleCountinteger

The number of enabled cluster defense rules.

1
SuggestRuleCountinteger

The number of recommended cluster defense rules.

1
InterceptionCount7Daylong

The number of alerts that are triggered by the cluster defense rules in the last seven days.

10

Examples

Sample success responses

JSONformat

{
  "RequestId": "291B49F9-xxx",
  "ClusterRuleSummary": {
    "InterceptionSwitch": 0,
    "CloseRuleCount": 1,
    "InterceptionType": 0,
    "RuleCount": 10,
    "OpenRuleCount": 1,
    "SuggestRuleCount": 1,
    "InterceptionCount7Day": 10
  }
}

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
No change history