DescribeOpenSearchNodes - PolarDB - Alibaba Cloud Documentation Center

Queries the list of PolarDB-X Search nodes.

Operation description

Retrieves the list of virtual private clouds (VPCs) available under your account for an instance, so that you can select an appropriate network environment when creating or managing database instances.

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 of the instance.	cn-hangzhou
DBInstanceName	string	Yes	The name of the PolarDB-X instance.	pxc-htri0****r4k9p

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	AE4F6C34-065F-45AA-B5DC-4B8D816F6305
Data	object	The data struct.
Result	array<object>	The query result object.
	object	The query result object.
CpuCores	integer	The number of CPU cores of the node.	1
CpuPercent	string	The CPU usage (%).	35.6
DiskUsedPercent	string	The disk space usage of the node.	42.5
Health	string	The total number of unresolved baseline check items.	GREEN
HeapPercent	string	The JVM heap memory usage of the node.	38.2
Host	string	The IP address and port of the session host that initiated the session.	100.115.107.0/24
HostName	string	The name of the host on which the node instance runs. You can log on to the host and run the `hostname` command to view the hostname.	hb2h-ali-oceanbase-public-online-013
LoadOneM	string	The average system load of the node over the last 1 minute.	1.25
NodeType	string	The node type to query. Valid values: all: queries both dn and gms nodes. gms: queries only gms nodes. dn: queries only dn nodes.	dn
Port	integer	The port.	3306
ZoneId	string	The zone ID.	cn-beijing-i
DiskSizeGB	integer	The total disk capacity of the node, in GB.	500
MemoryGB	integer	The amount of memory used.	16
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 identity used for authentication in the request.	xxx
PolicyType	string	The policy type.	PRIORITY
NoPermissionType	string	The type of the permission denial.	ImplicitDeny
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

Examples

Success response

JSON format

{
  "RequestId": "AE4F6C34-065F-45AA-B5DC-4B8D816F6305",
  "Data": {
    "Result": [
      {
        "CpuCores": 1,
        "CpuPercent": "35.6",
        "DiskUsedPercent": "42.5",
        "Health": "GREEN",
        "HeapPercent": "38.2",
        "Host": "100.115.107.0/24",
        "HostName": "hb2h-ali-oceanbase-public-online-013",
        "LoadOneM": "1.25",
        "NodeType": "dn",
        "Port": 3306,
        "ZoneId": "cn-beijing-i",
        "DiskSizeGB": 500,
        "MemoryGB": 16
      }
    ]
  },
  "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.