Creating the Configuration for the CAE Environment to Access the VPC

Function

This API is used to create the configuration for the CAE environment to access the VPC.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. See Obtaining a Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. Obtain the token. For details, see "Obtaining a User Token" in Identity and Access Management API Reference. The value of X-Subject-Token in the response header is the token value.
X-Enterprise-Project-ID	No	String	Enterprise project ID. When an environment is created, it will be bound with an enterprise project ID. Enter 0 or up to 36 characters in UUID format with hyphens (-). If this parameter is not specified or is set to 0, resources in the default enterprise project are queried. NOTE: For details about how to obtain enterprise project IDs and enterprise project features, see Enterprise Management User Guide.
X-Environment-ID	Yes	String	Environment ID. To obtain an environment ID, see Obtaining the Environment List. In the response, id under items indicates the environment ID.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
api_version	No	String	API version. Fixed value: v1.
kind	No	String	API type. Fixed value: VpcEgress.
spec	No	VpcEgressRequestBodySpec object	Create the configuration for the CAE environment to access the VPC.

**Table 4** VpcEgressRequestBodySpec
Parameter	Mandatory	Type	Description
cidrs	Yes	Array of EgressCidr objects	Configuration for the CAE environment to access the VPC.

**Table 5** EgressCidr
Parameter	Mandatory	Type	Description
cidr	Yes	String	Destination network CIDR.
route_table_id	Yes	String	ID of the route table of the VPC in the CAE environment to which the destination network belongs.
id	No	String	Configuration ID for the CAE environment to access the VPC.

Response Parameters

Status code: 200

**Table 6** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1.
kind	String	API type. Fixed value: VpcEgress.
spec	VpcEgressResponseBodySpec object	Create the configuration for the CAE environment to access the VPC.

**Table 7** VpcEgressResponseBodySpec
Parameter	Type	Description
vpc_id	String	VPC ID in the CAE environment.
subnet_id	String	Subnet ID in the CAE environment.
cidrs	Array of EgressCidr objects	Configuration for the CAE environment to access the VPC.

**Table 8** EgressCidr
Parameter	Type	Description
cidr	String	Destination network CIDR.
route_table_id	String	ID of the route table of the VPC in the CAE environment to which the destination network belongs.
id	String	Configuration ID for the CAE environment to access the VPC.

Example Requests

Create the configuration for the CAE environment to access the 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"
    } ]
  }
}

Example Responses

Status code: 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"
    } ]
  }
}