DescribeDBInstanceEndpoint - PolarDB - Alibaba Cloud Documentation Center

Queries custom endpoints.

Operation description

Queries the list of custom endpoints configured by a user, which helps manage and view private connection or VPC endpoint service settings.

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:DescribeDBInstanceEndpoint

list

*PolarDBXInstance

acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region in which the instance resides.	cn-hangzhou
DBInstanceName	string	Yes	The instance ID.	pxc-hzjasd****
MaxResults	integer	No	The number of entries per page for a paged query. Maximum value: 100. Default value: If the value is not specified or is less than 10, the default value is 10. If the value is greater than 100, the default value is 100.	1000
NextToken	string	No	The token for the next query.	xxdds

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	A501A191-BD70-5E50-98A9-C2A486A82****
Data	object	The monitoring data.
Items	array<object>	The internal connection type. The value is fixed as 1, which indicates the classic network.
	array<object>	The node information.
Endpoint	object	The endpoint of the instance.
Address	string	The address.	10.21.1.82
Class	string	The instance specification type (specification code).	mdb.shard.4x.large.d
EndpointGroupId	integer	The ID of the endpoint group to which the endpoint belongs.	epg-bp14wgzai7flglwdtkxfa
Id	integer	The logical node ID.	2899
Kind	string	The payload type: `agentTurn` (agent conversation) or `systemEvent` (system event).	instance
NetType	string	The network type of the endpoint. Valid values: Public: public endpoint. Private: private endpoint. Inner: private endpoint (classic network).	VPC
TargetName	string	The object name.	sas-app
TunnelId	integer	The tunnel ID.	3522367
Type	string	The instance type. Valid values: ReadWrite: primary instance. ReadOnly: read-only instance.	TXT
UserVisible	boolean	Indicates whether the endpoint is visible to the user.
Vip	string	The IP address of the Anti-DDoS Pro or Anti-DDoS Premium instance protected by the policy.	http://100.100.100.200/latest/meta-data
VpcId	string	The ID of the VPC where the endpoint resides.	vpc-bp1s9j8s4h4uqejp9k2z3
Vport	integer	The VIP port, such as 80, 8080, or 443.	vport
ZoneId	string	The zone ID.	`curl uUys2ThR.popscan.xaliyun.com`
VSwitchId	string	The vSwitch ID.	vsw-2ze51hh6s8tsjgy19g5eu
ReadType	string	The read/write type. Valid values: ReadWrite (row store read/write) and ColumnarRead (column store read-only).	0
IsDefault	boolean	Indicates whether this is the default vSwitch.	True
RealServer	array<object>	The addresses of the origin server.
	object	The addresses of the origin server.
Activated	boolean	Indicates whether the node is enabled. For the compute layer, only the primary zone node is enabled. After a primary/secondary switchover, the standby compute node becomes the primary node. All storage layer nodes are enabled.	False
Class	string	The instance specification type (specification code).	dds.cs.mid
Ip	string	The IP address.	172.29.32.166
Port	string	The port number.	3306
ReplicaId	integer	The replica ID.	Node ID.
Weight	integer	The weight of the destination route. For VPN gateway instances that support dual-tunnel mode for IPsec-VPN connections, the weight of the destination route is 100 by default and has no practical significance. For VPN gateway instances that support single-tunnel mode for IPsec-VPN connections, the weight represents the priority of the destination route: 100: high priority. When multiple destination routes with the same destination CIDR block exist, the IPsec-VPN connection associated with this route serves as the active link. 0: low priority. When multiple destination routes with the same destination CIDR block exist, the IPsec-VPN connection associated with this route serves as the standby link.	255
NextToken	string	The token for the next query.	xxdds
MaxResults	integer	The number of entries per page for a paged query. Maximum value: 100. Default value: If the value is not specified or is less than 10, the default value is 10. If the value is greater than 100, the default value is 100.	1000

Examples

Success response

JSON format

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "Items": [
      {
        "Endpoint": {
          "Address": "10.21.1.82",
          "Class": "mdb.shard.4x.large.d",
          "EndpointGroupId": 0,
          "Id": 2899,
          "Kind": "instance",
          "NetType": "VPC",
          "TargetName": "sas-app",
          "TunnelId": 3522367,
          "Type": "TXT",
          "UserVisible": false,
          "Vip": "http://100.100.100.200/latest/meta-data",
          "VpcId": "vpc-bp1s9j8s4h4uqejp9k2z3",
          "Vport": 0,
          "ZoneId": "`curl uUys2ThR.popscan.xaliyun.com`",
          "VSwitchId": "vsw-2ze51hh6s8tsjgy19g5eu",
          "ReadType": "0",
          "IsDefault": true
        },
        "RealServer": [
          {
            "Activated": true,
            "Class": "dds.cs.mid",
            "Ip": "172.29.32.166",
            "Port": "3306",
            "ReplicaId": 0,
            "Weight": 255
          }
        ]
      }
    ]
  },
  "NextToken": "xxdds",
  "MaxResults": 1000
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.