获取VPC访问CAE环境配置 - ListVpcIngress

功能介绍

获取VPC访问CAE环境配置。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

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

URI

GET /v1/{project_id}/cae/vpc-ingress

表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。

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
api_version	String	API版本，固定值“v1”，该值不可修改。
kind	String	API类型，固定值“VpcIngress”，该值不可修改。
items	Array of VpcIngressGetResponseBodyItem objects	VPC访问CAE环境配置。

表4 VpcIngressGetResponseBodyItem
参数	参数类型	描述
id	String	Ingress记录的ID。
status	String	参数解释：当前VPC访问CAE环境的配置状态。取值范围： available：可用状态 creating：创建状态 deleting：删除状态 create_failed：创建失败状态 delete_failed：删除失败状态默认取值：不涉及。
job_id	String	创建Ingress的job的ID。
vpc_id	String	所选VPC ID。
subnet_id	String	所选VPC子网ID。

请求示例

获取VPC访问CAE环境配置。

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

响应示例

状态码：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"
  } ]
}