Obtaining the Configuration for the VPC to Access the CAE Environment

Function

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

URI

GET /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 (https://support.huaweicloud.com/intl/en-us/api-iam/iam_30_0001.html). 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 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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
api_version	String	API version. Fixed value: v1.
kind	String	API type. Fixed value: VpcIngress.
items	Array of VpcIngressGetResponseBodyItem objects	Configuration for the VPC to access the CAE environment.

**Table 4** VpcIngressGetResponseBodyItem
Parameter	Type	Description
id	String	Ingress record ID.
status	String	Configuration status for the current VPC to access the CAE environment. available creating deleting create_failed delete_failed
job_id	String	ID of the job for creating an ingress.
vpc_id	String	ID of the selected VPC.
subnet_id	String	ID of the selected VPC subnet.

Example Requests

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

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

Example Responses

Status code: 200

{
  "api_version" : "v1",
  "kind" : "VpcIngress",
  "items" : [ {
    "id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
    "status" : "available",
    "job_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaab",
    "vpc_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaac",
    "subnet_id" : "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaad"
  } ]
}