全部產品
Search
文件中心

PolarDB:DescribeOpenSearchResourceUsage

更新時間:Sep 10, 2026

查詢 PolarDBX Search 叢集資源使用情況。

介面說明

調試

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

調試

授權資訊

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

請求參數

名稱

類型

必填

描述

樣本值

RegionId

string

是

執行個體所在地域 ID。

說明

您可以呼叫 DescribeRegions 介面檢視 PolarDB-X 支援的地域詳情,包括地域 ID。

cn-hangzhou

DBInstanceName

string

是

執行個體 ID。

pxc-**************

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

RequestId

string

Id of the request

C457B28E-9CAB-4B77-B5C6-5D71B7870B6E

Data

object

返回資料。

DocCount

integer

叢集中的文件總數。

1000000

IndexCount

integer

索引個數(索引缺失表目前所擁有的索引個數)篩選條件。輸入格式為運算子+分隔符號「」+索引個數,例如 >=100。

>=

StorageSizeInBytes

integer

已使用的儲存空間,單位為位元組。

107374182400

StorageTotalInBytes

integer

儲存空間總容量,單位為位元組。

536870912000

StorageUsagePercent

number

儲存空間使用率。

20.0

AccessDeniedDetail

object

無權限存取詳情。

AuthAction

string

鑑權動作。

xxx

AuthPrincipalType

string

說明如上。

222

AuthPrincipalOwnerId

string

鑑權主體 OwnerId。

111

AuthPrincipalDisplayName

string

鑑權主體名稱。

xxx

PolicyType

string

策略類型。

PRIORITY

NoPermissionType

string

NoPermissionType

ImplicitDeny

EncodedDiagnosticMessage

string

診斷資訊。

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

樣本

正常返回樣本

JSON格式

{
  "RequestId": "C457B28E-9CAB-4B77-B5C6-5D71B7870B6E",
  "Data": {
    "DocCount": 1000000,
    "IndexCount": 0,
    "StorageSizeInBytes": 107374182400,
    "StorageTotalInBytes": 536870912000,
    "StorageUsagePercent": 20
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

錯誤碼

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

變更歷史

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