DescribeAckClusterConnectors API Reference - Cloud Firewall

Queries a list of ACK cluster connectors in batches.

Operation description

QPS limit

This API has a per-user limit of 10 queries per second (QPS). If you exceed this limit, API calls are rate-limited. This may affect your business, so pace your calls accordingly.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
PageNo	string	Yes	The page number.	1
PageSize	string	Yes	The number of entries per page.	10
MemberUid	string	No	The Alibaba Cloud UID to which the ACK cluster resource belongs.	135809047715****
RegionNo	string	No	The region ID of the ACK cluster connector. Source of values: DescribeAccessInstanceRegionList: Query the list of synchronization node regions. Note For more information about the regions supported by Cloud Firewall for ACK cluster connectors, see ACK Cluster Synchronization Nodes.	cn-shenzhen
ConnectorName	string	No	The name of the ACK cluster connector.	test
VpcId	string	No	The VPC instance ID to which the ACK cluster belongs.	vpc-uf6b5lyul0x******
ClusterId	string	No	The ID of the ACK cluster.	0E0C30C977463****
Lang	string	No	The language type for displaying the error reason for the ACK cluster connector's health status. Valid values: en : English zh : Chinese (default)	zh

Response elements

Element	Type	Description	Example
	object
PageNo	integer	The page number.	1
AckClusterConnectors	array<object>	A list of ACK cluster connectors.
	object	An ACK cluster connector.
ConnectorId	string	The ID of the ACK cluster connector.	ac-7c1bad6c3cc84c33baab
ConnectorName	string	The name of the ACK cluster connector. The name must be 1 to 64 characters in length. It can contain Chinese characters, letters, digits, periods (.), underscores (_), and hyphens (-).	ack-cluster-connector-name
MemberUid	string	The UID of the Alibaba Cloud account to which the ACK cluster resources belong.	159663371500****
RegionNo	string	The region ID of the ACK cluster connector. You can obtain this value from: DescribeAccessInstanceRegionList: Queries the list of regions for sync nodes. Note For more information about the regions that Cloud Firewall supports for ACK cluster connectors, see ACK cluster sync nodes.	cn-shanghai
ClusterId	string	The ID of the ACK cluster. You can obtain this value from: DescribeAckClusters: Queries the list of ACK clusters.	f9b9815a5280****
ClusterName	string	The name of the ACK cluster.	TestClusterA
VpcId	string	The ID of the VPC to which the ACK cluster belongs.	vpc-j6cvhdscntzuvr0x****
PrimaryVswitchId	string	The primary vSwitch of the ACK cluster connector. You can obtain this value from: DescribeAccessInstanceVSwitchList: Queries the list of vSwitches for sync nodes.	vsw-2ze2gtlfozrab01cfo****
PrimaryVswitchZoneId	string	The zone of the primary vSwitch for the ACK cluster connector. You can obtain this value from: DescribeAccessInstanceZoneList: Queries the list of zones for the vSwitches of sync nodes.	cn-beijing-g
PrimaryVswitchIp	string	The IP address of the primary vSwitch for the ACK cluster connector.	10.100.2.XXX
StandbyVswitchId	string	The Secondary vSwitch of the ACK cluster connector. You can obtain this value from: DescribeAccessInstanceVSwitchList: Queries the list of vSwitches for sync nodes.	vsw-2zerfbbje7dvnbii2****
StandbyVswitchZoneId	string	The zone of the secondary vSwitch for the ACK cluster connector. You can obtain this value from: DescribeAccessInstanceZoneList: Queries the list of zones for the vSwitches of sync nodes.	cn-beijing-h
StandbyVswitchIp	string	The IP address of the secondary vSwitch for the ACK cluster connector.	10.100.1.XXX
Ttl	integer	The container synchronization epoch of the ACK cluster connector.	30
ConnectorStatus	string	The instance status of the ACK cluster connector. Valid values: init : Initializing deleting : Deleting ready : Normal	ready
ConnectorHealthCheckStatus	string	The health check status of the ACK cluster connector. Valid values: init : Initializing healthy : Healthy unhealthy : Unhealthy	healthy
UnhealthyReason	string	The reason why the ACK cluster connector is unhealthy.	The ACK cluster status is unavailable.
GroupUuids	array	A list of UUIDs of the address books that are created for the ACK cluster connector.
	string	The UUID of an address book that is created for the ACK cluster connector.	["b84dec36-c4fc-458e-98b8-f1b5dd23**","8015d9eb-8382-4388-b965-b92d806d**"]
CreateTime	string	The UNIX timestamp when the ACK cluster connector was created. Unit: seconds.	1760493347
PageSize	integer	The number of entries per page.	10
RequestId	string	The request ID.	E7F333E0-7B70-54DA-A307-4B2B49DE****
TotalCount	integer	The total number of entries.	20

Examples

Success response

JSON format

{
  "PageNo": 1,
  "AckClusterConnectors": [
    {
      "ConnectorId": "ac-7c1bad6c3cc84c33baab",
      "ConnectorName": "ack-cluster-connector-name",
      "MemberUid": "159663371500****",
      "RegionNo": "cn-shanghai",
      "ClusterId": "f9b9815a5280****",
      "ClusterName": "TestClusterA",
      "VpcId": "vpc-j6cvhdscntzuvr0x****",
      "PrimaryVswitchId": "vsw-2ze2gtlfozrab01cfo****",
      "PrimaryVswitchZoneId": "cn-beijing-g",
      "PrimaryVswitchIp": "10.100.2.XXX",
      "StandbyVswitchId": "vsw-2zerfbbje7dvnbii2****",
      "StandbyVswitchZoneId": "cn-beijing-h",
      "StandbyVswitchIp": "10.100.1.XXX\n",
      "Ttl": 30,
      "ConnectorStatus": "ready",
      "ConnectorHealthCheckStatus": "healthy",
      "UnhealthyReason": "The ACK cluster status is unavailable.",
      "GroupUuids": [
        "[\"b84dec36-c4fc-458e-98b8-f1b5dd23****\",\"8015d9eb-8382-4388-b965-b92d806d****\"]"
      ],
      "CreateTime": "1760493347"
    }
  ],
  "PageSize": 10,
  "RequestId": "E7F333E0-7B70-54DA-A307-4B2B49DE****",
  "TotalCount": 20
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorParameters	Parameters error.	Parameter error.
400	ErrorRegionNo	regionNo error.	Region selection error, please re-enter.
400	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.