全部產品
Search
文件中心

PolarDB:ModifyOpenSearchAccessProtocol

更新時間:Sep 10, 2026

切換 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=="
  }
}

錯誤碼

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情。