Querying the Endpoints

Function

This API is used to query the endpoints.

Calling Method

For details, see Calling APIs.

URI

GET /v1/serviceconnection/endpoints

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
project_uuid	Yes	String	Project UUID.
region_name	Yes	String	Region name.
module_id	No	String	Module ID.
offset	No	Integer	Page number.
limit	No	Integer	Number of records on each page.

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
error	ErrorInfo object	Error information.
result	EndpointList object	Endpoint list information.
status	String	Status value.

**Table 3** ErrorInfo
Parameter	Type	Description
code	String	Definition: Error code. Value range: N/A
message	String	Definition: Error message. Value range: N/A

**Table 4** EndpointList
Parameter	Type	Description
endpoints	Array of Endpoint objects	Endpoint information.
total	Integer	Quantity.

**Table 5** Endpoint
Parameter	Type	Description
created_by	EndpointCreatorInfo object	Endpoint information.
data	Object	Endpoint data.
module_id	String	Module ID.
name	String	Module name (for search).
project_uuid	String	Project UUID.
region_name	String	Region name.
url	String	URL.
uuid	String	Endpoint ID.

**Table 6** EndpointCreatorInfo
Parameter	Type	Description
user_id	String	User ID.
username	String	Username.

Status code: 400

**Table 7** Response body parameters
Parameter	Type	Description
error_msg	String	Parameter description: Error message. Value range: N/A
error_code	String	Parameter description: Error code. Value range: N/A

Example Requests

None

Example Responses

Status code: 200

{
  "status" : "success",
  "error" : null,
  "result" : {
    "endpoints" : [ {
      "uuid" : "c6bbed0feaea4c6aa24da7fd86b886e8",
      "url" : "https://test.com",
      "name" : "test",
      "project_uuid" : "6cb920b7932948a3ade7ec1d712494eb",
      "region_name" : "regionName",
      "data" : {
        "key1" : "value1",
        "key2" : "value2"
      },
      "created_by" : {
        "username" : "user_01",
        "user_id" : "user_id"
      }
    } ]
  }
}