首页 专有网络 VPC 开发参考 API参考 API目录 网关终端节点 UpdateVpcGatewayEndpointAttribute - 修改网关终端节点的配置信息

UpdateVpcGatewayEndpointAttribute - 修改网关终端节点的配置信息

更新时间: 2023-12-06 19:11:47

调用UpdateVpcGatewayEndpointAttribute接口修改网关终端节点的配置信息。

接口说明

  • UpdateVpcGatewayEndpointAttribute接口属于异步接口,即系统会先返回一个RequestId,但该网关终端节点的配置信息并未修改完成,系统后台的修改任务仍在进行。您可以调用GetVpcGatewayEndpointAttribute查询网关终端节点的状态。

    • 当网关终端节点处于Updating状态时,表示正在修改中。

    • 当网关终端节点处于Created状态时,表示修改完成。

  • UpdateVpcGatewayEndpointAttribute接口不支持并发修改同一个网关终端节点。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:UpdateVpcGatewayEndpointAttributeWrite
  • GatewayEndpoint
    acs:vpc:{#regionId}:{#accountId}:gatewayendpoint/{#GatewayEndpointId}

请求参数

名称类型必填描述示例值
EndpointIdstring

需要修改信息的网关终端节点的实例ID。

vpce-bp1w1dmdqjpwul0v3****
EndpointNamestring

网关终端节点需要被修改的名称。

名称的长度在1~128个字符之间。

update
EndpointDescriptionstring

网关终端节点需要被修改的描述信息。

描述信息的长度在1~255个字符之间。

updateendpoint
PolicyDocumentstring

云服务的访问策略。

关于访问策略的语法和结构,请参见权限策略语法和结构

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

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
0c593ea1-3bea-11e9-b96b-88e9fe637760
DryRunboolean

是否只预检此次请求,取值:

  • true:发送检查请求,不会修改网关终端节点的信息。检查项包括AccessKey是否有效、RAM用户的授权情况和是否填写了必需参数。如果检查不通过,则返回对应错误。如果检查通过,会返回错误码DryRunOperation

  • false(默认值):发送正常请求,通过检查后返回2xx HTTP状态码并修改网关终端节点的信息。

false
RegionIdstring

需要修改信息的网关终端节点所在的地域ID。

您可以通过调用DescribeRegions接口获取地域ID。

cn-hangzhou

返回参数

名称类型描述示例值
object

返回信息。

RequestIdstring

请求ID。

E9654534-5A38-5545-813F-0403D49042FB

示例

正常返回示例

JSON格式

{
  "RequestId": "E9654534-5A38-5545-813F-0403D49042FB"
}

错误码

HTTP status code错误码错误信息描述
400OperationFailed.ConcurrentOperationThe operation is failed because of concurrent operation.-
400IdempotentParameterMismatchThe request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.-
400ResourceNotFound.GatewayEndpointThe specified resource gateway endpoint is not found.指定的GatewayEndpoint不存在
400IllegalParam.PolicyDocumentThe param of PolicyDocument is illegal.-
400IllegalParam.GatewayEndpointNameThe param of GatewayEndpointName is illegal.-
400IllegalParam.GatewayEndpointDescriptionThe param of GatewayEndpointDescription is illegal.-
400SystemBusySystem is busy, please try again later.-
400ForbbidenUser not authorized to operate on the specified resource.用户没有权限操作指定的资源。
400InvalidRegionId.NotFoundThe regionId provided does not exist in our records.指定的RegionId不存在。请检查该参数是否正确。
400OperationDenied.PolicyDocumentThe gatewayEndpoint does not support policy.-
400IncorrectStatus.GatewayEndpointThe status of GatewayEndpoint [%s] is incorrect.-
400InvalidPolicy.WrongFormatInvalid input policy format.输入策略信息格式错误。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-05-29OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
阿里云首页 专有网络 VPC 相关技术圈