Updated on 2023-08-02 GMT+08:00

Querying the Master Address

Function

This API is used to obtain the PodLB address of the master service based on the region name.

URI

GET /v1/apm2/openapi/systemmng/get-master-address

Table 1 Query Parameters

Parameter

Mandatory

Type

Description

region_name

Yes

String

Region name.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token obtained from IAM.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

region_name

String

Region name.

master_address

String

Address of the APM master service exposed to external systems. It is used for service registration and heartbeat reporting.

Example Requests

Obtain the PodLB address of the master service in ap-southeast-3. The input parameter is the region ID of ap-southeast-3.

/v1/apm2/openapi/systemmng/get-master-address?region_name=ap-southeast-3

Example Responses

Status code: 200

OK: The request is successful.

{
  "region_name" : "ap-southeast-3",
  "master_address" : "https://*.*.*.*:31333"
}

Status Codes

Status Code

Description

200

OK: The request is successful.

401

Unauthorized: No permissions.

403

Forbidden: Access forbidden.

404

Not Found: The requested resource is not found.

Error Codes

See Error Codes.