All Products
Search
Document Center

Security Center:ListClusterInterceptionConfig

Last Updated:Nov 25, 2024

Queries the defense rules that are created for a cluster.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ClusterCNNFStatusintegerNo

The status of the container firewall feature. Valid values:

  • -1: unknown
  • 0: abnormal
  • 1: normal
  • 2: normal to be confirmed
1
ClusterNamestringNo

The name of the cluster.

sas
PageSizeintegerNo

The number of entries to return on each page. Default value: 20.

20
CurrentPageintegerNo

The number of the page to return. Default value: 1.

1
ClusterIdstringNo

The ID of the cluster.

Note You can call the DescribeContainerInstances operation to query the IDs of clusters.
c22143730ab6e40b09ec7c1c51d4d****

Response parameters

ParameterTypeDescriptionExample
object

The data returned.

RequestIdstring

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

49FDE92F-A0B8-56CC-B7A8-23B17646****
ClusterConfigListarray<object>

An array that consists of the configurations of the cluster.

ClusterConfigobject

The configuration of the cluster.

ClusterNamestring

The name of the cluster.

container-opa-kill-02
InterceptionSwitchinteger

The status of the defense rule. Valid values:

  • 0: disabled
  • 1: enabled
1
ClusterIdstring

The ID of the cluster.

c9051d30d8a044b4d99e1cb5d25ac****
ClusterCNNFStatusinteger

The status of the container firewall feature. Valid values:

  • -1: unknown
  • 0: abnormal
  • 1: normal
  • 2: normal to be confirmed
0
OpenRuleCountlong

The number of defense rules that are in effect.

12
TotalRuleCountlong

The total number of defense rules.

123
SupportCNNFboolean

Indicates whether the container firewall feature is supported.

false
ClusterTypestring

The type of the cluster. Valid values:

  • ManagedKubernetes: managed Kubernetes cluster
  • NotManagedKubernetes: non-managed Kubernetes cluster
  • PrivateKubernetes: private cluster
  • kubernetes: dedicated Kubernetes cluster
  • ask: dedicated serverless Kubernetes (ASK) cluster
ManagedKubernetes
PageInfoobject

The pagination information.

TotalCountinteger

The total number of entries returned.

11
Countinteger

The number of entries returned on the current page.

11
CurrrentPageinteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

20

Examples

Sample success responses

JSONformat

{
  "RequestId": "49FDE92F-A0B8-56CC-B7A8-23B17646****",
  "ClusterConfigList": [
    {
      "ClusterName": "container-opa-kill-02",
      "InterceptionSwitch": 1,
      "ClusterId": "c9051d30d8a044b4d99e1cb5d25ac****",
      "ClusterCNNFStatus": 0,
      "OpenRuleCount": 12,
      "TotalRuleCount": 123,
      "SupportCNNF": false,
      "ClusterType": "ManagedKubernetes"
    }
  ],
  "PageInfo": {
    "TotalCount": 11,
    "Count": 11,
    "CurrrentPage": 1,
    "PageSize": 20
  }
}

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.