DescribeAckClusterConnector-阿里云帮助中心

Queries the details of a specified ACK cluster connector.

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

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ConnectorId	string	Yes	The ID of the ACK cluster connector. You can obtain the value from: DescribeAckClusterConnectors: Lists ACK cluster connectors.	ac-7c1bad6c3cc84c33baab
Lang	string	No	The language in which the health status error reason of the ACK cluster connector is displayed. Valid values: en : English. zh : Chinese (default).	zh

Response elements

Element	Type	Description	Example
	object
AckClusterConnector	object	The ACK cluster connector.
ConnectorId	string	The ID of the ACK cluster connector. You can obtain the value from: DescribeAckClusterConnectors: Lists ACK cluster connectors.	ac-7c1bad6c3cc84c33baab
ConnectorName	string	The name of the ACK cluster connector. The name is 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.	135809047715****
RegionNo	string	The region ID of the ACK cluster connector. You can obtain the value from: 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-beijing
ClusterId	string	The ID of the ACK cluster. You can obtain the value from: DescribeAckClusters: Lists ACK clusters.	c857d908016794125883a9ee8196cba17
ClusterName	string	The name of the ACK cluster.	ack-cluster-name
VpcId	string	The instance ID of the VPC-connected instance to which the ACK cluster belongs.	vpc-j6cvhdscntzuvr0x****
Ttl	integer	The synchronization interval of the ACK cluster connector. Valid values: 2 to 60. Unit: seconds.	30
PrimaryVswitchId	string	The primary vSwitch of the ACK cluster connector. You can obtain the value from: DescribeAccessInstanceVSwitchList: Lists vSwitches of synchronization nodes.	vsw-2zerfbbje7dvnbii2****
PrimaryVswitchZoneId	string	The zone of the primary vSwitch of the ACK cluster connector. You can obtain the value from: DescribeAccessInstanceZoneList: Lists zones of synchronization node vSwitches.	cn-beijing-g
PrimaryVswitchIp	string	The IP address of the primary vSwitch of the ACK cluster connector.	10.100.1.1
StandbyVswitchId	string	The standby vSwitch of the ACK cluster connector. You can obtain the value from: DescribeAccessInstanceVSwitchList: Lists vSwitches of synchronization nodes.	vsw-2ze2gtlfozrab01cfo****
StandbyVswitchZoneId	string	The zone of the standby vSwitch of the ACK cluster connector. You can obtain the value from: DescribeAccessInstanceZoneList: Lists zones of synchronization node vSwitches.	cn-beijing-h
StandbyVswitchIp	string	The IP address of the standby vSwitch of the ACK cluster connector.	10.100.2.1
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.
CreateTime	string	The timestamp when the ACK cluster connector was created. Unit: seconds.	1724982259
RequestId	string	The request ID.	45E2E720-D2B4-506F-B682-1FCBE971****

Examples

Success response

JSON format

{
  "AckClusterConnector": {
    "ConnectorId": "ac-7c1bad6c3cc84c33baab",
    "ConnectorName": "ack-cluster-connector-name",
    "MemberUid": "135809047715****\n",
    "RegionNo": "cn-beijing",
    "ClusterId": "c857d908016794125883a9ee8196cba17",
    "ClusterName": "ack-cluster-name",
    "VpcId": "vpc-j6cvhdscntzuvr0x****",
    "Ttl": 30,
    "PrimaryVswitchId": "vsw-2zerfbbje7dvnbii2****",
    "PrimaryVswitchZoneId": "cn-beijing-g",
    "PrimaryVswitchIp": "10.100.1.1",
    "StandbyVswitchId": "vsw-2ze2gtlfozrab01cfo****",
    "StandbyVswitchZoneId": "cn-beijing-h",
    "StandbyVswitchIp": "10.100.2.1",
    "ConnectorStatus": "ready",
    "ConnectorHealthCheckStatus": "healthy",
    "UnhealthyReason": "The ACK cluster status is unavailable.",
    "CreateTime": "1724982259"
  },
  "RequestId": "45E2E720-D2B4-506F-B682-1FCBE971****"
}

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	ErrorDBSelect	An error occurred while querying database.	An error occurred while querying database.
404	ErrorAckClusterConnectorNotFound	The specified resource ACK cluster connector is not found.	The specified resource ACK cluster connector is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.