EnableOpenSearchPublicEndpoint - PolarDB - Alibaba Cloud Documentation Center

Enables public network access for PolarDBX Search.

Operation description

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 ID.	cn-shanghai
DBInstanceName	string	Yes	The instance ID.	pxc-********
NodeType	string	No	The target node type. Valid values: search: data node. This is the default value. dashboard: dashboard node.	search

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	1A586DCB-39A6-4050-81CC-C7BD4CCDB49F
Host	string	The host required for upload.	https://sddp-datamask.oss-cn-zhangjiakou.aliyuncs.com
Port	integer	The public endpoint port.	3306
Message	string	The additional information returned by the operation. "success" is returned if the operation is successful. Otherwise, the corresponding error code is returned.	*****
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 description is the same as above.	111
AuthPrincipalDisplayName	string	The display name of the authentication principal.	xxx
PolicyType	string	The policy type.	PRIORITY
NoPermissionType	string	The type of the permission denial.	ImplicitDeny
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F",
  "Host": "https://sddp-datamask.oss-cn-zhangjiakou.aliyuncs.com",
  "Port": 3306,
  "Message": "*****",
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.