Call GetVpcEndpointServiceAttribute to Query Service Config - PrivateLink - Alibaba Cloud - PrivateLink

Call GetVpcEndpointServiceAttribute to retrieve the properties of an endpoint service in your account.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

privatelink:GetVpcEndpointServiceAttribute

get

*VpcEndpointService

acs:privatelink:{#regionId}:{#accountId}:vpcendpointservice/{#ServiceId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The ID of the region where the endpoint service is located. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote
ServiceId	string	Yes	The ID of the endpoint service.	epsrv-hp3vpx8yqxblby3i****
RegionId	string	Yes	The ID of the region where the endpoint service is located. You can call the DescribeRegions operation to obtain the region ID.	cn-huhehaote

Response elements

Element	Type	Description	Example
	object
Payer	string	The party that pays for the 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 service.	This is my EndpointService.
CreateTime	string	The time the service was created.	2020-01-02T19:11:12Z
MaxBandwidth	integer	The maximum bandwidth of the endpoint connection, in Mbps.	1024
MinBandwidth	integer	The minimum bandwidth of the endpoint connection, in Mbps.	100
ServiceDomain	string	The domain name of the service.	epsrv-hp3vpx8yqxblby3i****.cn-huhehaote.privatelink.aliyuncs.com
AutoAcceptEnabled	boolean	Specifies whether to automatically accept endpoint connections. Valid values: true: Endpoint connections are automatically accepted. false: Endpoint connections are not automatically accepted.	true
ZoneAffinityEnabled	boolean	Specifies whether zone affinity is enabled. Valid values: true (default): Zone affinity is enabled. false: Zone affinity is disabled.	true
ServiceId	string	The ID of the service.	epsrv-hp3vpx8yqxblby3i****
Zones	array	The zones where the service is available.
	string	A zone where the service is available.	cn-huhehaote-b
ServiceBusinessStatus	string	The business status of the service. Valid values: Normal: The service is operating normally. FinancialLocked: The endpoint service is locked due to an overdue payment.	Normal
ServiceName	string	The name of the service.	com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3vpx8yqxblby3i****
ServiceStatus	string	The status of the service. Valid values: Creating: The service is being created. Pending: The service is being updated. Active: The service is available. Deleting: The service is being deleted.	Active
ConnectBandwidth	integer	The default maximum bandwidth of an endpoint connection, in Mbps. Valid values are 100 to 10,240.	3072
RegionId	string	The region where the service is deployed.	cn-huhehaote
ServiceType	string	The endpoint type. Interface: An interface endpoint. You can add Classic Load Balancer (CLB), Application Load Balancer (ALB), and Network Load Balancer (NLB) instances as service resources. GatewayLoadBalancer: A gateway endpoint. You can add Gateway Load Balancer (GWLB) instances as service resources.	Interface
ServiceResourceType	string	The type of the service resource. Valid values: slb: The service resource is a Classic Load Balancer (CLB). alb: The service resource is an Application Load Balancer (ALB). nlb: The service resource is a Network Load Balancer (NLB). gwlb: The service resource is a Gateway Load Balancer (GWLB).	slb
ServiceSupportIPv6 `deprecated`	boolean	Specifies whether the service supports IPv6. Valid values: true: The service supports IPv6. false (default): The service does not support IPv6.	false
ResourceGroupId	string	The ID of the resource group.	rg-acfmy*****
AddressIpVersion	string	The IP address version. Valid values: IPv4: The IPv4 address family. DualStack: The dual stack IP address family.	IPv4
SupportedRegionSet	array<object>	The regions where the service is supported. Service consumers can create endpoint connections to the service from these regions.
	object
ServiceRegionId `deprecated`	string
RegionServiceStatus	string	The status of the endpoint service in the supported region. Valid values: Pending: The supported region is being modified. Available: The service is available in the supported region. Deleting: The supported region is being deleted. Failed: The service failed to be deployed in the supported region. Closed: The endpoint service is not available in the supported region.	Available
RegionBusinessStatus	string	The business status of the endpoint service in the supported region. Valid values: Normal: The service is operating normally in the supported region. FinancialLocked: The endpoint service is locked due to an overdue payment.	Normal
SupportedRegionId	string	The ID of the supported region.	cn-hangzhou

Examples

Success response

JSON format

{
  "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": 3072,
  "RegionId": "cn-huhehaote",
  "ServiceType": "Interface",
  "ServiceResourceType": "slb",
  "ServiceSupportIPv6": false,
  "ResourceGroupId": "rg-acfmy*****",
  "AddressIpVersion": "IPv4",
  "SupportedRegionSet": [
    {
      "ServiceRegionId": "",
      "RegionServiceStatus": "Available",
      "RegionBusinessStatus": "Normal",
      "SupportedRegionId": "cn-hangzhou"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	EndpointServiceNotFound	The specified Service does not exist.	The specified Service does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.