Help Center/ GaussDB/ API Reference/ Appendix/ Obtaining an Endpoint
Updated on 2025-08-18 GMT+08:00
View PDF

Obtaining an Endpoint

Obtaining a GaussDB Endpoint

The endpoint information of GaussDB consists of the service name, region ID, and external domain name. The format is as follows: {service_name}.{region0_id}.{external_global_domain_name}

  • {service_name}: service name abbreviation, which is case-insensitive, for example, gaussdb.
  • {region0_id}: value of region0_id in the "1.2 Basic_Parameters" sheet of the xxx__export_all_EN.xlsm file exported during installation.
  • {external_global_domain_name}: value of the external_global_domain_name parameter in the "1.2 Basic_Parameters" sheet of the xxx__export_all_EN.xlsm file exported during installation.

Before calling GaussDB APIs, configure the hosts file on the local PC as follows:

{apigw_float_ip}   {service_name}.{region0_id}.{external_global_domain_name}
  • {apigw_float_ip}: value of the AGW-LB-Float-IP parameter in the "2.1 Tool_generated_IP_Params" sheet of the xxx_export_all_EN.xlsm file exported during the installation.
  • {service_name}: service name abbreviation, which is case-insensitive, for example, gaussdb.
  • {region0_id}: value of region0_id in the "1.2 Basic_Parameters" sheet of the xxx__export_all_EN.xlsm file exported during installation.
  • {external_global_domain_name}: value of the external_global_domain_name parameter in the "1.2 Basic_Parameters" sheet of the xxx__export_all_EN.xlsm file exported during installation.

Example:

172.202.2.10 gaussdb.sa-fb-1.songshanghu-x86-1.com

Obtaining the Endpoint of the IAM Service

To obtain the endpoint of the IAM service, log in to DBS Operation System, choose Instance O&M > Configuration Management > System Parameters, and enter iamEndpoint in the search box and obtain the value following https://. For example:

iam-cache-proxy.sa-fb-1.songshanghu-x86-1.com:26335

Before calling an API to obtain a token, configure the hosts file on the local PC as follows:

{mo_float_ip} {iam_url}
  • {mo_float_ip}: value of the ManageOne-Tenant-Float-IP parameter in the "2.1 Tool_generated_IP_Params" sheet of the xxx_export_all_EN.xlsm file exported during the installation. If there are multiple regions, search for the base installation project of the primary region that provides Global services.
  • {iam_url}: value between https:// and :26335 in the iamEndpoint parameter.

Example value:

172.202.0.119 iam-cache-proxy.sa-fb-1.songshanghu-x86-1.com
Parent topic: Appendix