すべてのプロダクト
Search
ドキュメントセンター

PolarDB:DescribeOpenSearchResourceUsage

最終更新日:Sep 10, 2026

PolarDB-X Search クラスターのリソース使用量を照会します。

操作説明

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

RegionId

string

必須

インスタンスが属するリージョンの ID。

説明

DescribeRegions 操作を呼び出して、PolarDB-X でサポートされているリージョン (リージョン ID を含む) をクエリできます。

cn-hangzhou

DBInstanceName

string

必須

インスタンスの ID。

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

レスポンスフィールド

フィールド

型

説明

例

object

レスポンススキーマ。

RequestId

string

リクエストの ID。

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

認証プリンシパルのオーナー ID。

111

AuthPrincipalDisplayName

string

認証プリンシパルの表示名。

xxx

PolicyType

string

ポリシータイプ。

PRIORITY

NoPermissionType

string

NoPermissionType。

ImplicitDeny

EncodedDiagnosticMessage

string

診断情報。

AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

例

成功レスポンス

JSONJSON

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

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。