Creating the Configuration for the VPC to Access the CAE Environment

Function

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

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-ingress

**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: VpcIngress.
items	No	Array of VpcIngressRequestItem objects	Configuration for the VPC to access the CAE.

**Table 4** VpcIngressRequestItem
Parameter	Mandatory	Type	Description
vpc_id	No	String	ID of the selected VPC.
subnet_id	No	String	ID of the selected VPC subnet.

Response Parameters

Status code: 200

**Table 5** Response body parameters
Parameter	Type	Description
id	String	Ingress record ID.
job_id	String	ID of the job for creating an ingress.

Example Requests

Create the configuration for the VPC to access the CAE environment.

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

{
  "api_version" : "v1",
  "kind" : "VpcIngress",
  "items" : [ {
    "vpc_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaac",
    "subnet_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaad"
  } ]
}

Example Responses

Status code: 200

{
  "id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
  "job_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaab"
}

Status Codes

Status Code	Description
200	OK

Error Codes

See Error Codes.

Parent topic: Access the CAE environment from the VPC.

Previous topic: Obtaining the Configuration for the VPC to Access the CAE Environment

Next topic: Deleting the Configuration for VPC to Access the CAE Environment

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot