ListVpcGatewayEndpoints - 查询VPC网关端点列表 - 专有网络 VPC

调用ListVpcGatewayEndpoints接口查询已创建的网关终端节点的列表。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
EndpointId	string	否	网关终端节点实例 ID。	vpce-bp1i1212ss2whuwyw****
EndpointName	string	否	网关终端节点的名称。名称的长度在 1~128 个字符之间。	test
ServiceName	string	否	终端节点服务名称。	com.aliyun.cn-hangzhou.oss
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	integer	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 20。	20
RegionId	string	是	要查询的网关终端节点所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
ResourceGroupId	string	否	网关终端节点所属的资源组 ID。	rg-acfmxvfvazb4p****
Tags	array<object>	否	标签列表。
	object	否	标签列表。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。	FinanceJoshua
VpcId	string	否	网关终端节点所属的 VPC ID。	vpc-bp1gsk7h12ew7oegk****

返回参数

名称	类型	描述	示例值
	object	请求 ID。
RequestId	string	请求 ID。	0AB1129F-32C1-5E4D-9E22-E4A859CA46EB
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	integer	列表条目数。	10
Endpoints	array<object>	网关终端节点的列表。
	array<object>	网关终端节点的列表。
EndpointId	string	网关终端节点实例 ID。	vpce-bp1i1212ss2whuwyw****
EndpointName	string	网关终端节点的名称。	test
EndpointDescription	string	网关终端节点的描述信息。	test_description
ServiceName	string	终端节点服务名称。	com.aliyun.cn-hangzhou.oss
VpcId	string	网关终端节点所在的 VPC ID。	vpc-bp1gsk7h12ew7oegk****
PolicyDocument	string	云服务的访问策略。关于访问策略的语法和结构，请参见权限策略语法和结构。	{\n \"Version\": \"1\",\n \"Statement\": [\n {\n \"Effect\": \"Allow\",\n \"Action\": \"\",\n \"Principal\": \"\",\n \"Resource\": \"*\"\n }\n ]\n}
CreationTime	string	网关终端节点的创建时间。按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2021-09-08T08:43:04Z
EndpointStatus	string	网关终端节点的状态。取值： Creating：创建中。 Created：已创建，正常状态。 Modifying：修改中。 Associating：绑定中。 Dissociating：解绑中。 Deleting：删除中。	Created
AssociatedRouteTables	array	网关终端节点关联的路由表 ID。
	string	网关终端节点关联的路由表 ID。	vtb-bp1sme72jnuodvyx7****
ResourceGroupId	string	网关终端节点所属的资源组 ID。	rg-acfmxvfvazb4p****
Tags	array<object>	标签列表。
	object	标签列表。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua
MaxResults	integer	分批次查询时每次显示的条目数。	20

示例

正常返回示例

JSON格式

{
  "RequestId": "0AB1129F-32C1-5E4D-9E22-E4A859CA46EB",
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount": 10,
  "Endpoints": [
    {
      "EndpointId": "vpce-bp1i1212ss2whuwyw****",
      "EndpointName": "test",
      "EndpointDescription": "test_description",
      "ServiceName": "com.aliyun.cn-hangzhou.oss",
      "VpcId": "vpc-bp1gsk7h12ew7oegk****",
      "PolicyDocument": "{\\n  \\\"Version\\\": \\\"1\\\",\\n  \\\"Statement\\\": [\\n    {\\n      \\\"Effect\\\": \\\"Allow\\\",\\n      \\\"Action\\\": \\\"*\\\",\\n      \\\"Principal\\\": \\\"*\\\",\\n      \\\"Resource\\\": \\\"*\\\"\\n    }\\n  ]\\n}",
      "CreationTime": "2021-09-08T08:43:04Z",
      "EndpointStatus": "Created",
      "AssociatedRouteTables": [
        "vtb-bp1sme72jnuodvyx7****"
      ],
      "ResourceGroupId": "rg-acfmxvfvazb4p****",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ],
  "MaxResults": 20
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	参数NextToken非法.
400	IllegalParam.MaxResults	The param of MaxResults is illegal.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。