All Products
Search
Document Center

PrivateLink:ListVpcEndpointServiceResources

Last Updated:Feb 27, 2024

Queries the service resources that are added to an endpoint service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
privatelink:ListVpcEndpointServiceResourcesLIST
  • VpcEndpointService
    acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the service resource.

You can call the DescribeRegions operation to query the most recent region list.

cn-huhehaote
NextTokenstringNo

The pagination token that is used in the next request to retrieve a new page of results. Valid values:

  • If this is your first request and no next requests are to be performed, you do not need to specify this parameter.
  • If a next request is to be performed, set the parameter to the value of NextToken that is returned from the last call.
FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 50. Default value: 50.

50
ServiceIdstringYes

The endpoint service ID.

epsrv-hp3vpx8yqxblby3i****

Response parameters

ParameterTypeDescriptionExample
object
NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:

  • If no value is returned for NextToken, no next requests are performed.
  • If a value is returned for NextToken, the value can be used in the next request to retrieve a new page of results.
FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The request ID.

0ED8D006-F706-4D23-88ED-E11ED28DCAC0
MaxResultsinteger

The number of entries returned on each page.

50
Resourcesobject []

The service resources.

VpcIdstring

The ID of the virtual private cloud (VPC) to which the service resource belongs.

vpc-hp356stwkxg3fn2xe****
VSwitchIdstring

The ID of the vSwitch to which the service resource belongs.

vsw-hp3uf6045ljdhd5zr****
ResourceTypestring

The type of the service resource.

Only slb is returned. This value indicates a Classic Load Balancer (CLB) instance.

slb
ZoneIdstring

The ID of the zone to which the service resource belongs.

cn-huhehaote-b
Ipstring

The IP address of the service resource.

192.168.10.23
ResourceIdstring

The service resource ID.

lb-hp32z1wp5peaoox2q****
RegionIdstring

The ID of the region where the service resource is deployed.

cn-huhehaote
RelatedEndpointCountlong

The number of endpoints that are associated with the service resource.

10
RelatedDeprecatedEndpointCountlong

The number of endpoints that are associated with the service resource that is smoothly migrated.

10
AutoAllocatedEnabledboolean

Indicates whether automatic resource allocation is enabled. Valid values:

  • true
  • false
false
ResourceSupportIPv6boolean

Indicates whether IPv6 is enabled for the endpoint service. Valid values:

  • true
  • false
false

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28DCAC0",
  "MaxResults": 50,
  "Resources": [
    {
      "VpcId": "vpc-hp356stwkxg3fn2xe****",
      "VSwitchId": "vsw-hp3uf6045ljdhd5zr****",
      "ResourceType": "slb",
      "ZoneId": "cn-huhehaote-b",
      "Ip": "192.168.10.23",
      "ResourceId": "lb-hp32z1wp5peaoox2q****",
      "RegionId": "cn-huhehaote",
      "RelatedEndpointCount": 10,
      "RelatedDeprecatedEndpointCount": 10,
      "AutoAllocatedEnabled": false,
      "ResourceSupportIPv6": false
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400EndpointServiceNotFoundThe specified Service does not exist.The specified Service does not exist.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-07-15The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2021-06-22The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.