Modifies the configuration of a gateway endpoint.
Usage notes
- UpdateVpcGatewayEndpointAttribute is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the GetVpcGatewayEndpointAttribute operation to query the status of a gateway endpoint.
- If the gateway endpoint is in the Updating state, it is being modified.
- If the gateway endpoint is in the Created state, it is modified.
- You cannot call the UpdateVpcGatewayEndpointAttribute operation within a specific period of time.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | UpdateVpcGatewayEndpointAttribute | The operation that you want to perform. Set the value to UpdateVpcGatewayEndpointAttribute. |
EndpointId | String | Yes | vpce-bp1w1dmdqjpwul0v3**** | The ID of the gateway endpoint that you want to modify. |
EndpointName | String | No | update | The new name of the gateway endpoint. The name must be 1 to 128 characters in length. |
EndpointDescription | String | No | updateendpoint | The new description of the gateway endpoint. The description must be 1 to 255 characters in length. |
PolicyDocument | String | No | { "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] } | The access policy for the cloud service. For more information about the syntax and structure of the access policy, see Policy syntax and structure. |
ClientToken | String | No | 0c593ea1-3bea-11e9-b96b-88e9fe637760 | The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among all requests. The token can contain only ASCII characters. Note If you do not set this parameter, the system uses RequestId as ClientToken. The value of RequestId of each API request may be different. |
DryRun | Boolean | No | false | Specifies whether to perform a dry run. Valid values:
|
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 | E9654534-5A38-5545-813F-0403D49042FB | The ID of the request. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=UpdateVpcGatewayEndpointAttribute
&EndpointId=vpce-bp1w1dmdqjpwul0v3****
&EndpointName=update
&EndpointDescription=updateendpoint
&PolicyDocument={ "Version" : "1", "Statement" : [ { "Effect" : "Allow", "Resource" : [ "*" ], "Action" : [ "*" ], "Principal" : [ "*" ] } ] }
&ClientToken=0c593ea1-3bea-11e9-b96b-88e9fe637760
&DryRun=false
&RegionId=cn-hangzhou
&Common request parameters
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<UpdateVpcGatewayEndpointAttributeResponse>
<RequestId>E9654534-5A38-5545-813F-0403D49042FB</RequestId>
</UpdateVpcGatewayEndpointAttributeResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "E9654534-5A38-5545-813F-0403D49042FB"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
400 | Forbbiden | User not authorized to operate on the specified resource. | The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again. |
400 | InvalidRegionId.NotFound | The regionId provided does not exist in our records. | The error message returned because the ID of the specified region does not exist. Check whether the region ID is valid. |
For a list of error codes, see Service error codes.