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

文档中心

立即注册

导航

DescribeVpcGatewayEndpoints

最近更新时间：2024.11.08 16:30:40首次发布时间：2023.07.07 09:56:29

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

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
Action	String	是	DescribeVpcGatewayEndpoints	要执行的操作，取值为DescribeVpcGatewayEndpoints。
Version	String	是	2020-04-01	API版本信息，当前版本为2020-04-01。
PageNumber	Integer	否	1	列表的页码。默认值为1。
PageSize	Integer	否	10	分页查询时每页的行数。最大值为100，默认值为10。
VpcId	String	否	vpc-bp15zkdt37pq72zv****	网关终端节点所属VPC的ID。您可以调用DescribeVpcs接口获取VPC ID。
EndpointIds.N	String	否	EndpointIds.1=gwep-273yuq6q7bgn47fap8squ**&EndpointIds.2=gwep-h53yrq6t7bnn55fqp6rpw**	网关终端节点的ID。您可以调用DescribeVpcGatewayEndpoints接口获取网关终端节点的ID。 N：表示网关终端节点ID的序号，取值范围为1～100。多个网关终端节点ID之间使用&分隔。
EndpointName	String	否	endpoint-01	网关终端节点的名称。
ProjectName	String	否	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。
PageNumber	Integer	1	当前页码。
PageSize	Integer	10	当前分页的行数。
TotalCount	Integer	2	符合条件的网关终端节点总数。
GatewayEndpoints	Array of Struct	-	网关终端节点的详细信息。具体请参见下表“GatewayEndpoints”。

GatewayEndpoints

名称	类型	示例值	描述
EndpointId	String	gwep-273yuq6q7bgn47fap8squ****	网关终端节点的ID。
EndpointName	String	endpoint-01	网关终端节点的名称。
Description	String	endpoint service	网关终端节点的描述信息。
ServiceId	String	gwepsvc-2fe630gurkl37k5gfuy33****	网关终端节点服务的ID。
ServiceName	String	com.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl37k5gfuy33****	网关终端节点服务的名称。
VpcId	String	vpc-bp15zkdt37pq72zv****	网关终端节点所属VPC的ID。
CreationTime	String	2021-07-20T03:32:32+08:00	网关终端节点的创建时间。
UpdateTime	String	2021-07-20T03:32:32+08:00	网关终端节点的最近操作时间。
ProjectName	String	default	网关终端节点所属项目的名称。
VpcPolicy	String	{ "Statement": [ { "Effect": "Allow", "Principal": "", "Action": "", "Resource": "*" } ] }	网关终端节点的访问策略。访问策略中各字段的详细说明请参见存储桶策略参数说明。
Tags	Array of Struct	-	终端节点的标签信息。具体请参见下表“Tags”。

Tags

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

请求示例

GET /?Action=DescribeVpcGatewayEndpoints&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": "DescribeVpcGatewayEndpoints",
        "Version": "2020-04-01",
        "Service": "privatelink",
        "Region": "cn-guangzhou"
    },
    "Result": {
        "RequestId": "0ED8D006-F706-4D23-88ED-E11ED28D****",
        "PageNumber": 1,
        "PageSize": 10,  
        "TotalCount": 2,
        "GatewayEndpoints": [
            {
                "EndpointId": "gwep-273yuq6q7bgn47fap8squ****",
                "EndpointName": "endpoint-01",
                "Description": "",
                "ServiceId": "gwepsvc-2fe630gurkl37k5gfuy33****",
                "ServiceName": "com.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl37k5gfuy33****",
                "VpcId": "vpc-bp15zkdt37pq72zv****",
                "CreationTime": "2021-07-20T03:32:32+08:00",
                "UpdateTime": "2021-07-20T03:32:32+08:00",
                "ProjectName": "default",
                "VpcPolicy": {
                    "Statement": [
                        {
                            "Effect": "Allow",
                            "Principal": "*",
                            "Action": "*",
                            "Resource": "*"
                        }
                    ]
                },
                "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.GatewayEndpointNumber	You've reached the limit on the number of gateway endpoints 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.	已达到单次可指定过滤标签键值数量的上限。