Queries the details 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 GetVpcEndpointServiceAttribute

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

RegionId String Yes eu-west-1

The ID of the region where the endpoint service is created. You can call the DescribeRegions operation to query region IDs.

ServiceId String Yes epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

Response parameters

Parameter Type Example Description
AutoAcceptEnabled Boolean true

Indicates whether to automatically accept endpoint connection requests:

  • true: automatically accepts endpoint connection requests.
  • false: manually accepts endpoint connection requests.
ConnectBandwidth Integer 1024

The default maximum bandwidth.

CreateTime String 2020-01-02T19:11:12Z

The time when the endpoint service was created.

MaxBandwidth Integer 1024

The maximum bandwidth of the endpoint connection.

MinBandwidth Integer 100

The minimum bandwidth of the endpoint connection.

RegionId String eu-west-1

The ID of the region where the endpoint service is created.

RequestId String 8D8992C1-6712-423C-BAC5-E5E817484C6B

The ID of the request.

ServiceBusinessStatus String Normal

The business status of the endpoint service. Valid values:

  • Normal: normal
  • FinancialLocked: locked due to overdue payments
ServiceDescription String This is my EndpointService.

The description of the endpoint service.

ServiceDomain String epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com

The domain name of the endpoint service.

ServiceId String epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

ServiceName String com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****

The name of the endpoint service.

ServiceStatus String Active

The status of the endpoint service. Valid values:

  • Creating: The endpoint service is being created.
  • Pending: The endpoint service is being modified.
  • Active: The endpoint service is available.
  • Deleting: The endpoint service is being deleted.
  • Inactive: The endpoint service is unavailable.
Zones List eu-west-1a

The zone to which the service resource belongs.

Examples

Sample requests

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

Sample success responses

XML format

<GetVpcEndpointServiceAttributeResponse>
      <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
      <ServiceId>serv-abc</ServiceId>
      <ConnectBandwidth>1024</ConnectBandwidth>
      <CreateTime>2020-01-02T19:11:12Z</CreateTime>
      <MaxBandwidth>1024</MaxBandwidth>
      <MinBandwidth>100</MinBandwidth>
      <ServiceName>com.aliyun.privatelink.serv-abc</ServiceName>
      <ServiceDomain>serv-abc.privatelink.aliyun.com</ServiceDomain>
      <ServiceDescription>haha</ServiceDescription>
      <AutoAcceptEnabled>true</AutoAcceptEnabled>
      <ServiceStatus>Active</ServiceStatus>
      <ServiceBusinessStatus>Normal</ServiceBusinessStatus>
      <Zones>eu-west-1a</Zones>
      <RegionId>eu-west-1</RegionId>
</GetVpcEndpointServiceAttributeResponse>

JSON format

{
    "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
    "ServiceId": "serv-abc",
    "ConnectBandwidth":"1024",
    "CreateTime":"2020-01-02T19:11:12Z",
    "MaxBandwidth":"1024",
    "MinBandwidth":"100",
    "ServiceName": "com.aliyun.privatelink.serv-abc",
    "ServiceDomain": "serv-abc.privatelink.aliyun.com",
    "ServiceDescription": "haha",
    "AutoAcceptEnabled": true,
    "ServiceStatus": "Active",
    "ServiceBusinessStatus": "Normal",
    "Zones": "eu-west-1a",
    "RegionId": "eu-west-1"
}

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.