全部产品
Search
文档中心

专有网络 VPC:ModifyVpcPeerConnection - 修改VPC对等连接

更新时间:Dec 13, 2024

调用ModifyVpcPeerConnection接口修改VPC对等连接实例的名称或者描述信息。

接口说明

  • ModifyVpcPeerConnection 接口属于异步接口,即系统会先返回一个 RequestId,但该 VPC 对等连接实例并未修改完成,系统后台的修改任务仍在进行。您可以调用 GetVpcPeerConnectionAttribute 查询 VPC 对等连接实例的状态。

    • 当 VPC 对等连接实例处于 Updating 状态时,表示正在修改中。
    • 当 VPC 对等连接实例处于 Activated 状态时,表示修改完成。
  • ModifyVpcPeerConnection 接口不支持并发修改同一个 VPC 对等连接实例的名称和描述信息。

调试

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

授权信息

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

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

请求参数

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

需要修改名称或者描述信息的 VPC 对等连接实例 ID。

pcc-lnk0m24khwvtkm****
Namestring

需要修改的 VPC 对等连接的名称,即修改后的名称。

名称长度为 1~128 个字符,不能以http://https://开头。

vpcpeername
Descriptionstring

需要修改的 VPC 对等连接的描述信息,即修改后的描述信息。

描述长度为 1~256 个字符,不能以http://https://开头。

newdescription
Bandwidthinteger

需要修改的 VPC 对等连接的带宽,单位:Mbps,取值范围为大于 0 的整数。

100
DryRunboolean

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

  • true:发送检查请求,不会修改信息。检查项包括是否填写了必需参数、请求格式、业务限制。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后返回 HTTP 2xx 状态码并直接进行操作。
false
ClientTokenstring

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

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

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

链路类型。

可选值为 Platinum(铂金),Gold(金),默认为 Gold(金)。

说明 如需指定该参数,请确保您创建的是跨地域的对等连接。
Gold

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

880C99E1-449B-524A-B81F-1EC53D2A7EAC

示例

正常返回示例

JSON格式

{
  "RequestId": "880C99E1-449B-524A-B81F-1EC53D2A7EAC"
}

错误码

HTTP status code错误码错误信息描述
400ResourceNotFound.InstanceIdThe specified resource of %s is not found.未找到指定实例
400IncorrectStatus.VpcPeerThe status of %s [%s] is incorrect.对等连接实例状态不符合要求,该状态下对对连接实例不能被接收。
400IncorrectBusinessStatus.VpcPeerThe business status of %s [%s] is incorrect.当前实例状态异常,不允许进行当前操作
400OperationFailed.BandwidthCannotBeChangedInSameRegionThe operation failed because the bandwidth cannot be changed in the same region.操作失败,因为同地域的VpcPeer实例不允许修改带宽值。
400QuotaExceeded.BandwidthThe quota of bandwidth is exceeded.传入的带宽值非法
400OperationFailed.InterRegionLinkTypeNotSupportedThe same region not supported link type feature.同地域不支持链路类型特性
400OperationFailed.RegionIdNotSupportLinkTypeThe feature link type is not supported in the region.地域不支持该特性金银铜设置
400OperationFailed.SpecificLinkTypeNotSupportedThe operation failed because the special link type of user is not opened.该账号不支持特殊链路类型

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

变更历史

变更时间变更内容概要操作
2024-12-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2024-01-23OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情
2023-07-25OpenAPI 错误码发生变更查看变更详情
2022-07-05OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情