AllocateContextDBPublicConnection - PolarDB - Alibaba Cloud Documentation Center

Enables a public network connection for a ContextDB-X service ReplicaSet.

Operation description

This operation is used to confirm that no active connections exist before a rollback task, ensuring operation safety.

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
RegionId	string	Yes	The region in which the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-xxx
ConnectionStringPrefix	string	No	The prefix of the public network connection string.	pxc-**************
Port	string	No	The port.	3306
NodeType	string	No	The type of the target node. Valid values: service and dashboard.	service

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	C458B1E8-1683-3645-B154-6BA32080EEA
Data	object	The task details.
DBInstanceId	integer	The instance ID.	pxsp-xxxxxxxxxx
DBInstanceName	string	The instance ID.	pxsp-*********
DBInstanceNetType	integer	The network type of the endpoint.	1
Vip	string	The IP address of the Anti-DDoS Proxy instance protected by the policy.	https://anchashi.aliyun-inc.coM
ConnectionString	string	The endpoint.	test2.polarx.huhehaote.rds.aliyuncs.com
Port	string	The port of the endpoint.	3300
TaskId	integer	The backend task ID.	2209883
ContextDBInstanceName	string	The name of the context service instance.	pxt-********
NodeType	string	The type of the target node. Valid values: service and dashboard.	service
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The type of the authentication principal.	222
AuthPrincipalOwnerId	string	The type of the authentication principal.	111
AuthPrincipalDisplayName	string	The identity used for authentication in the request.	xxx
PolicyType	string	PolicyType	System
NoPermissionType	string	The type of the permission denial.	ImplicitDeny
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Data": {
    "DBInstanceId": 0,
    "DBInstanceName": "pxsp-*********",
    "DBInstanceNetType": 1,
    "Vip": "https://anchashi.aliyun-inc.coM",
    "ConnectionString": "test2.polarx.huhehaote.rds.aliyuncs.com",
    "Port": "3300",
    "TaskId": 2209883,
    "ContextDBInstanceName": "pxt-********",
    "NodeType": "service"
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "System",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.