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

DescribeVpcEndpointAttributes

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

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

我的收藏

调用DescribeVpcEndpointAttributes接口，查询满足指定条件的终端节点的详细信息。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpcEndpointAttributes要执行的操作，取值为DescribeVpcEndpointAttributes。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
EndpointIdString是ep-273yuq6q7bgn47fap8squ****终端节点的ID。您可以调用DescribeVpcEndpoints接口获取终端节点的ID。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
EndpointIdStringep-273yuq6q7bgn47fap8squ****终端节点的ID。
EndpointNameStringendpoint-01终端节点的名称。

EndpointType

String

Interface

终端节点的类型。

  • Interface：接口终端节点。
EndpointDomainStringep-273yuq6q7bgn47fap8squ****.epsvc-273yuqembrojk7fap8sbf****.cn-guangzhou.privatelink.volces.com终端节点的域名。格式为<终端节点ID>.<终端节点服务ID>.<地域ID>.privatelink.volcenine.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=DescribeVpcEndpointAttributes&Version=2020-04-01&EndpointId=ep-273yuq6q7bgn47fap8squ**** HTTP/1.1
Host: open.volcengineapi.com
Service: privatelink
Region: cn-guangzhou

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpointAttributes",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "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": "This is used for test.",
        "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错误码错误信息描述

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。

说明

其中，XXX表示缺少的参数名称。

404InvalidEndpoint.NotFoundThe specified endpoint does not exist.指定的终端节点不存在。