文档首页/ 虚拟私有云 VPC/ API参考/ API V1/V2/ VPC/ 更新VPC - UpdateVpc
更新时间：2026-04-14 GMT+08:00
在线调试
CLI示例
查看PDF
分享

更新VPC - UpdateVpc

功能介绍

更新虚拟私有云。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    vpc:vpcs:update

    Write

    vpc *

    -

    -

    -

    vpc:VpcBlockServiceEndpointStates

URI

PUT /v1/{project_id}/vpcs/{vpc_id}

参数说明请参见表1。
表1 参数说明

名称

是否必选

说明

project_id

是

项目ID，获取项目ID请参见获取项目ID。

vpc_id

是

虚拟私有云唯一标识

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

vpc

是

vpc object

vpc对象。
表3 vpc对象

名称

是否必选

参数类型

说明

name

否

String
  • 功能说明：虚拟私有云名称。
  • 取值范围：0-64个字符，支持数字、字母、中文字符、_(下划线)、-（中划线）、.（点）。
  • 约束：如果名称不为空，则同一个租户下的VPC不允许重名。

description

否

String
  • 功能说明：虚拟私有云描述。
  • 取值范围：0-255个字符，不能包含“<”和“>”。

cidr

否

String
  • 功能说明：虚拟私有云下可用子网的范围。
  • 取值范围：
    建议使用如下IP地址范围：
    • 10.0.0.0/8~24
    • 172.16.0.0/12~24
    • 192.168.0.0/16~24

    除上述地址外，还可以使用任何可公共路由的IP地址，但必须排除如下的系统预留地址和公网保留地址：

    系统预留地址：
    • 100.64.0.0/10
    • 214.0.0.0/7
    • 198.18.0.0/15
    • 169.254.0.0/16
    公网保留地址：
    • 0.0.0.0/8
    • 127.0.0.0/8
    • 240.0.0.0/4
  • 不指定cidr时，默认值为空。
  • 约束：
    • 必须是cidr格式，例如:192.168.0.0/16。
    • 如果要更新VPC的cidr，修改后的cidr必须包含VPC下所有子网的cidr。

routes

否

Array of route objects
  • 功能说明：路由信息列表，详情参见表 route对象。
  • 约束：每个路由表最大关联200条路由

enable_network_address_usage_metrics

否

Boolean
  • 功能说明：是否开启VPC内所有子网的IPv4地址使用量指标监控。
  • 取值范围：
    • true：开启
    • false：不开启
表4 route对象

名称

是否必选

参数类型

说明

destination

否

String
  • 功能说明：路由目的网段。
  • 约束：必须是cidr格式，支持IPv4和IPv6 cidr格式。

nexthop

否

String
  • 功能说明：路由下一跳地址。
  • 约束：必须为IP地址格式，且必须属于本VPC下的子网范围内才能生效，支持IPv4和IPv6地址。

请求示例

  • 更新id为99d9d709-8478-4b46-9f3f-2206b1023fd3的vpc，将名称更新为vpc1，描述更新为test1，cidr更新为192.168.0.0/16。 
    PUT https://{Endpoint}/v1/{project_id}/vpcs/99d9d709-8478-4b46-9f3f-2206b1023fd3

{
    "vpc": {
        "name": "vpc1",
        "description": "test1",
        "cidr": "192.168.0.0/16"
    }
}

响应参数

表5 响应参数

名称

参数类型

说明

vpc

vpc object

vpc对象
表6 vpc对象

名称

参数类型

说明

id

String

uuid形式的一个资源标识。

name

String

虚拟私有云名称。

description

String
  • 功能说明：虚拟私有云描述
  • 取值范围：0-255个字符，不能包含“<”和“>”。

cidr

String
  • 功能说明：虚拟私有云下可用子网的范围
  • 取值范围：
    建议使用如下IP地址范围：
    • 10.0.0.0/8~24
    • 172.16.0.0/12~24
    • 192.168.0.0/16~24

    除上述地址外，还可以使用任何可公共路由的IP地址，但必须排除如下的系统预留地址和公网保留地址：

    系统预留地址：
    • 100.64.0.0/10
    • 214.0.0.0/7
    • 198.18.0.0/15
    • 169.254.0.0/16
    公网保留地址：
    • 0.0.0.0/8
    • 127.0.0.0/8
    • 240.0.0.0/4
  • 不指定cidr时，默认值为空
  • 约束：必须是cidr格式，例如:192.168.0.0/16

status

String
  • 功能说明：虚拟私有云的状态。
  • 取值范围：
    • CREATING：创建中
    • OK：创建成功

enterprise_project_id

String
  • 功能说明：企业项目ID。
  • 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。
说明：

关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

routes

Array of route objects
  • 功能说明：路由信息列表。
  • 约束：详情参见route对象

block_service_endpoint_states

String
  • 功能说明：默认情况下，VPC中的资源可以通过内网访问服务终结点。开启该项后，VPC将无法通过内网访问服务终结点，请谨慎操作。无法访问以下云服务：容器镜像服务SWR、云日志服务LTS、企业主机安全HSS、应用运维管理AOM、应用性能管理APM、对象存储服务OBS、API网关APIG。
  • 取值范围：
    • off：代表禁用。
    • on：代表开启。

enable_network_address_usage_metrics

Boolean
  • 功能说明：是否开启VPC内所有子网的IPv4地址使用量指标监控。
  • 取值范围：
    • true：开启
    • false：不开启

tenant_id

String
  • 功能说明：项目ID。

created_at

String
  • 功能说明：资源创建时间，UTC时间。
  • 格式：yyyy-MM-ddTHH:mm:ss

updated_at

String
  • 功能说明：资源更新时间，UTC时间。
  • 格式：yyyy-MM-ddTHH:mm:ss
表7 route对象

名称

参数类型

说明

destination

String
  • 功能说明：路由目的网段。
  • 约束：必须是cidr格式，支持IPv4和IPv6 cidr格式。

nexthop

String
  • 功能说明：路由下一跳地址。
  • 约束：必须为IP地址格式，且必须属于本VPC下的子网范围内才能生效，支持IPv4和IPv6地址。

响应示例

{
    "vpc": {
        "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
        "name": "vpc1",
        "description": "test1",
        "cidr": "192.168.0.0/16",
        "status": "OK",
        "enterprise_project_id": "0",
        "routes": [],
        "block_service_endpoint_states": "off",
        "enable_network_address_usage_metrics": false,
        "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b",
        "created_at": "2022-12-15T02:25:11",
        "updated_at": "2022-12-15T06:23:15"
    }
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： VPC