DescribeOpenSearchResourceUsage - PolarDB - Alibaba Cloud Documentation Center

Queries the resource usage of a PolarDB-X Search cluster.

Operation description

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region in which the instance resides. Note You can call the DescribeRegions operation to query the regions supported by PolarDB-X, including region IDs.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-**************

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	C457B28E-9CAB-4B77-B5C6-5D71B7870B6E
Data	object	The returned data.
DocCount	integer	The total number of documents in the cluster.	1000000
IndexCount	integer	The number of indexes. This is a filter condition for the number of indexes that the missing index table currently has. The input format is `operator + separator "" + index count`, for example, `>=100`.	>=
StorageSizeInBytes	integer	The used storage space, in bytes.	107374182400
StorageTotalInBytes	integer	The total storage capacity, in bytes.	536870912000
StorageUsagePercent	number	The storage space usage.	20.0
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The type of the authentication principal.	222
AuthPrincipalOwnerId	string	The owner ID of the authentication principal.	111
AuthPrincipalDisplayName	string	The display name of the authentication principal.	xxx
PolicyType	string	The policy type.	PRIORITY
NoPermissionType	string	NoPermissionType	ImplicitDeny
EncodedDiagnosticMessage	string	The diagnostic information.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.