文档首页/云应用引擎 CAE/API参考/CAE API/CAE环境访问VPC/创建CAE环境访问VPC配置 - CreateVpcEgress
更新时间：2025-12-17 GMT+08:00
查看PDF
分享

创建CAE环境访问VPC配置 - CreateVpcEgress

功能介绍

创建CAE环境访问VPC配置。

授权信息

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

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

POST /v1/{project_id}/cae/vpc-egress

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

  • 获取Token，请参考《统一身份认证服务API参考》的“获取用户Token”章节。

    • 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。

X-Enterprise-Project-ID

否

String

企业项目ID。

  • 创建环境时，环境会绑定企业项目ID。

  • 最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。

  • 该字段不传（或传为字符串“0”）时，则查询默认企业项目下的资源。

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

X-Environment-ID

是

String

环境ID。

  • 获取环境ID，通过获取环境列表来获取环境信息。

  • 请求响应成功后在响应体的items数组中的一个元素即为一个环境的信息，其中id字段即是环境ID。

表3 请求Body参数

参数

是否必选

参数类型

描述

api_version

否

String

API版本，固定值“v1”，该值不可修改。

kind

否

String

API类型，固定值“VpcEgress”，该值不可修改。

spec

否

VpcEgressRequestBodySpec object

创建CAE环境访问VPC配置。

表4 VpcEgressRequestBodySpec

参数

是否必选

参数类型

描述

cidrs

是

Array of EgressCidr objects

CAE环境访问VPC配置。

表5 EgressCidr

参数

是否必选

参数类型

描述

cidr

是

String

目的网络Cidr。

route_table_id

是

String

目的网络所属CAE环境VPC的路由表ID。

id

否

String

CAE环境访问VPC配置ID。

响应参数

状态码：200

表6 响应Body参数

参数

参数类型

描述

api_version

String

API版本，固定值“v1”，该值不可修改。

kind

String

API类型，固定值“VpcEgress”，该值不可修改。

spec

VpcEgressResponseBodySpec object

创建CAE环境访问VPC配置。

表7 VpcEgressResponseBodySpec

参数

参数类型

描述

vpc_id

String

CAE环境VPCID。

subnet_id

String

CAE环境子网ID。

cidrs

Array of EgressCidr objects

CAE环境访问VPC配置。

表8 EgressCidr

参数

参数类型

描述

cidr

String

目的网络Cidr。

route_table_id

String

目的网络所属CAE环境VPC的路由表ID。

id

String

CAE环境访问VPC配置ID。

请求示例

创建CAE环境访问VPC配置。

POST https://{endpoint}/v1/{project_id}/cae/vpc-egress

{
  "api_version" : "v1",
  "kind" : "VpcEgress",
  "spec" : {
    "cidrs" : [ {
      "cidr" : "test_cidr",
      "route_table_id" : "test_route_table_id"
    } ]
  }
}

响应示例

状态码：200

请求成功。

{
  "api_version" : "v1",
  "kind" : "VpcEgress",
  "spec" : {
    "vpc_id" : "test_vpc_id",
    "subnet_id" : "test_subnet_id",
    "cidrs" : [ {
      "cidr" : "192.168.0.0/24",
      "id" : "test_id",
      "route_table_id" : "test_route_table_id"
    } ]
  }
}

状态码

状态码

描述

200

请求成功。

错误码

请参见错误码。

父主题：CAE环境访问VPC