You need to enable JavaScript to run this app.
PrivateLink

PrivateLink

Copy page
Download PDF
Service resource
DescribeVpcEndpointServiceResources - Querying the list of resources bound to an endpoint service
Copy page
Download PDF
DescribeVpcEndpointServiceResources - Querying the list of resources bound to an endpoint service
Call the DescribeVpcEndpointServiceResources API to query the service resources bound to a specified endpoint service.​
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.
​
Request parameters​
Action String required Example: DescribeVpcEndpointServiceResources​
Action to execute. Set the value to DescribeVpcEndpointServiceResources.​
​
Version String required Example: 2020-04-01​
API version. The current version is 2020-04-01.​
​
ServiceId String requiredExample: epsvc-2fe630gurkl37k5gfuy33****​
ID of the endpoint service.​
You can call the DescribeVpcEndpointServices API to get the ID of the endpoint service.​
​
PageNumber Integer optional Example: 1​
Page number of the list. Default: 1.​
​
PageSize Integer optional Example: 10​
The number of entries per page in a pagination query. Maximum: 100. Default: 10.​
​
ZoneId String optional Example: cn-guangzhou-a​
ID of the Availability Zone where the service resource provides its service.​
tip​
This parameter is not supported when querying service resources of the RDS type.​
​
​
Response parameters​
RequestId String optional Example: 0ED8D006-F706-4D23-88ED-E11ED28D****​
Request ID.​
​
PageNumber Integer optional Example: 1​
The current page number.​
​
PageSize Integer optional Example: 10​
Number of entries per page in the current pagination.​
​
TotalCount Integer optional Example: 2​
Total number of qualified service resources that meet the conditions.​
​
Resources Object[] optional Example value: -​
Details of the service resource.​
ResourceId String optional Example: clb-bp1o94dp5i6ea****​
Service resource ID.​
​
ResourceType String optional Example: CLB​
Service resource type.​
  • CLB: Classic Load Balancer.​
  • ALB: Application Load Balancer.​
  • RDSMySQL: Cloud Database MySQL Edition.​
​
ZoneId String optional Example: cn-guangzhou-a​
ID of the Availability Zone to which the service resource belongs.​
tip​
This parameter returns a null value when the ResourceType parameter returns RDSMySQL.​
​
ResourceAutoAllocated Object[] optional Example: --​
Details about the auto-assign of the service resource.​
AutoAllocatedEnabled Boolean optional Example: true​
Enable Auto-assign.​
  • true: Yes​
  • false: No​
​
ZoneId String optional Example: cn-guangzhou-a​
Availability zone ID.​
​
​
​
​
Request examples​
​
GET /?Action=DescribeVpcEndpointServiceResources&Version=2020-04-01&ServiceId=epsvc-2fe630gurkl37k5gfuy33**** HTTP/1.1​
Host: privatelink.cn-guangzhou.volcengineapi.com​
X-Date: 20251121T094038Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251121/cn-guangzhou/privatelink/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
Response examples​
​
{​
"ResponseMetadata": {​
"RequestId": "20230604110420****100232280022D31",​
"Action": "DescribeVpcEndpointServiceResources",​
"Version": "2020-04-01",​
"Service": "privatelink",​
"Region": "cn-guangzhou"​
},​
"Result": {​
"PageNumber": 1,​
"PageSize": 10,​
"RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",​
"Resources": [​
{​
"ZoneId": "cn-guangzhou-a",​
"ResourceId": "clb-bp1o94dp5i6ea****",​
"ResourceType": "CLB",​
"ResourceAutoAllocated": [​
{​
"ZoneId": "cn-guangzhou-a",​
"AutoAllocatedEnabled": true​
}​
]​
}​
],​
"TotalCount": 2​
}​
}​
​
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​
MissingParameter​
The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.​
This request does not contain required parameters. Ensure that your request includes all required parameters, such as XXX.​
tip​
Here, XXX represents the name of the missing parameter.​
400​
InvalidPaging.Malformed​
The specified PageNumber or PageSize is malformed.​
The format of specified pagination parameter is invalid.​
400​
ErrInterfaceNotSupportedResourceType​
The Interface does not support the resource type.​
The endpoint service API does not support this service resource type.​
400​
InvalidZoneID.Malformed​
The specified ZoneID is malformed.​
The specified ZoneID parameter format is invalid.​
404​
InvalidEndpointService.NotFound​
The specified EndpointService does not exist.​
The specified endpoint service does not exist.​
​
Last updated: 2026.03.06 14:18:40