查询PolarDBX Search集群资源使用情况
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| 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 |
索引个数（索引缺失表目前所拥有的索引个数）筛选条件。输入格式为 |
>= |
| 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=="
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。