You need to enable JavaScript to run this app.
导航
私网连接
  • 文档首页
    • /
  • 私网连接

DescribeVpcEndpoints

最近更新时间：2024.04.22 16:36:17

首次发布时间：2023.03.17 21:09:37

我的收藏

调用DescribeVpcEndpoints接口，查询满足指定条件的终端节点列表。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpcEndpoints要执行的操作，取值为DescribeVpcEndpoints。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
PageNumberInteger否1列表的页码。默认值为1。
PageSizeInteger否10分页查询时每页的行数。最大值为100，默认值为10。
VpcIdString否vpc-bp15zkdt37pq72zv****终端节点所属VPC的ID。您可以调用DescribeVpcs接口获取VPC ID。
ServiceIdString否epsvc-2fe630gurkl37k5gfuy33****终端节点服务的ID。您可以调用DescribeVpcEndpointServices接口获取终端节点服务的ID。
ServiceNameString否com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****终端节点服务的名称。格式为：com.volces.privatelink.<地域ID>.<终端节点服务ID>。

EndpointIds.N

String

否

EndpointIds.1=ep-273yuq6q7bgn47fap8squ****&EndpointIds.2=ep-h53yrq6t7bnn55fqp6rpw****

终端节点的ID。您可以调用DescribeVpcEndpoints接口获取终端节点的ID。

  • 参数 - N：表示终端节点ID的序号，取值范围为1～100。
  • 多个终端节点ID之间使用“&”分隔。
EndpointNameString否endpoint-01终端节点的名称。

Status

String

否

Available

终端节点的状态。

  • Creating：创建中。
  • Pending：配置修改中。
  • Available：可用。
  • Deleting：删除中。
  • Inactive：不可用。
ProjectNameString否default终端节点所属的项目。

TagFilters.N.Key

String

否

TagFilters.1.Key=k1&TagFilters.2.Key=k2

终端节点标签的标签键。
指定多个标签键时，表示查询同时包含所有指定标签键的终端节点。

TagFilters.N.Values.N

String

否

TagFilters.1.Values.1=v1&TagFilters.1.Values.2=v2&TagFilters.2.Values.1=v3

终端节点标签的标签值。每个标签键最多可指定3个标签值。

  • 未传入该参数时，表示查询指定标签键下所有标签值对应的标签所关联的终端节点。
  • 该参数取值为空时，表示查询指定标签键下标签值为空的标签所关联的终端节点。
  • 同一个标签键指定多个标签值时，表示查询各个标签值对应标签所关联终端节点的集合。

说明

如果传入该参数，则必须先传入TagFilters.N.Key。

返回数据

名称类型示例值描述

RequestId

String

0ED8D006-F706-4D23-88ED-E11ED28D****

请求ID。

PageNumberInteger1当前页码。
PageSizeInteger10当前分页的行数。
TotalCountInteger2符合条件的终端节点总数。
EndpointsArray of Struct-终端节点的详细信息。具体请参见下表“Endpoints”。

Endpoints

名称类型示例值描述
EndpointIdStringep-273yuq6q7bgn47fap8squ****终端节点的ID。
EndpointNameStringendpoint-01终端节点的名称。

EndpointType

String

Interface

终端节点的类型。

  • Interface：接口终端节点。
EndpointDomainStringep-273yuq6q7bgn47fap8squ****.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com终端节点的域名。

Status

String

Available

终端节点的状态。

  • Creating：创建中。
  • Pending：配置修改中。
  • Available：可用。
  • Deleting：删除中。
  • Inactive：不可用。

BusinessStatus

String

Normal

终端节点是否被锁定。

  • Normal：正常。
  • FinancialLocked：被锁定。

ConnectionStatus

String

Connecting

终端节点连接的状态。

  • PendingAcceptance：等待连接。
  • Connecting：连接中。
  • Connected：已连接。
  • Disconnecting：断开连接中。
  • Rejected：拒绝连接。
  • Failed：连接失败。
DescriptionStringendpoint service终端节点的描述信息。
ServiceIdStringepsvc-2fe630gurkl37k5gfuy33****终端节点服务的ID。
ServiceNameStringcom.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****终端节点服务的名称。
VpcIdStringvpc-bp15zkdt37pq72zv****终端节点所属VPC的ID。

PrivateDNSEnabled

Boolean

false

终端节点是否启用私有DNS名称。

  • false：未启用。
  • true：已启用。

PrivateDNSName

String

www.example.com

终端节点的私有DNS名称。
参数PrivateDNSEnabled返回值为“false”时，该参数返回空。

CreationTimeString2021-07-20T03:32:32+08:00终端节点的创建时间。
UpdateTimeString2021-07-20T03:32:32+08:00终端节点的最近操作时间。
DeletedTimeString2021-08-20T03:32:32+08:00终端节点的删除时间。
ProjectNameStringdefault终端节点所属项目的名称。
TagsArray of Struct-终端节点的标签信息。具体请参见下表“Tags”。

Tags

名称类型示例值描述
KeyStringk1终端节点标签的标签键。
ValueStringv1终端节点标签的标签值。

请求示例

GET /?Action=DescribeVpcEndpoints&Version=2020-04-01&EndpointName=endpoint-01 HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpoints",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "PageNumber": 1,
        "PageSize": 10,  
        "TotalCount": 2,
        "Endpoints": [
            {
                "EndpointId": "ep-273yuq6q7bgn47fap8squ****",
                "EndpointName": "endpoint-01",
                "EndpointType": "Interface",
                "EndpointDomain": "ep-273yuq6q7bgn47fap8squ****.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com",
                "Status": "Available"
                "BusinessStatus": "Normal",
                "ConnectionStatus": "Connecting",
                "Description": "",
                "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****",
                "VpcId": "vpc-bp15zkdt37pq72zv****",
                "PrivateDNSEnabled": false,
                "PrivateDNSName": "",
                "CreationTime": "2021-07-20T03:32:32+08:00",
                "UpdateTime": "2021-07-20T03:32:32+08:00",
                "DeletedTime": "2021-08-20T03:32:32+08:00",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ]
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400InvalidName.MalformedThe specified Name is malformed.指定的参数Name格式不合法。
400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
400LimitExceed.EndpointNumberYou've reached the limit on the number of endpoints that you can operate.已达到单次可操作的终端节点的数量上限。
400InvalidIncorrectOrder.MalformedThe specified index order is malformed.指定的索引顺序参数格式不合法。
400InvalidTagKey.MalformedThe specified TagKey is malformed.指定的 TagKey 参数格式不合法。
400InvalidTagValue.MalformedThe specified TagValue is malformed.指定的 TagValue 参数格式不合法。
400LimitExceeded.TagFilterKeyYou've reached the limit on the number of tag keys that you can filter.已达到单次可指定过滤标签键数量的上限。
400LimitExceeded.TagFilterValuesYou've reached the limit on the number of tag values that you can filter.已达到单次可指定过滤标签键值数量的上限。