All Products
Search
Document Center

Virtual Private Cloud:GetVpcGatewayEndpointAttribute

Last Updated:Mar 22, 2024

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:GetVpcGatewayEndpointAttributeRead
  • GatewayEndpoint
    acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
EndpointIdstringYes

The ID of the gateway endpoint.

vpce-bp1w1dmdqjpwul0v3****
RegionIdstringYes

The region ID of the gateway endpoint.

You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

A1122D0F-7B3B-5445-BB19-17F27F97FE1C
EndpointIdstring

The ID of the gateway endpoint.

vpce-bp1w1dmdqjpwul0v3****
EndpointNamestring

The name of the gateway endpoint.

test
EndpointDescriptionstring

The description of the gateway endpoint.

test
ServiceNamestring

The name of the endpoint service.

com.aliyun.cn-hangzhou.oss
VpcIdstring

The ID of the virtual private cloud (VPC) to which the gateway endpoint belongs.

vpc-bp1nh86rugg01zol0****
PolicyDocumentstring

The access policy for the cloud service.

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

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
EndpointStatusstring

The status of the gateway endpoint. Valid values:

  • Creating
  • Created
  • Modifying
  • Associating
  • Dissociating
  • Deleting
Created
RouteTablesarray

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****"]
ResourceGroupIdstring

The ID of the resource group to which the gateway endpoint belongs.

rg-acfmxvfvazb4p****
Tagsobject []

The tag list.

Keystring

The key of tag N added to the resource.

FinanceDept
Valuestring

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 codeError codeError messageDescription
400ResourceNotFound.GatewayEndpointThe specified resource gateway endpoint is not found.The error message returned because the specified gateway endpoint does not exist.
400InvalidVpcId.NotFoundSpecified 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 timeSummary of changesOperation
2023-09-06The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-06-20The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-03-23The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.