GetVpcGatewayEndpointAttribute - Query gateway endpoint attributes | VPC API - Virtual Private Cloud

Queries the attributes of a gateway endpoint.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
EndpointId	string	Yes	The ID of the gateway endpoint.	vpce-bp1w1dmdqjpwul0v3****
RegionId	string	Yes	The region ID of the gateway endpoint. Call DescribeRegions to query available regions.	cn-hangzhou

Response elements

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

Examples

Success response

JSON format

{
  "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

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.GatewayEndpoint	The specified resource gateway endpoint is not found.	The specified gateway endpoint does not exist.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.