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

调试

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

请求参数

名称类型是否必选示例值描述
ActionStringGetVpcGatewayEndpointAttribute

系统规定参数。取值:GetVpcGatewayEndpointAttribute

EndpointIdStringvpce-bp1w1dmdqjpwul0v3****

网关终端节点实例ID。

RegionIdStringcn-hangzhou

网关终端节点所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

返回数据

名称类型示例值描述
RequestIdStringA1122D0F-7B3B-5445-BB19-17F27F97FE1C

请求ID。

EndpointIdStringvpce-bp1w1dmdqjpwul0v3****

网关终端节点实例ID。

EndpointNameStringtest

网关终端节点的名称。

EndpointDescriptionStringtest

网关终端节点的描述信息。

ServiceNameStringcom.aliyun.cn-hangzhou.oss

终端节点服务名称。

VpcIdStringvpc-bp1nh86rugg01zol0****

网关终端节点所在的VPC ID。

PolicyDocumentString{"Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }

云服务的访问策略。

CreationTimeString2021-08-27T01:58:37Z

网关终端节点的创建时间。按照ISO8601标准表示,并需要使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

EndpointStatusStringCreated

网关终端节点的状态。取值:

  • Creating:创建中。
  • Created:已创建,正常状态。
  • Modifying:修改中。
  • Associating:绑定中。
  • Dissociating:解绑中。
  • Deleting:删除中。
RouteTablesArray of String["vtb-bp1s6g17997knk6a3****", "vtb-bp12qsdjwm37kv679****"]

网关终端节点关联的路由表ID。

ResourceGroupIdStringrg-acfmxvfvazb4p****

网关终端节点所属的资源组ID。

TagsArray of Tag

标签列表。

KeyStringFinanceDept

标签键。

ValueStringFinanceJoshua

标签值。

示例

请求示例

http(s)://[Endpoint]/?Action=GetVpcGatewayEndpointAttribute
&EndpointId=vpce-bp1w1dmdqjpwul0v3****
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

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

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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"
  } ]
}

错误码

HttpCode错误码错误信息描述
400ResourceNotFound.GatewayEndpointThe specified resource gateway endpoint is not found.指定的GatewayEndpoint不存在

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