GetVpcGatewayEndpointAttribute -

Queries the attributes of a gateway endpoint.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	GetVpcGatewayEndpointAttribute	The operation that you want to perform. Set the value to GetVpcGatewayEndpointAttribute.
EndpointId	String	Yes	vpce-bp1w1dmdqjpwul0v3****	The ID of the gateway endpoint.
RegionId	String	Yes	cn-hangzhou	The region ID of the gateway endpoint. You can call the DescribeRegions operation to query the most recent region list.

Response parameters


Parameter	Type	Example	Description
RequestId	String	A1122D0F-7B3B-5445-BB19-17F27F97FE1C	The ID of the request.
EndpointId	String	vpce-bp1w1dmdqjpwul0v3****	The ID of the gateway endpoint.
EndpointName	String	test	The name of the gateway endpoint.
EndpointDescription	String	test	The description of the gateway endpoint.
ServiceName	String	com.aliyun.cn-hangzhou.oss	The name of the endpoint service.
VpcId	String	vpc-bp1nh86rugg01zol0****	The ID of the virtual private cloud (VPC) to which the gateway endpoint belongs.
PolicyDocument	String	{"Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "" ], "Action" : [ "" ], "Principal" : [ "*" ] } ] }	The access policy for the cloud service.
CreationTime	String	2021-08-27T01:58:37Z	The time when the gateway endpoint was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.
EndpointStatus	String	Created	The status of the gateway endpoint. Valid values: Creating Created Modifying Associating Dissociating Deleting
RouteTables	Array of String	["vtb-bp1s6g17997knk6a3**", "vtb-bp12qsdjwm37kv679**"]	The ID of the route table associated with the gateway endpoint.
ResourceGroupId	String	rg-acfmxvfvazb4p****	The ID of the resource group to which the gateway endpoint belongs.
Tags	Array of Tag		The list of tags.
Key	String	FinanceDept	The tag key.
Value	String	FinanceJoshua	The tag value.

Examples

Sample requests

http(s)://[Endpoint]/?Action=GetVpcGatewayEndpointAttribute
&EndpointId=vpce-bp1w1dmdqjpwul0v3****
&RegionId=cn-hangzhou
&Common request parameters

Sample success responses

XML format

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 format

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"
  } ]
}

Error codes


HttpCode	Error code	Error message	Description
400	ResourceNotFound.GatewayEndpoint	The specified resource gateway endpoint is not found.	The error message returned because the specified gateway endpoint does not exist.

For a list of error codes, see Service error codes.