全部產品
Search
文件中心

PolarDB:EnableOpenSearchPublicEndpoint

更新時間:Sep 10, 2026

開通 PolarDBX Search 公網存取。

介面說明

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

當前API暫無授權資訊透出。

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

地域 ID。

cn-shanghai

DBInstanceName

string

是

執行個體 ID。

pxc-********

NodeType

string

否

目標節點類型:

  • search:資料節點,預設值。

  • dashboard:儀表板節點。

search

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

1A586DCB-39A6-4050-81CC-C7BD4CCDB49F

Host

string

上傳需要的 host。

https://sddp-datamask.oss-cn-zhangjiakou.aliyuncs.com

Port

integer

公網位址連接埠。

3306

Message

string

介面額外返回資訊,成功返回 success,錯誤返回對應錯誤碼。

*****

AccessDeniedDetail

object

無權限存取詳情。

AuthAction

string

鑑權動作。

xxx

AuthPrincipalType

string

鑑權主體類型。

222

AuthPrincipalOwnerId

string

說明如上。

111

AuthPrincipalDisplayName

string

鑑權主體名稱。

xxx

PolicyType

string

策略類型。

PRIORITY

NoPermissionType

string

無權限類型。

ImplicitDeny

EncodedDiagnosticMessage

string

編碼診斷資訊。

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

樣本

正常返回樣本

JSON格式

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

錯誤碼

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

變更歷史

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