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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. See Obtaining a Project ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token.
|
X-Enterprise-Project-ID |
No |
String |
Enterprise project ID.
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.
|
Response Parameters
Status code: 200
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. |
Parameter |
Type |
Description |
---|---|---|
id |
String |
Ingress record ID. |
status |
String |
Configuration status for the current VPC to access the CAE environment.
|
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
OK
{ "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" } ] }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot