You need to enable JavaScript to run this app.
导航
私网连接
  • 文档首页
    • /私网连接/API参考/接口终端节点/DescribeVpcEndpointServicesByEndUser
DescribeVpcEndpointServicesByEndUser
最近更新时间：2024.07.26 10:24:06首次发布时间：2023.07.07 09:56:29
我的收藏

调用DescribeVpcEndpointServicesByEndUser接口，查询当前账号下满足指定条件的终端节点服务列表。

调试

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

请求参数

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

ServiceOwner

String

否

normal

终端节点服务的所有者。

  • volcengine：火山引擎服务。
  • normal：普通服务。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28D****请求ID。
TotalCountInteger2符合条件的终端节点服务总数。
PageNumberInteger1当前页码。
PageSizeInteger10当前分页的行数。
VpcEndpointServicesArray of Struct-终端节点服务的详细信息。具体请参见下表“VpcEndpointServices”。

VpcEndpointServices

名称类型示例值说明
ServiceIdStringepsvc-2fe630gurkl37k5gfuy33****终端节点服务的ID。
ServiceNameStringcom.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****终端节点服务的名称。
ServiceDomainStringepsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com终端节点服务的服务域名。

ServiceType

String

Interface

终端节点服务的类型。

  • Interface：接口终端节点服务。

ServiceResourceType

String

CLB

服务资源的类型。

  • CLB：负载均衡CLB。
  • RDSMySQL：云数据库 MySQL版。

Payer

String

Endpoint

私网连接的付费账号。

  • Endpoint：终端节点账号。
  • EndpointService：终端节点服务账号。

ZoneIds

List of String

["cn-guangzhou-a", "cn-guangzhou-b"]

服务资源所属的可用区。

说明

RDS类型的服务资源，该参数返回空值。

ServiceOwner

String

normal

终端节点服务的所有者。

  • volcengine：火山引擎服务。
  • normal：普通服务。
DescriptionStringendpoint service终端节点服务的描述信息。
ProjectNameStringdefault终端节点所属项目的名称。
TagsArray of Struct-终端节点的标签信息。具体请参见下表“Tags”。

PrivateDNSEnabled

Boolean

false

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

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

PrivateDNSName

String

www.example.com

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

PrivateDNSType

String

public

私有DNS名称的域名类型。

  • public：公网。
  • private：私网。

说明

未开通私网自定义域名功能时，不返回该参数。

PrivateDNSNameConfiguration

Array of Struct

--

终端节点服务私有DNS名称的配置信息。具体请参见下表“PrivateDNSNameConfiguration”。
PrivateDNSType为“private”时，不返回该参数。

IpAddressVersions

List of String

["ipv4", "ipv6"]

终端节点的IP协议类型。

  • 返回值中仅包含“ipv4”时，说明该终端节点为IPv4类型。
  • 返回值中同时包含“ipv4”和“ipv6”时，说明该终端节点为双栈类型。

Tags

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

PrivateDNSNameConfiguration

名称类型示例值描述
NameString_2fe6iz2tou9s059gp68um****域验证名称。

Status

String

PendingVerification

域验证状态。

  • PendingVerification：待验证
  • Verifying：验证中
  • Verified：验证通过
  • Failed：验证失败

Type

String

TXT

域验证类型。

  • TXT：TXT记录。
ValueStringepsvc:2fe6iz4spybr459gp67fb****域验证值。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpointServicesByEndUser",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "PageNumber": 1,
        "PageSize": 10,  
        "TotalCount": 2,
        "VpcEndpointServices": [
            {
                "ServiceId": "epsvc-2fe630gurkl37k5gfuy33****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****",
                "ServiceDomain": "epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com",
                "ServiceType": "Interface",
                "ServiceResourceType": "CLB",
                "Payer": "Endpoint",
                "ZoneIds": [
                    "cn-guangzhou-a",
                    "cn-guangzhou-b"
                ],
                "ServiceOwner": "normal",
                "Description": "",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ]
            },
                "PrivateDNSEnabled": false,
                "PrivateDNSName": "",
                "PrivateDNSType": "",
                "PrivateDNSNameConfiguration": {
                    "Name": "",
                    "Value": "",
                    "Type": "",
                    "Status": ""
                },
                "IpAddressVersions": [
                    "ipv4",
                    "ipv6"
                ],
            {
                "ServiceId": "epsvc-2fe630gurkl58k5gfuy26****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl58k5gfuy26****",
                "ServiceDomain": "epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com",
                "ServiceType": "Interface",
                "ServiceResourceType": "CLB",
                "Payer": "Endpoint",
                "ZoneIds": [
                    "cn-guangzhou-c"
                ],
                "ServiceOwner": "normal",
                "Description": "",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ],
                "PrivateDNSEnabled": false,
                "PrivateDNSName": "",
                "PrivateDNSType": "",
                "PrivateDNSNameConfiguration": {
                    "Name": "",
                    "Value": "",
                    "Type": "",
                    "Status": ""
                },
                "IpAddressVersions": [
                    "ipv4"
                ]
            }
        ]
    }
}

错误码

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

HttpCode错误码错误信息描述
400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
400InvalidName.MalformedThe specified Name is malformed.指定的参数Name格式不合法。
400InvalidServiceOwner.MalformedThe specified ServiceOwner is malformed.指定的 ServiceOwner 参数格式不合法。