Call the DescribeVpcEndpointServicesByEndUser API to query the list of endpoint services that meet the specified conditions under the current account.

Debug

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Action String required Example: DescribeVpcEndpointServicesByEndUser

Action to execute. Set the value to DescribeVpcEndpointServicesByEndUser.

Version String required Example: 2020-04-01

Current API version is 2020-04-01.

PageNumber Integer optional Example: 1

Page number of the list. Default: 1.

PageSize Integer optional Example: 10

The number of rows per page for paginated queries. Maximum: 100. Default: 10.

ServiceName String optional Example: com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****

Endpoint service name. Format: com.volces.privatelink.<regionID>.<endpointserviceID>.

ServiceId String optional Example: epsvc-2fe630gurkl37k5gfuy33****

ID of the endpoint service.

You can call the DescribeVpcEndpointServices API to get the ID of the endpoint service.

ServiceOwner String optional Example: normal

Owner of the endpoint service.

volcengine: VolcanoEngine Service.

normal: Normal service.

EndpointRegion String optional Example: cn-shanghai

The region to which the endpoint belongs. For the region ID, see Regions and Availability Zones.

Response parameters

RequestId String Example: 0ED8D006-F706-4D23-88ED-E11ED28D****

Request ID.

TotalCount Integer Example: 2

The total number of endpoint services matching the specified conditions.

PageNumber Integer Example: 1

Current page number.

PageSize Integer Example: 10

The number of rows on the current page.

VpcEndpointServices Object[] Example: -

Details of endpoint service.

ServiceId String Example: epsvc-2fe630gurkl37k5gfuy33****

ID of the endpoint service.

ServiceName String Example: com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****

Endpoint service name.

ServiceNameManaged String Example: false

Whether the endpoint service is managed.

false: Non-managed endpoint service.

true: Managed endpoint service.

tip

This parameter is not returned when the account to which the endpoint service belongs has not enabled the managed endpoint service feature.

ServiceDomain String Example: epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com

Service domain name of the endpoint service.

AutoAcceptEnabled Boolean Example: false

Auto-accept endpoint connection.

true: The endpoint service automatically accepts endpoint connection requests.

False: The endpoint service does not automatically accept endpoint connections; you need to manually accept them by calling the EnableVpcEndpointConnection API.

ServiceType String Example: Interface

Endpoint service type.

Interface: Interface endpoint service.

Payer String Example: Endpoint

The account that pays for PrivateLink.

Endpoint: Endpoint account.

EndpointService: Endpoint service account.

BillingType Integer Example: 0

Billing method of endpoint service.

0: No charge.

3: Pay-as-you-go.

BusinessStatus String Example: Normal

Whether the endpoint service is locked.

Normal

FinancialLocked: Being locked.

tip

When this parameter returns empty, it indicates that the endpoint service is not locked.

IpAddressVersions String[] Example: ipv4

IP protocol type of the endpoint service.

If the return value contains only ipv4, it indicates that the endpoint service is of IPv4 type, supporting only IPv4 services.

If the return value contains both ipv4 and ipv6, it indicates that the endpoint service is of dual-stack type, supporting both IPv4 and IPv6 services simultaneously.

ServiceResourceType String Example: CLB

Service resource type.

CLB: Classic Load Balancer.

ALB: Application Load Balancer.

RDSMySQL: Cloud Database MySQL Edition.

ZoneIds String[] Example: cn-guangzhou-a

The availability zones in which the endpoint service provides its service.

tip

This parameter returns a null value when the ServiceResourceType parameter returns RDSMySQL.

Description String Example: endpoint service

Description of the endpoint service.

PrivateDNSEnabled Boolean Example: false

Indicates whether the private DNS name is enabled for the endpoint service.

false: Disabled.

true: Enabled.

PrivateDNSName String Example: www.example.com

Private DNS name of the endpoint service.

This parameter returns empty when the PrivateDNSEnabled parameter returns false.

PrivateDNSType String Example: public

Domain type of private DNS name.

Public: Internet.

tip

This parameter is not returned when the custom private domain name feature is not enabled.

PrivateDNSNameConfiguration Object Example: --

The configuration information of the private DNS name for the endpoint service. For detail, see the table PrivateDNSNameConfiguration.

tip

This parameter is not returned when PrivateDNSType is private.

Name String Example: _2fe6iz2tou9s059gp68um****

Domain verification name.

Status String Example: PendingVerification

Domain verification status.

Pending verification

Verifying

Verified

Failed: Verification failed

Type String Example: TXT

Domain validation type.

TXT: TXT record.

Value String Example: epsvc:2fe6iz4spybr459gp67fb****

Domain validation value.

CreationTime String Example: 2021-07-20T03:32:32+08:00

Creation time of the endpoint service.

DeletedTime String Example: 2021-09-20T03:32:32+08:00

The deletion time of the endpoint service.

UpdateTime String Example: 2021-07-20T03:32:32+08:00

Last operation time of the endpoint service.

Status String Example: Available

Status of the endpoint service.

Creating

Pending: Modifying configuration.

Available: Available for use.

Deleting: In the deleting process.

ProjectName String Example: default

Name of the project to which the endpoint belongs.

Tags Object[] Example: --

Tag information of the endpoint service.

Key String Example: k1

Tag key of the endpoint tag.

Value String Example: v1

Tag value of the endpoint tag.

SupportedRegions String[] Example: ["cn-beijing","cn-shanghai"]

The region where the endpoint service is published.

Request examples

Response examples

Error codes

This section displays only the error codes of the current API. For more error codes, see Common error codes.

Status code	Error codes	Error message	Notes
400	InvalidPaging.Malformed	The specified PageNumber or PageSize is malformed.	The format specified for pagination parameter is invalid.
400	InvalidName.Malformed	The specified Name is malformed.	The specified Name parameter format is invalid.
400	InvalidServiceOwner.Malformed	The specified ServiceOwner is malformed.	The specified ServiceOwner parameter format is invalid.
400	InvalidParameter.BatchQueryForFuzzySearch	Batch query parameters and precise search parameters are passed in at the same time.	Batch query parameters and exact search parameters cannot be passed simultaneously.
400	LimitExceed.EndpointServices	You've reached the limit on the number of EndpointServices that you can operate.	The quota for the number of endpoint services that can be operated on in a single request has been reached.
403	Forbidden	You are not authorized to perform operations on the specified service.	You do not have permission to perform operations on the specified service.