All Products
Search

This Product

    PrivateLink:GetVpcEndpointAttribute

    Document Center

    PrivateLink:GetVpcEndpointAttribute

    Last Updated:Feb 27, 2024

    Queries the attributes of an endpoint.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    privatelink:GetVpcEndpointAttributeRead
    • VpcEndpoint
      acs:privatelink:{#regionId}:{#accountId}:vpcendpoint/{#EndpointId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    RegionIdstringYes

    The region ID of the endpoint whose attributes you want to query.

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

    		cn-huhehaote
    EndpointIdstringYes

    The ID of the endpoint whose attributes you want to query.

    		ep-hp33b2e43fays7s8****

    Response parameters

    ParameterTypeDescriptionExample
    object
    Payerstring

    The payer. Valid values:

    • Endpoint: the service consumer.
    • EndpointService: the service provider.
    		Endpoint
    EndpointDomainstring

    The domain name of the endpoint.

    		ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com
    RequestIdstring

    The request ID.

    		8D8992C1-6712-423C-BAC5-E5E817484C6B
    CreateTimestring

    The time when the endpoint was created.

    		2021-09-24T18:00:07Z
    ResourceOwnerboolean

    Indicates whether the endpoint and the endpoint service belong to the same Alibaba Cloud account. Valid values:

    • true: The endpoint and the endpoint service belong to the same Alibaba Cloud account.
    • false: The endpoint and the endpoint service do not belong to the same Alibaba Cloud account.
    		true
    EndpointBusinessStatusstring

    The service state of the endpoint. Valid values:

    • Normal: The endpoint runs as expected.
    • FinancialLocked: The endpoint is locked due to overdue payments.
    		Normal
    EndpointDescriptionstring

    The description of the endpoint.

    		This is my Endpoint.
    ServiceIdstring

    The ID of the endpoint service with which the endpoint is associated.

    		epsrv-hp3vpx8yqxblby3i****
    EndpointStatusstring

    The state of the endpoint. Valid values:

    • Creating: The endpoint is being created.
    • Active: The endpoint is available.
    • Pending: The endpoint is being modified.
    • Deleting: The endpoint is being deleted.
    		Active
    VpcIdstring

    The ID of the virtual private cloud (VPC) to which the endpoint belongs.

    		vpc-fdfhkjafhjvcvdjf****
    EndpointNamestring

    The name of the endpoint.

    		test
    ZonePrivateIpAddressCountlong

    The number of private IP addresses that are assigned to an elastic network interface (ENI) in each zone. Only 1 is returned.

    		1
    EndpointTypestring

    The type of the endpoint.

    Interface is returned. The value indicates the interface endpoint with which the Classic Load Balancer (CLB) instances are associated.

    		Interface
    ServiceNamestring

    The name of the endpoint service with which the endpoint is associated.

    		com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****
    Bandwidthinteger

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

    		1024
    EndpointIdstring

    The endpoint ID.

    		ep-hp33b2e43fays7s8****
    RegionIdstring

    The region ID of the endpoint.

    		cn-huhehaote
    ConnectionStatusstring

    The state of the endpoint connection. Valid values:

    • Pending: The connection is being modified.
    • Connecting: The connection is being established.
    • Connected: The connection is established.
    • Disconnecting: The endpoint is being disconnected from the endpoint service.
    • Disconnected: The endpoint is disconnected from the endpoint service.
    • Deleting: The connection is being deleted.
    		Connected
    ZoneAffinityEnabledboolean

    Indicates whether the domain name of the nearest endpoint that is associated with the endpoint service is resolved first. Valid values:

    • true
    • false
    		true
    ResourceGroupIdstring

    The resource group ID.

    		rg-acfmz7nocpei***

    Examples

    Sample success responses

    JSONformat

    {
  "Payer": "Endpoint",
  "EndpointDomain": "ep-hp33b2e43fays7s8****.epsrv-hp3xdsq46ael67lo****.cn-huhehaote.privatelink.aliyuncs.com",
  "RequestId": "8D8992C1-6712-423C-BAC5-E5E817484C6B",
  "CreateTime": "2021-09-24T18:00:07Z",
  "ResourceOwner": true,
  "EndpointBusinessStatus": "Normal",
  "EndpointDescription": "This is my Endpoint.",
  "ServiceId": "epsrv-hp3vpx8yqxblby3i****",
  "EndpointStatus": "Active",
  "VpcId": "vpc-fdfhkjafhjvcvdjf****",
  "EndpointName": "test",
  "ZonePrivateIpAddressCount": 1,
  "EndpointType": "Interface",
  "ServiceName": "com.aliyuncs.privatelink.cn-huhehaote.epsrv-hp3xdsq46ael67lo****",
  "Bandwidth": 1024,
  "EndpointId": "ep-hp33b2e43fays7s8****",
  "RegionId": "cn-huhehaote",
  "ConnectionStatus": "Connected",
  "ZoneAffinityEnabled": true,
  "ResourceGroupId": "rg-acfmz7nocpei***"
}

    Error codes

    HTTP status codeError codeError messageDescription
    400EndpointNotFoundThe specified Endpoint does not exist.The specified Endpoint does not exist.
    400EndpointConnectionNotFoundThe specified endpoint connection does not exist.The specified endpoint connection does not exist.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2023-09-26The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.
    2023-09-05The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.
    2023-01-04The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    2022-09-20The Error code has changed. The response structure of the API has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
    Output ParametersThe response structure of the API has changed.