DescribePolarxDataNodes - PolarDB - Alibaba Cloud Documentation Center

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardbx:DescribePolarxDataNodes

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region in which the instance resides.	cn-shanghai
PageNumber	integer	No	The page number. The value must be a positive integer that does not exceed the maximum value of the integer data type. Default value: 1.	1
PageSize	integer	No	The number of entries per page.	30
NodeType	string	No	The type of nodes to query. Valid values: all: queries both dn and gms nodes. gms: queries only gms nodes. dn: queries only dn nodes.	dn
SearchKey	string	No	The keyword for filtering results.	pc-bp1c5w4fx****2274

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	BD99340C-4A45-548B-****-27584B0BCFFF
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	0
TotalNumber	integer	The total number of nodes.	0
DBInstanceDataNodes	array<object>	The list of node information.
	object	The list of node information.
DBInstanceName	string	The instance ID.	pxc-hzrp5m****04w4
DBInstanceId	string	The instance ID.	pxc-hzrlcjc****sz9
DBInstanceDescription	string	The description of the node instance.	pxc-z****nfxsxy728 : PROD-OMS-Auto-ProductionDBCloneInstance

Examples

Success response

JSON format

{
  "RequestId": "BD99340C-4A45-548B-****-27584B0BCFFF",
  "PageNumber": 1,
  "PageSize": 0,
  "TotalNumber": 0,
  "DBInstanceDataNodes": [
    {
      "DBInstanceName": "pxc-hzrp5m****04w4",
      "DBInstanceId": "pxc-hzrlcjc****sz9",
      "DBInstanceDescription": "pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	english description1

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.