ModifyOpenSearchAccessProtocol - PolarDB - Alibaba Cloud Documentation Center

Switches the access protocol (HTTP/HTTPS) for PolarDB-X 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-hangzhou
DBInstanceName	string	Yes	The instance name.	pxc-********
Protocol	string	Yes	The access protocol. Valid values: http: HTTP protocol. https: HTTPS protocol.	https

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	C458B1E8-1683-3645-B154-6BA32080EEA
Protocol	string	The backend protocol. Valid values: HTTP (default): supports association with HTTPS, HTTP, and QUIC listeners. HTTPS: supports association with HTTPS listeners. gRPC: supports association with HTTPS and QUIC listeners. Note If ServerGroupType is set to Fc, you do not need to configure the backend protocol.	icmp
Message	string	The response message. "success" is returned for a successful request. An error code is returned for a failed request.	success
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The identity type used for authentication in the request. Valid values: SubUser: RAM user AssumedRoleUser: RAM role Federated: SSO federated identity	222
AuthPrincipalOwnerId	string	The owner ID of the authentication principal.	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": "C458B1E8-1683-3645-B154-6BA32080EEA",
  "Protocol": "icmp",
  "Message": "success",
  "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.