Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Node Management/ Querying the VPCEP Description
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the VPCEP Description

Function

This API is used to list VPCEP services.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/workspaces/{workspace_id}/nodes/vpc-endpoint-services

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

count

Integer

Count.

records

Array of VpcepServiceData objects

VPCEP data.
Table 4 VpcepServiceData

Parameter

Type

Description

id

String

UUID

name

String

Tenant name.

type

String

Definition

VPC service status.

  • MANAGE: management channel

  • DATA: data channel

Constraints

N/A

Range

  • MANAGE

  • DATA

Default Value

N/A

deprecated

Boolean

Deprecated.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

400

Error response

Error Codes

See Error Codes.

Parent topic: Node Management