Help Center/ CodeArts Pipeline/ API Reference/ API/ Endpoint Management/ Querying the Endpoints
Updated on 2025-03-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

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

Error code.

message

String

Error Information.
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.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

OK

Error Codes

See Error Codes.

Parent Topic: Endpoint Management