Updated on 2025-09-19 GMT+08:00

Querying Connection Information

Function

This API is used to query connection information, including public and private domain names.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/clusters/{cluster_id}/endpoints

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. To obtain the value, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

cluster_id

Yes

String

Definition

Cluster ID. For details about how to obtain the value, see Obtaining the Cluster ID.

Constraints

The value must be a valid DWS cluster ID.

Range

It is a 36-digit UUID.

Default Value

N/A

Request Parameters

None

Response Parameters

Status code: 200

Table 2 Response body parameters

Parameter

Type

Description

public_endpoints

PublicEndpointResponse object

Definition

Public network connection information, including the public domain name and public IP address. If multiple nodes are bound to public IP addresses, only one of them is displayed.

Range

N/A

private_endpoints

PrivateEndpointResponse object

Definition

Public network connection information.

Range

N/A

public_ip_infos

Array of PublicIpInfoResponse objects

Definition

Public IP address details, including whether each node is bound to a public IP address and the corresponding status.

Range

N/A

Table 3 PublicEndpointResponse

Parameter

Type

Description

ip

String

Definition

Public IP address information.

Range

N/A

port

Integer

Definition

Port information. If no port is specified when a cluster is created, 8000 is used by default.

Range

N/A

enabled

Boolean

Definition

Whether the current region supports public domain name.

Range

N/A

ip_id

String

Definition

Public IP address ID.

Range

N/A

ip_bandwidth

String

Definition

Bandwidth information of the public IP address.

Range

N/A

domain_name

String

Definition

Subdomain name of the public domain name.

Range

N/A

domain_name_suffix

String

Definition

Suffix of the public domain name.

Range

N/A

zone_name

String

Definition

Suffix of the public domain name.

Range

N/A

domain_name_ttl

Integer

Definition

TTL of the public domain name.

Range

N/A

domain_name_status

String

Definition

Status of the public domain name.

Range

N/A

ip_status

String

Definition

Public IP address status.

Range

N/A

Table 4 PrivateEndpointResponse

Parameter

Type

Description

ip

String

Definition

Private IP address. Multiple IP addresses are separated by commas (,).

Range

N/A

port

Integer

Definition

Port information.

Range

8000 to 30000

domain_name

String

Definition

Subdomain name prefix.

Range

N/A

domain_name_suffix

String

Definition

Subdomain name suffix.

Range

N/A

zone_name

String

Definition

Subdomain name information.

Range

N/A

domain_name_ttl

Integer

Definition

TTL of the private domain name.

Range

N/A

domain_name_status

String

Definition

Private domain name status.

Range

N/A

elb_ip

String

Definition

Private IP address of the ELB.

Range

N/A

bind_manage_ip_status

Integer

Definition

IP address binding status.

Range

N/A

Table 5 PublicIpInfoResponse

Parameter

Type

Description

id

String

Definition

Public IP address ID.

Range

N/A

address

String

Definition

Public IP address.

Range

The value must be a valid public IPv4 address.

status

String

Definition

Public IP address status.

Range

N/A

instance_id

String

Definition

ID of the DWS cluster node to which the public IP address is bound.

Range

N/A

instance_name

String

Definition

Name of the DWS cluster node to which the public IP address is bound.

Range

N/A

bandwidth_size

String

Definition

Public IP bandwidth information.

Range

N/A

Example Requests

Query connection information such as the public domain name and public IP address.

https://{Endpoint}/v1/05f2cff45100d5112f4bc00b794ea08e/clusters/cc6588d6-8301-4c9a-b0c0-186bb824e8c0/endpoints

Example Responses

Status code: 200

Query succeeded.

{
  "public_endpoints" : {
    "ip" : "100.10.87.101",
    "port" : 8000,
    "enabled" : true,
    "ip_id" : "76d86659-a1d8-421d-969e-da97af4fde34",
    "ip_bandwidth" : "1",
    "domain_name" : "dws_cluster751",
    "domain_name_suffix" : ".dws5.dwscloud.com",
    "zone_name" : ".dws5.dwscloud.com",
    "domain_name_ttl" : 300,
    "domain_name_status" : "ACTIVE",
    "ip_status" : "ACTIVE"
  },
  "private_endpoints" : {
    "ip" : "192.168.200.145,192.168.200.32,192.168.200.169",
    "port" : 8000,
    "domain_name" : "dws_cluster-75",
    "domain_name_suffix" : ".dws.dwscloud.com",
    "zone_name" : ".dws.dwscloud.com",
    "domain_name_ttl" : 300,
    "domain_name_status" : "ACTIVE",
    "elb_ip" : "192.168.200.120",
    "bind_manage_ip_status" : 1
  },
  "public_ip_infos" : [ {
    "id" : "",
    "address" : "",
    "status" : null,
    "instance_id" : "064edaf0-775b-4337-86c5-900d73d0c969",
    "instance_name" : "dws_cluster_751-dws-cn-cn-2-1",
    "bandwidth_size" : null
  }, {
    "id" : "",
    "address" : "",
    "status" : null,
    "instance_id" : "1ba6fa55-50aa-4c85-a45d-f914c9eff771",
    "instance_name" : "dws_cluster_751-dws-cn-cn-3-1",
    "bandwidth_size" : null
  }, {
    "id" : "76d86659-a1d8-421d-969e-da97af4fde34",
    "address" : "100.10.87.101",
    "status" : "ACTIVE",
    "instance_id" : "2fb695c4-4b9f-440a-ae69-33bb26516fba",
    "instance_name" : "dws_cluster_751-dws-cn-cn-1-1",
    "bandwidth_size" : "1"
  } ]
}

Status Codes

Status Code

Description

200

Query succeeded.

400

Request error.

401

Authentication failed.

403

You do not have required permissions.

404

No resources found.

500

Internal server error.

503

Service unavailable.