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 cn-hangzhou

The region ID of the endpoint service.

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

ServiceId String Yes epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

Response parameters

Parameter Type Example Description
Payer String Endpoint

The payer. Valid values:

  • Endpoint: the service consumer
  • EndpointService: the service provider
RequestId String 8D8992C1-6712-423C-BAC5-E5E817484C6B

The ID of the request.

ServiceDescription String This is my EndpointService.

The description of the endpoint service.

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. Unit: Mbit/s.

MinBandwidth Integer 100

The minimum bandwidth of the endpoint connection. Unit: Mbit/s.

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

The domain name of the endpoint service.

AutoAcceptEnabled Boolean true

Indicates whether endpoint connection requests are automatically accepted. Valid values:

  • true: yes
  • false: no
ZoneAffinityEnabled Boolean true

Indicates whether zone affinity is enabled. Valid values:

  • true: yes
  • false: no
ServiceId String epsrv-hp3vpx8yqxblby3i****

The ID of the endpoint service.

Zones Array of String cn-huhehaote-b

The zone to which the service resource belongs.

ServiceBusinessStatus String Normal

The business status of the endpoint service. Valid values:

  • Normal: normal
  • FinacialLocked: locked due to overdue payments
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: being created
  • Pending: being modified
  • Active: available
  • Deleting: being deleted
  • Inactive: unavailable
ConnectBandwidth Integer 1024

The default maximum bandwidth of the endpoint connection. Unit: Mbit/s.

RegionId String cn-huhehaote

The region to which the endpoint service belongs.

ServiceType String Interface

The type of the endpoint service.

The value is set to Interface. This value is used when ServiceResourceType is set to slb. The value indicates the Classic Load Balancer (CLB) type.

ServiceResourceType String slb

The type of the service resource.

The value is set to slb, which indicates CLB.

Examples

Sample requests

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

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<GetVpcEndpointServiceAttributeResponse>
    <Payer>Endpoint</Payer>
    <RequestId>8D8992C1-6712-423C-BAC5-E5E817484C6B</RequestId>
    <ServiceDescription>This is my EndpointService.</ServiceDescription>
    <CreateTime>2020-01-02T19:11:12Z</CreateTime>
    <MaxBandwidth>1024</MaxBandwidth>
    <MinBandwidth>100</MinBandwidth>
    <ServiceDomain>epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com</ServiceDomain>
    <AutoAcceptEnabled>true</AutoAcceptEnabled>
    <ZoneAffinityEnabled>true</ZoneAffinityEnabled>
    <ServiceId>epsrv-hp3vpx8yqxblby3i****</ServiceId>
    <Zones>cn-huhehaote-b</Zones>
    <ServiceBusinessStatus>Normal</ServiceBusinessStatus>
    <ServiceName>com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****</ServiceName>
    <ServiceStatus>Active</ServiceStatus>
    <ConnectBandwidth>1024</ConnectBandwidth>
    <RegionId>cn-huhehaote</RegionId>
    <ServiceType>Interface</ServiceType>
    <ServiceResourceType>slb</ServiceResourceType>
</GetVpcEndpointServiceAttributeResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Payer" : "Endpoint",
  "RequestId" : "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "ServiceDescription" : "This is my EndpointService.",
  "CreateTime" : "2020-01-02T19:11:12Z",
  "MaxBandwidth" : 1024,
  "MinBandwidth" : 100,
  "ServiceDomain" : "epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com",
  "AutoAcceptEnabled" : true,
  "ZoneAffinityEnabled" : true,
  "ServiceId" : "epsrv-hp3vpx8yqxblby3i****",
  "Zones" : [ "cn-huhehaote-b" ],
  "ServiceBusinessStatus" : "Normal",
  "ServiceName" : "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****",
  "ServiceStatus" : "Active",
  "ConnectBandwidth" : 1024,
  "RegionId" : "cn-huhehaote",
  "ServiceType" : "Interface",
  "ServiceResourceType" : "slb"
}

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.