Register ACK Cluster Connector Using CreateAckClusterConnector API - Cloud Firewall - Alibaba Cloud - Cloud Firewall

Creates an ACK cluster connector.

Operation description

Rate limit

The single-user QPS limit for this operation is 10 calls per second. If the number of calls exceeds the limit, throttling is triggered, which 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:CreateAckClusterConnector

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MemberUid	string	No	The Alibaba Cloud UID of the account to which the ACK cluster resource belongs.	135809047715****
RegionNo	string	Yes	The region ID of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceRegionList: Lists the regions of synchronization nodes. Note For more information about the regions supported by ACK cluster connectors in Cloud Firewall, see ACK cluster synchronization nodes.	cn-hangzhou
ConnectorName	string	Yes	The name of the ACK cluster connector. The name must be 1 to 64 characters in length and can contain letters, digits, Chinese characters, periods (.), underscores (_), and hyphens (-).	ack-cluster-connector-name
ClusterId	string	Yes	The ACK cluster ID. You can call the following operation to obtain the value: DescribeAckClusters: Lists ACK clusters.	cb0f5640b1b2d404cad6ba21509d7847b
PrimaryVswitchId	string	Yes	The primary vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceVSwitchList: Lists the vSwitches of synchronization nodes.	vsw-2zerfbbje7dvnbii2****
PrimaryVswitchIp	string	No	The IP address of the primary vSwitch of the ACK cluster connector.	10.100.1.1
StandbyVswitchId	string	No	The standby vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceVSwitchList: Lists the vSwitches of synchronization nodes.	vsw-2ze2gtlfozrab01cfo****
StandbyVswitchIp	string	No	The IP address of the standby vSwitch of the ACK cluster connector.	10.100.2.1
Ttl	string	Yes	The synchronization interval of the ACK cluster connector. Valid values: 2 to 60. Unit: seconds.	30

Response elements

Element	Type	Description	Example
	object
AckClusterConnector	object	The ACK cluster connector information.
ConnectorId	string	The unique 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 letters, digits, Chinese characters, 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 call the following operation to obtain the value: DescribeAccessInstanceRegionList: Lists the regions of synchronization nodes. 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: Lists ACK clusters.	cb0f5640b1b2d404cad6ba21509d7847b
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****
PrimaryVswitchId	string	The primary vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceVSwitchList: Lists the vSwitches of synchronization nodes.	vsw-2zerfbbje7dvnbii2****
PrimaryVswitchZoneId	string	The zone of the primary vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceZoneList: Lists the zones of vSwitches for synchronization nodes.	cn-hangzhou-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 call the following operation to obtain the value: DescribeAccessInstanceVSwitchList: Lists the vSwitches of synchronization nodes.	vsw-2ze2gtlfozrab01cfo****
StandbyVswitchZoneId	string	The zone of the standby vSwitch of the ACK cluster connector. You can call the following operation to obtain the value: DescribeAccessInstanceZoneList: Lists the zones of vSwitches for synchronization nodes.	cn-hangzhou-h
StandbyVswitchIp	string	The IP address of the standby vSwitch of the ACK cluster connector.	10.100.2.1
Ttl	integer	The synchronization interval of the ACK cluster connector. Valid values: 2 to 60. Unit: seconds.	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
AckClientHostIp	string	The entry point IP address used by the ACK cluster connector to access the ACK cluster over the internal network.	10.40.32.240
TaskId	string	The unique ID of the task for creating the ACK cluster connector.	task-c92d4544ef7b6a42
CreateTime	string	The timestamp when the ACK cluster connector was created. Unit: seconds.	1724982259
RequestId	string	The request ID.	0DC783F1-B3A7-578D-8A63-*****

Examples

Success response

JSON format

{
  "AckClusterConnector": {
    "ConnectorId": "ac-7c1bad6c3cc84c33baab",
    "ConnectorName": "ack-cluster-connector-name",
    "MemberUid": "135809047715****",
    "RegionNo": "cn-shanghai",
    "ClusterId": "cb0f5640b1b2d404cad6ba21509d7847b",
    "ClusterName": "ack-cluster-name",
    "VpcId": "vpc-j6cvhdscntzuvr0x****",
    "PrimaryVswitchId": "vsw-2zerfbbje7dvnbii2****",
    "PrimaryVswitchZoneId": "cn-hangzhou-g",
    "PrimaryVswitchIp": "10.100.1.1",
    "StandbyVswitchId": "vsw-2ze2gtlfozrab01cfo****",
    "StandbyVswitchZoneId": "cn-hangzhou-h",
    "StandbyVswitchIp": "10.100.2.1",
    "Ttl": 30,
    "ConnectorStatus": "ready",
    "ConnectorHealthCheckStatus": "healthy",
    "AckClientHostIp": "10.40.32.240",
    "TaskId": "task-c92d4544ef7b6a42",
    "CreateTime": "1724982259"
  },
  "RequestId": "0DC783F1-B3A7-578D-8A63-*****"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

HTTP status code	Error code	Error message	Description
400	ErrorVSwitchAndPrivateIpAddressMismatched	The vSwitch and privateIpAddress are mismatched.	The vSwitch and privateIpAddress are mismatched.
400	ErrorAckClusterNotFound	The specified resource ACK cluster is not found.	The specified resource ACK cluster is not found.
400	ErrorAckClusterConnectorReverseEndpointIpNotAllocated	The IP is already allocated, failed to create reverse endpoint.	The IP is already allocated, failed to create reverse endpoint.
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.
400	ErrorVswitchNoAvailableIP	the vswitch has no available ip.	No IP available for the specified switch
400	ErrorVswitchNotFound	vswitch not found	The vSwitch does not exist. Select another vSwitch.
400	ErrorDBInsert	An error occurred while performing an insert operation in the database.	An error occurred while performing an insert operation in the database.
400	ErrorAckClusterNetworkOnlySupportTerway	The ACK cluster network only support Terway.	The ACK cluster network only support Terway.
400	ErrorAckVpcAndVSwitchVpcMismatched	The ACK VPC and vSwitch VPC are mismatched.	The ACK VPC and vSwitch VPC are mismatched.
400	ErrorPrimaryStandbyVswitchSameZone	The primary and standby vSwitch are in the same availability zone.	The primary and standby vSwitch are in the same availability zone.
400	ErrorAckClusterSpecOnlySupportAckPro	The ACK cluster spec only support ack.pro.small.	The ACK cluster spec only support ack.pro.small.
400	ErrorAckClusterConnectorQuotaExceeded	ACK cluster connector resource exceeds the quota limit.	ACK cluster connector resource exceeds the quota limit.
400	ErrorAckNotOpen	ACK service is not open.	ACK service is not open.
400	ErrorAckClusterConnectorExist	The ACK cluster connector already exist.	The ACK cluster connector already exist.