Query the protection status of the container firewall - Security Center - Alibaba Cloud - Security Center

Queries the status details of the container firewall.

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:ListClusterCnnfStatusDetail

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterIds	array	No	The list of cluster IDs.
	string	No	The cluster ID. Note You can call the DescribeContainerInstances operation to obtain this parameter.	c8dc3a999320948a5b9857d220917****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request. The China Chinese Cloud generates a unique ID for each request. You can use the ID to troubleshoot issues.	64329F40-5C94-51D3-A400-37AA7BAC****
Data	array<object>	The list of container firewall statuses.
	object	The details of the container firewall status.
Uuid	string	The UUID of the asset instance.	6690a46c-0edb-4663-a641-3629d1a9****
ClusterId	string	The cluster ID.	c8ca91e0907d94efaba7fb0827eb9****
InstanceId	string	The instance ID of the server.	i-bp180bogui4fc0z4****
MachineName	string	The name of the server.	security
PluginName	string	The name of the plug-in type. The value is fixed as alinet.	alinet
Installed	boolean	Indicates whether the container firewall plug-in is installed.	true
Status	string	The online status of the plug-in. Valid values: false: offline true: online.	false
InternetIp	string	The public IP address of the associated instance.	172.16.XX.XX
IntranetIp	string	The private IP address of the associated instance.	10.42.XX.XX
MachineType	integer	The type of the instance. The value is fixed as ecs.	ecs
PluginVersion	string	The version of the plug-in.	3.3
InvalidType	string	The invalid type of the plug-in. Valid values: PLUGIN_OFFLINE: offline PLUGIN_NOT_INSTALLED: not installed PLUGIN_INVALID_VERSION: invalid version.	PLUGIN_OFFLINE

Examples

Success response

JSON format

{
  "RequestId": "64329F40-5C94-51D3-A400-37AA7BAC****",
  "Data": [
    {
      "Uuid": "6690a46c-0edb-4663-a641-3629d1a9****",
      "ClusterId": "c8ca91e0907d94efaba7fb0827eb9****",
      "InstanceId": "i-bp180bogui4fc0z4****",
      "MachineName": "security",
      "PluginName": "alinet",
      "Installed": true,
      "Status": "false",
      "InternetIp": "172.16.XX.XX",
      "IntranetIp": "10.42.XX.XX",
      "MachineType": 0,
      "PluginVersion": "3.3",
      "InvalidType": "PLUGIN_OFFLINE"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
500	ServerError	ServerError
403	NoPermission	caller has no permission

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.