DescribeAckClusterConnectors-阿里云帮助中心

Queries a list of ACK cluster connectors in batches.

Operation description

QPS limit

The single-user QPS limit for this operation is 10 calls per second. If the number of calls per second exceeds the limit, throttling is triggered. This may affect your business. Manage your calls properly.

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-cloudfirewall:DescribeAckClusterConnectors

get

*All Resource

*

None

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 of the account to which the ACK cluster resource belongs.	135809047715****
RegionNo	string	No	The region ID of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceRegionList: Queries the list of synchronization node regions. Note For more information about the regions supported by ACK cluster connectors in Cloud Firewall, see ACK cluster synchronization nodes.	cn-shenzhen
ConnectorName	string	No	The name of the ACK cluster connector.	test
VpcId	string	No	The instance ID of the VPC-connected instance to which the ACK cluster belongs.	vpc-uf6b5lyul0x******
ClusterId	string	No	The ACK cluster ID.	0E0C30C977463****
Lang	string	No	The language in which the unhealthy reason of the ACK cluster connector health status is displayed. Valid values: en : English. zh : Chinese (default).	zh

Response elements

Element	Type	Description	Example
	object
PageNo	integer	The page number.	1
AckClusterConnectors	array<object>	The list of ACK cluster connectors.
	object	The 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 and can contain Chinese characters, uppercase and lowercase letters, digits, periods (.), underscores (_), and hyphens (-).	ack-cluster-connector-name
MemberUid	string	The Alibaba Cloud UID of the account to which the ACK cluster resource belongs.	159663371500****
RegionNo	string	The region ID of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceRegionList: Queries the list of synchronization node regions. Note For more information about the regions supported by ACK cluster connectors in Cloud Firewall, see ACK cluster synchronization nodes.	cn-shanghai
ClusterId	string	The ACK cluster ID. You can call the following operation to obtain the value: DescribeAckClusters: Queries a list of ACK clusters in batches.	f9b9815a5280****
ClusterName	string	The name of the ACK cluster.	TestClusterA
VpcId	string	The instance ID of the VPC-connected instance to which the ACK cluster belongs.	vpc-j6cvhdscntzuvr0x****
PrimaryVswitchId	string	The primary vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceVSwitchList: Queries the list of synchronization node vSwitches in batches.	vsw-2ze2gtlfozrab01cfo****
PrimaryVswitchZoneId	string	The zone of the primary vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceZoneList: Queries the list of synchronization node vSwitch zones in batches.	cn-beijing-g
PrimaryVswitchIp	string	The IP address of the primary vSwitch of the ACK cluster connector.	10.100.2.XXX
StandbyVswitchId	string	The standby vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceVSwitchList: Queries the list of synchronization node vSwitches in batches.	vsw-2zerfbbje7dvnbii2****
StandbyVswitchZoneId	string	The zone of the standby vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceZoneList: Queries the list of synchronization node vSwitch zones in batches.	cn-beijing-h
StandbyVswitchIp	string	The IP address of the standby vSwitch of the ACK cluster connector.	10.100.1.XXX
Ttl	integer	The container synchronization cycle 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	The list of address book UUIDs created on the ACK cluster connector.
	string	The UUID of the address book created on the ACK cluster connector.	["b84dec36-c4fc-458e-98b8-f1b5dd23**","8015d9eb-8382-4388-b965-b92d806d**"]
CreateTime	string	The 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 returned.	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.