Queries the whitelist of an endpoint service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListVpcEndpointServiceUsers

The operation that you want to perform. Set the value to ListVpcEndpointServiceUsers.

RegionId String Yes eu-west-1

The region ID of the endpoint service that you want to query. You can call the DescribeRegions operation to query region IDs.

ServiceId String Yes epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The query token. Set this parameter to NextToken that is returned in the last API call. If no subsequent queries are to be sent, you can leave the parameter empty.

MaxResults Integer No 50

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

UserId Long No 12345678

The account ID in the whitelist of the endpoint service.

Response parameters

Parameter Type Example Description
MaxResults String 50

The number of entries returned on each page.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

The token required by the next query. If the NextToken parameter is empty, this indicates that no subsequent query will be sent.

RequestId String 0ED8D006-F706-4D23-88ED-E11ED28DCAC0

The request ID.

Users Array of User

The account IDs in the whitelist of the endpoint service.

UserId Long 12345678

The account ID in the whitelist of the endpoint service.

Examples

Sample requests

https://[Endpoint]/?Action=ListVpcEndpointServiceUsers
&RegionId=eu-west-1
&ServiceId=epsrv-hp3vpx8yqxblby3i****
&<Common request parameters>

Sample success responses

XML format

<ListVpcEndpointServiceUsersResponse>   
      <RequestId>571D6CBE-4291-40EB-8FD3-C1175731D0E4</RequestId>
      <MaxResults>50</MaxResults>
      <Users>
            <UserId>12345678</UserId>
      </Users>
      <Users>
            <UserId>123456788</UserId>
      </Users>
</ListVpcEndpointServiceUsersResponse>

JSON format

{
  "RequestId": "571D6CBE-4291-40EB-8FD3-C1175731D0E4",
  "MaxResults": 50,
  "Users": [
    {
      "UserId": "12345678"
    },
    {
      "UserId": "123456788"
    }
  ]
}

Error codes

HttpCode Error code Error message Description
400 EndpointServiceNotFound The specified Service does not exist. The error message returned because the specified endpoint service does not exist.

For a list of error codes, visit the API Error Center.