DescribeOpenSearchTopology - PolarDB - Alibaba Cloud Documentation Center

Queries the node topology of a PolarDB-X Search cluster.

Operation description

Binary log files are retained for 15 days by default.
The returned log list contains all log records whose log record end time is later than the query start time and whose log record start time is earlier than the query end time.
If DownloadLink is not NULL, you can use this URL to download the backup file. This URL is valid for 2 days after it is generated. Download the file before the URL expires.

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 region ID.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxsp-*********

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	9B2F3840-5C98-475C-B269-2D5C3A31797C
Data	object	The data struct.
Nodes	array<object>	The node IDs.
	object	The node IDs.
AvailabilityZone	string	The zone.	t1222576965886205
Cpu	integer	The total number of CPU cores in the cluster.	0.25
Host	string	The Origin Domain Name that you configured in the DCDN console, including IPv4 addresses, IPv6 addresses, common domain names, and OSS domain names.	https://secnet-defense-vastip.oss-cn-hangzhou.aliyuncs.com
IsLeader	boolean	Indicates whether the current node is the primary node.
NodeId	string	The node ID.	pxc-c-jf0pivh2dt
Role	string	The role of a node in the three-node RDS cluster. Valid values: leader: primary node follower: secondary node logger: logger node	polarx_cn
Status	string	The node status. Valid values: 0: Running 1: Creating 2: Abnormal 3: Expired 4: Releasing 5: Released 6: Locked	enabled
MemoryGB	integer	The memory size.	32
Storage	object	The configuration of the automatic storage scaling feature for the instance.
ReplicaCount	integer	The number of secondary nodes in the primary zone. Note The ReplicaCount and SlaveReplicaCount parameters apply only to cloud-native instances. If the instance uses the cluster architecture, these parameters indicate the number of secondary nodes of a single shard in the primary and secondary zones.	1
StorageType	string	The storage type.	cloud_auto
StorageTotalGB	integer	The total storage capacity of the node. Unit: GB.	500
AccessDeniedDetail	object	The details of the access denial.
AuthAction	string	The authentication action.	xxx
AuthPrincipalType	string	The authentication principal type.	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 encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
  "Data": {
    "Nodes": [
      {
        "AvailabilityZone": "t1222576965886205",
        "Cpu": 0.25,
        "Host": "https://secnet-defense-vastip.oss-cn-hangzhou.aliyuncs.com",
        "IsLeader": false,
        "NodeId": "pxc-c-jf0pivh2dt",
        "Role": "polarx_cn",
        "Status": "enabled",
        "MemoryGB": 32
      }
    ],
    "Storage": {
      "ReplicaCount": 1,
      "StorageType": "cloud_auto",
      "StorageTotalGB": 500
    }
  },
  "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.