GetVpcGatewayEndpointAttribute - 查询网关终端节点的属性 - 专有网络 VPC

调用GetVpcGatewayEndpointAttribute接口查询网关终端节点的属性。

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
vpc:GetVpcGatewayEndpointAttribute	get	GatewayEndpoint acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}	无	无

请求参数

名称	类型	必填	描述	示例值
EndpointId	string	是	网关终端节点实例 ID。	vpce-bp1w1dmdqjpwul0v3****
RegionId	string	是	网关终端节点所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	请求 ID。
RequestId	string	请求 ID。	A1122D0F-7B3B-5445-BB19-17F27F97FE1C
EndpointId	string	网关终端节点实例 ID。	vpce-bp1w1dmdqjpwul0v3****
EndpointName	string	网关终端节点的名称。	test
EndpointDescription	string	网关终端节点的描述信息。	test
ServiceName	string	终端节点服务名称。	com.aliyun.cn-hangzhou.oss
VpcId	string	网关终端节点所在的 VPC ID。	vpc-bp1nh86rugg01zol0****
PolicyDocument	string	云服务的访问策略。	{"Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "" ], "Action" : [ "" ], "Principal" : [ "*" ] } ] }
CreationTime	string	网关终端节点的创建时间。按照 ISO8601 标准表示，并需要使用 UTC 时间。格式为：YYYY-MM-DDThh:mm:ssZ。	2021-08-27T01:58:37Z
EndpointStatus	string	网关终端节点的状态。取值： Creating：创建中。 Created：已创建，正常状态。 Modifying：修改中。 Associating：绑定中。 Dissociating：解绑中。 Deleting：删除中。	Created
RouteTables	array	网关终端节点关联的路由表 ID。
RouteTable	string	网关终端节点关联的路由表 ID。	["vtb-bp1s6g17997knk6a3**", "vtb-bp12qsdjwm37kv679**"]
ResourceGroupId	string	网关终端节点所属的资源组 ID。	rg-acfmxvfvazb4p****
Tags	array<object>	标签列表。
Tag	object	标签列表。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua

示例

正常返回示例

JSON格式

{
  "RequestId": "A1122D0F-7B3B-5445-BB19-17F27F97FE1C",
  "EndpointId": "vpce-bp1w1dmdqjpwul0v3****",
  "EndpointName": "test",
  "EndpointDescription": "test",
  "ServiceName": "com.aliyun.cn-hangzhou.oss",
  "VpcId": "vpc-bp1nh86rugg01zol0****",
  "PolicyDocument": "{\"Version\" : \"1\",   \"Statement\" : [ {     \"Effect\" : \"Allow\",     \"Resource\" : [ \"*\" ],     \"Action\" : [ \"*\" ],     \"Principal\" : [ \"*\" ]   } ] }",
  "CreationTime": "2021-08-27T01:58:37Z",
  "EndpointStatus": "Created",
  "RouteTables": [
    "[\"vtb-bp1s6g17997knk6a3****\", \"vtb-bp12qsdjwm37kv679****\"]"
  ],
  "ResourceGroupId": "rg-acfmxvfvazb4p****",
  "Tags": [
    {
      "Key": "FinanceDept",
      "Value": "FinanceJoshua"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	ResourceNotFound.GatewayEndpoint	The specified resource gateway endpoint is not found.	指定的GatewayEndpoint不存在
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.	该VPC不存在，请您检查输入的VPC是否正确。

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

变更历史

变更时间	变更内容概要	操作
2023-09-06	OpenAPI 错误码发生变更	查看变更详情
2023-06-20	OpenAPI 错误码发生变更	查看变更详情
2023-03-23	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情