文档首页/ 虚拟私有云 VPC/ API参考（吉隆坡区域）/ API/ VPC/ 更新VPC
更新时间：2024-04-18 GMT+08:00
查看PDF
分享

更新VPC

功能介绍

更新虚拟私有云。

URI

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

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

名称

是否必选

说明

project_id

是

项目ID

vpc_id

是

虚拟私有云唯一标识

请求参数

表2 请求参数

名称

是否必选

参数类型

说明

vpc

是

vpc object

vpc对象。
表3 vpc对象

名称

是否必选

参数类型

说明

name

否

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

description

否

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

cidr

否

String
  • 功能说明：虚拟私有云下可用子网的范围。
  • 取值范围：
    • 10.0.0.0/8~24
    • 172.16.0.0/12~24
    • 192.168.0.0/16~24
  • 不指定cidr时，默认值为空。
  • 约束：
    • 必须是cidr格式，例如:192.168.0.0/16。
    • 如果要更新VPC的cidr，修改后的cidr必须包含VPC下所有子网的cidr。

routes

否

Array of route objects
表4 route对象

名称

是否必选

参数类型

说明

destination

否

String
  • 功能说明：路由目的网段。
  • 约束：必须是cidr格式。

nexthop

否

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

请求示例

  • 更新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
  • 功能说明：虚拟私有云下可用子网的范围
  • 取值范围：
    • 10.0.0.0/8~24
    • 172.16.0.0/12~24
    • 192.168.0.0/16~24
  • 不指定cidr时，默认值为空
  • 约束：必须是cidr格式，例如:192.168.0.0/16

status

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

routes

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

名称

参数类型

说明

destination

String
  • 功能说明：路由目的网段。
  • 约束：必须是cidr格式。

nexthop

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

响应示例

{
    "vpc": {
        "id": "99d9d709-8478-4b46-9f3f-2206b1023fd3",
        "name": "vpc1",
        "description": "test1",
        "cidr": "192.168.0.0/16",
        "status": "OK"
    }
}

状态码

请参见状态码。

错误码

请参考错误码。

父主题： VPC