DescribeVpcEndpointServices--私网连接-火山引擎

文档中心

立即注册

导航

DescribeVpcEndpointServices

最近更新时间：2024.11.08 16:30:40首次发布时间：2023.03.17 21:09:36

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcEndpointServices	要执行的操作，取值为DescribeVpcEndpointServices。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数。最大值为100，默认值为10。
ServiceName	String	否	com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****	终端节点服务的名称。格式为：com.volces.privatelink.<地域ID>.<终端节点服务ID>。
ServiceType	String	否	Interface	终端节点服务的类型。 Interface：接口终端节点服务。
ServiceIds.N	String	否	ServiceIds.1=epsvc-2fe630gurkl37k5gfuy33****	终端节点服务的ID。您可以调用DescribeVpcEndpointServices接口获取终端节点服务的ID。 N：表示终端节点服务ID的序号，取值范围为1～100。多个终端节点服务ID之间使用&分隔。
ProjectName	String	否	default	终端节点服务所属项目的名称。
ServiceResourceType	String	否	CLB	终端节点服务关联的服务资源类型。取值如下： CLB：负载均衡CLB。 RDSMySQL：云数据库 MySQL版。说明支持RDS类型服务资源的功能正在邀测中，如需使用，请联系客户经理。
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。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
TotalCount	Integer	2	符合条件的终端节点服务总数。
VpcEndpointServices	Array of Struct	--	终端节点服务的详细信息。具体请参见下表“VpcEndpointServices”。

VpcEndpointServices

名称	类型	示例值	说明
ServiceId	String	epsvc-2fe630gurkl37k5gfuy33****	终端节点服务的ID。
ServiceName	String	com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl37k5gfuy33****	终端节点服务的名称。
ServiceDomain	String	epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com	终端节点服务的服务域名。
AutoAcceptEnabled	Boolean	false	是否自动接受终端节点连接。 true：终端节点服务自动接受终端节点连接。 false：终端节点服务不会自动接受终端节点连接，需要调用EnableVpcEndpointConnection接口手动接受。
ServiceType	String	Interface	终端节点服务的类型。 Interface：接口终端节点服务。
Payer	String	Endpoint	私网连接的付费账号。 Endpoint：终端节点账号。 EndpointService：终端节点服务账号。
BillingType	Integer	0	终端节点服务的计费类型。 0：不计费。 3：按量计费。
BusinessStatus	String	Normal	终端节点服务是否被锁定。 Normal：正常。 FinancialLocked：被锁定。说明该参数返回为空时，表示终端节点服务未锁定。
IpAddressVersions	List of String	["ipv4", "ipv6"]	终端节点服务的IP协议类型。返回值中仅包含“ipv4”时，说明该终端节点服务为IPv4类型，仅支持提供IPv4服务。返回值中同时包含“ipv4”和“ipv6”时，说明该终端节点服务为双栈类型，支持同时提供IPv4和IPv6服务。
ServiceResourceType	String	CLB	服务资源的类型。 CLB：负载均衡CLB。 RDSMySQL：云数据库 MySQL版。
ZoneIds	List of String	["cn-guangzhou-a", "cn-guangzhou-b"]	终端节点服务提供服务的可用区。说明参数`ServiceResourceType`返回值为“RDSMySQL”时，该参数返回空值。
Description	String	endpoint service	终端节点服务的描述信息。
PrivateDNSEnabled	Boolean	false	终端节点服务是否启用私有DNS名称。 false：未启用。 true：已启用。
PrivateDNSType	String	public	私有DNS名称的域名类型。 public：公网。 private：私网。说明未开通自定义私网域名功能时，不返回该参数。
PrivateDNSName	String	www.example.com	终端节点服务的私有DNS名称。参数`PrivateDNSEnabled`返回值为“false”时，该参数返回空。
PrivateDNSNameConfiguration	Array of Struct	--	终端节点服务私有DNS名称的配置信息。具体请参见下表“PrivateDNSNameConfiguration”。说明 `PrivateDNSType`为“private”时，不返回该参数。
CreationTime	String	2021-07-20T03:32:32+08:00	终端节点服务的创建时间。
UpdateTime	String	2021-07-20T03:32:32+08:00	终端节点服务的最近操作时间。
Status	String	Available	终端节点服务的状态。 Creating：创建中。 Pending：配置修改中。 Available：可用。 Deleting：删除中。
ProjectName	String	default	终端节点所属项目的名称。
Tags	Array of Struct	--	终端节点服务的标签信息。具体请参见下表“Tags”。

Tags

名称	类型	示例值	描述
Key	String	k1	终端节点服务标签的标签键。
Value	String	v1	终端节点服务标签的标签值。

PrivateDNSNameConfiguration

名称	类型	示例值	描述
Name	String	_2fe6iz2tou9s059gp68um****	域验证名称。
Status	String	PendingVerification	域验证状态。 PendingVerification：待验证 Verifying：验证中 Verified：验证通过 Failed：验证失败
Type	String	TXT	域验证类型。 TXT：TXT记录。
Value	String	epsvc:2fe6iz4spybr459gp67fb****	域验证值。

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "Action": "DescribeVpcEndpointServices",
        "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",
                "AutoAcceptEnabled": false,
                "ServiceType": "Interface",
                "IpAddressVersions": [
                    "ipv4",
                    "ipv6"
                 ],
                "ServiceResourceType": "CLB",
                "Payer": "Endpoint",
                "BillingType": 0,
                "BusinessStatus": "Normal",
                "ZoneIds": [
                    "cn-guangzhou-a",
                    "cn-guangzhou-b"
                ],
                "Description": "",
                "PrivateDNSEnabled": true,
                "PrivateDNSName": "www.example.com",
                "PrivateDNSNameConfiguration": [
                    {
                        "Name": "_2fe6iz2tou9s059gp68um****",
                        "Status": "Verified",
                        "Type": "TXT",
                        "Value": "epsvc:2fe6iz4spybr459gp67fb****"
                    }
                ],
                "CreationTime": "2021-07-20T03:32:32+08:00",
                "UpdateTime": "2021-07-20T03:32:32+08:00",
                "Status": "Available",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ]
            },
            {
                "ServiceId": "epsvc-2fe630gurkl58k5gfuy26****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.epsvc-2fe630gurkl58k5gfuy26****",
                "ServiceDomain": "epsvc-2fe630gurkl37k5gfuy33****.cn-guangzhou.privatelink.volces.com",
                "AutoAcceptEnabled": false,
                "ServiceType": "Interface",
                "IpAddressVersions": [
                    "ipv4"
                 ],
                "ServiceResourceType": "CLB",
                "Payer": "Endpoint",
                "BillingType": 0,
                "BusinessStatus": "Normal",
                "ZoneIds": [
                    "cn-guangzhou-c"
                ],
                "Description": "",
                "PrivateDNSEnabled": true,
                "PrivateDNSName": "www.example.com",
                "PrivateDNSNameConfiguration": [
                    {
                        "Name": "_2fe6iz2tou9s059gp68um****",
                        "Status": "Verified",
                        "Type": "TXT",
                        "Value": "epsvc:2fe6iz4spybr459gp67fb****"
                    }
                ],
                "CreationTime": "2021-10-20T03:32:32+08:00",
                "UpdateTime": "2021-10-20T03:32:32+08:00",
                "Status": "Available",
                "ProjectName": "default",
                "Tags": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ]
            }
        ]
    }
}

错误码

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

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