ModifyOpenSearchAccessProtocol - 修改 PolarDBX Search 访问协议-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

切换PolarDBX Search访问协议(HTTP/HTTPS)

接口说明

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	地域 ID。	cn-hangzhou
DBInstanceName	string	是	实例名称	pxc-********
Protocol	string	是	访问协议： http：HTTP 协议。 https：HTTPS 协议。	https

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	C458B1E8-1683-3645-B154-6BA32080EEA
Protocol	string	后端协议。取值： HTTP（默认值）：支持关联 HTTPS、HTTP 和 QUIC 监听。 HTTPS：支持关联 HTTPS 监听。 gRPC：关联 HTTPS 和 QUIC 监听。说明 ServerGroupType 取值为 Fc 时，无需配置后端协议。	icmp
Message	string	返回信息，成功返回 success，错误返回对应错误码。	success
AccessDeniedDetail	object	无权限访问详情
AuthAction	string	鉴权动作	xxx
AuthPrincipalType	string	请求中用于鉴权的身份类型。具体取值为： RAM 用户：SubUser RAM 角色：AssumedRoleUser SSO 联合身份：Federated	222
AuthPrincipalOwnerId	string	鉴权主体 OwnerId	111
AuthPrincipalDisplayName	string	鉴权主体名称	xxx
PolicyType	string	策略类型	PRIORITY
NoPermissionType	string	无权限类型	ImplicitDeny
EncodedDiagnosticMessage	string	编码诊断信息。	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

示例

正常返回示例

JSON格式

{
  "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=="
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。