GetVpcEndpointServiceAttribute - PrivateLink

Queries the attributes 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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
privatelink:GetVpcEndpointServiceAttribute	get	VpcEndpointService acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the endpoint service. You can call the DescribeRegions operation to query the most recent region list.	cn-huhehaote
ServiceId	string	Yes	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****

Response parameters

Parameter	Type	Description	Example
	object
Payer	string	The payer of the endpoint service. Valid values: Endpoint: the service consumer. EndpointService: the service provider.	Endpoint
RequestId	string	The request ID.	8D8992C1-6712-423C-BAC5-E5E817484C6B
ServiceDescription	string	The description of the endpoint service.	This is my EndpointService.
CreateTime	string	The time when the endpoint service was created.	2020-01-02T19:11:12Z
MaxBandwidth	integer	The maximum bandwidth of the endpoint connection. Unit: Mbit/s.	1024
MinBandwidth	integer	The minimum bandwidth of the endpoint connection. Unit: Mbit/s.	100
ServiceDomain	string	The domain name of the endpoint service.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
AutoAcceptEnabled	boolean	Indicates whether endpoint connection requests are automatically accepted. Valid values: true false	true
ZoneAffinityEnabled	boolean	Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values: true (default) false	true
ServiceId	string	The endpoint service ID.	epsrv-hp3vpx8yqxblby3i****
Zones	array	The zones to which the service resources belong.
Zone	string	The information about the array object.	cn-huhehaote-b
ServiceBusinessStatus	string	The service status of the endpoint service. Valid values: Normal: The endpoint service runs as expected. FinancialLocked: The endpoint service is locked due to overdue payments.	Normal
ServiceName	string	The name of the endpoint service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	The state 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.	Active
ConnectBandwidth	integer	The default maximum bandwidth of the endpoint connection. Unit: Mbit/s. Valid values: 100 to 10240.	1024
RegionId	string	The region ID of the endpoint service.	cn-huhehaote
ServiceType	string	The type of the endpoint. Only Interface is returned. The value indicates the interface endpoint. Then, you can specify ALB and CLB instances as service resources for the endpoint service.	Interface
ServiceResourceType	string	The type of the service resource. Valid values: slb: a CLB instance. alb: an ALB instance.	slb
ServiceSupportIPv6`deprecated`	boolean	Specifies whether the endpoint service supports IPv6. Valid values: true false (default)	false
ResourceGroupId	string	The resource group ID.	rg-acfmy*****

Examples

Sample success responses

JSONformat

{
  "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",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": ""
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The 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 time	Summary of changes	Operation
2024-09-12	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-26	The Error code has changed. The response structure of the API has changed	View Change Details
2023-09-05	The Error code has changed. The response structure of the API has changed	View Change Details
2022-09-20	The Error code has changed. The response structure of the API has changed	View Change Details