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

DescribeVpcGatewayEndpoints

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

首次发布时间：2023.07.07 09:56:29

我的收藏

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

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeVpcGatewayEndpoints要执行的操作，取值为DescribeVpcGatewayEndpoints。
VersionString是2020-04-01API版本信息，当前版本为2020-04-01。
PageNumberInteger否1列表的页码。默认值为1。
PageSizeInteger否10分页查询时每页的行数。最大值为100，默认值为10。
VpcIdString否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之间使用“&”分隔。
EndpointNameString否endpoint-01网关终端节点的名称。
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。

返回数据

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

GatewayEndpoints

名称类型示例值描述
EndpointIdStringgwep-273yuq6q7bgn47fap8squ****网关终端节点的ID。

EndpointName

String

endpoint-01

网关终端节点的名称。

DescriptionStringendpoint service网关终端节点的描述信息。
ServiceIdStringgwepsvc-2fe630gurkl37k5gfuy33****网关终端节点服务的ID。
ServiceNameStringcom.volces.privatelink.cn-guangzhou.gwepsvc-2fe630gurkl37k5gfuy33****网关终端节点服务的名称。
VpcIdStringvpc-bp15zkdt37pq72zv****网关终端节点所属VPC的ID。
CreationTimeString2021-07-20T03:32:32+08:00网关终端节点的创建时间。
UpdateTimeString2021-07-20T03:32:32+08:00网关终端节点的最近操作时间。
ProjectNameStringdefault网关终端节点所属项目的名称。
VpcPolicyString{ "Statement": [ { "Effect": "Allow", "Principal": "*", "Action": "*", "Resource": "*" } ] }网关终端节点的访问策略。访问策略中各字段的详细说明请参见存储桶策略参数说明。
TagsArray of Struct-终端节点的标签信息。具体请参见下表“Tags”。

Tags

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

请求示例

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错误码错误信息描述
400InvalidName.MalformedThe specified Name is malformed.指定的Name参数格式不合法。
400InvalidPaging.MalformedThe specified PageNumber or PageSize is malformed.指定的分页参数格式不合法。
400LimitExceed.GatewayEndpointNumberYou've reached the limit on the number of gateway 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.已达到单次可指定过滤标签键值数量的上限。