GetVpcGatewayEndpointAttribute - Virtual Private Cloud - Alibaba Cloud Documentation Center

Queries the attributes of a gateway endpoint.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
vpc:GetVpcGatewayEndpointAttribute	get	*GatewayEndpoint `acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}`	none	none

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. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou

Response parameters

Parameter	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 virtual private cloud (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 endpoint was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in 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.
RouteTable	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 tag list.
Tag	object
Key	string	The key of tag N added to the resource.	FinanceDept
Value	string	The value of tag N added to the resource.	FinanceJoshua

Examples

Sample success responses

JSONformat

{
  "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 error message returned because the specified gateway endpoint does not exist.
400	InvalidVpcId.NotFound	Specified value of VpcId is not found in our record.	The VPC does not exist. Check whether the specified VPC is valid.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-09-06	The Error code has changed	View Change Details
2023-06-20	The Error code has changed	View Change Details
2023-03-23	The Error code has changed. The response structure of the API has changed	View Change Details