# 查询环境列表 - ListCoreEnvironments #### 功能介绍 查询当前租户下的环境列表，支持分页和过滤。 **适用场景：** 查看租户下所有环境实例。 按名称筛选环境。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-agentarts/agentarts_07_0003.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-agentarts/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | agentarts:environment:listCoreEnvironments | List | environment \* | - | - | - | | agentarts:environment:listCoreEnvironments | List | - | - g:RequestTag/\ - g:TagKeys | - | - | #### URI GET /v1/core/environments 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | name | 否 | String | **参数解释**： 按环境名称过滤，支持模糊匹配，不传时返回所有环境。 **约束限制**： 不涉及。 **取值范围**： 长度为1-64个字符，可包含中文、字母、数字、下划线和中划线。 **默认取值**： 不涉及。 | | description | 否 | String | **参数解释**： 按环境描述过滤，支持模糊匹配，不传时返回所有环境。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | limit | 否 | Integer | **参数解释**： 每页返回的记录数。 **约束限制**： 不涉及。 **取值范围**： 10-100，单位：条。 **默认取值**： 10 | | offset | 否 | Integer | **参数解释**： 分页查询偏移量，表示从第几条记录开始查询，从1开始。 **约束限制**： 不涉及。 **取值范围**： 1-1000。 **默认取值**： 1 | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | items | Array of [EnvironmentSummary] objects | **参数解释**： 环境列表（列表模式仅返回摘要字段，详情请调用[获取环境详情接口](https://support.huaweicloud.com/api-agentarts/ShowCoreEnvironment.html)），元素个数0-100个。 **取值范围**： 不涉及。 | | total | Integer | **参数解释**： 符合条件的环境总数。 **取值范围**： 0-100000。 | 表3EnvironmentSummary | 参数 | 参数类型 | 描述 | |:---|:---|:---| | environment_id | String | **参数解释**： 环境唯一标识，由系统自动生成。 **取值范围**： 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），例如0451ff49-3c47-4049-851c-51c23fe7fe69。 | | name | String | **参数解释**： 环境名称。 **取值范围**： 长度为2-48个字符，可包含中文、字母、数字、下划线和中划线。 | | description | String | **参数解释**： 环境描述信息。 **取值范围**： 长度为0-4096个字符。 | | network_config | [EnvironmentNetworkConfig] object | **参数解释**： 网络配置。 **取值范围**： 不涉及。 | | associated_agents | Array of [EnvironmentAgentBinding] objects | **参数解释**： 关联到此环境的智能体列表，元素个数0-100个。 **取值范围**： 不涉及。 | | created_at | String | **参数解释**： 创建时间，UTC时间格式，格式为YYYY-MM-DDTHH:mm:ssZ，由系统自动生成。例如：2024-05-20T14:30:00Z。 **取值范围**： 不涉及。 | | updated_at | String | **参数解释**： 更新时间，UTC时间格式，格式为YYYY-MM-DDTHH:mm:ssZ，由系统自动生成。例如：2024-05-20T14:30:00Z。 **取值范围**： 不涉及。 | 表4EnvironmentNetworkConfig | 参数 | 参数类型 | 描述 | |:---|:---|:---| | network_mode | String | **参数解释**： 网络模式。 **取值范围**： 允许的值为： - PUBLIC：表示公网出口。 - VPC：表示虚拟私有云出口。 | | vpc_config | [vpc_config] object | **参数解释**： VPC配置。network_mode为VPC时必填；network_mode为PUBLIC时忽略此字段（若传递返回400错误）。 **取值范围**： 不涉及。 | 表5vpc_config | 参数 | 参数类型 | 描述 | |:---|:---|:---| | vpc_id | String | **参数解释**： VPCID，可以通过[VPC查询接口](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)获取。 **取值范围**： 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），例如0451ff49-3c47-4049-851c-51c23fe7fe69。 | | subnet_id | String | **参数解释**： 子网ID，可以通过[子网查询接口](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0002.html)获取。 **取值范围**： 匹配标准的UUID格式（8-4-4-4-12的十六进制数字串，由连字符分隔），例如0451ff49-3c47-4049-851c-51c23fe7fe69。 | | security_group_ids | Array of strings | **参数解释**： VPC关联的安全组ID列表，元素个数0-10个，每个安全组值的长度为1-36个字符。可以通过[安全组查询接口](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)获取。 **取值范围**： 不涉及。 | 表6EnvironmentAgentBinding | 参数 | 参数类型 | 描述 | |:---|:---|:---| | agent_id | String | **参数解释**： 关联的智能体ID，用于唯一标识一个智能体实例。具体参见[查询智能体列表](https://support.huaweicloud.com/api-agentarts/ListCoreAgents.html)。 **取值范围**： 长度为0-128个字符。 | | agent_name | String | **参数解释**： 关联的智能体名称。 **取值范围**： 长度为0-64个字符。 | **状态码：400** 表7响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。枚举值说明：AgentArts.03000400表示客户端请求参数错误。 **取值范围**： 固定值：AgentArts.03000400。 | | error_msg | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为1-512个字符。 | **状态码：401** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。枚举值说明：AgentArts.03000401表示未授权（认证令牌缺失、无效或已过期）。 **取值范围**： 固定值：AgentArts.03000401。 | | error_msg | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为1-512个字符。 | **状态码：403** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。枚举值说明：AgentArts.03000403表示禁止访问（认证后权限不足）。 **取值范围**： 固定值：AgentArts.03000403。 | | error_msg | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为1-512个字符。 | | coded_authorization_message | String | **参数解释**： 当API无访问权限时报错信息。 **取值范围**： 长度为1-1024个字符。 | | details | Array of [ManagedAgentErrorDetail] objects | **参数解释**： 依赖的下游服务错误信息列表。 **取值范围**： 最小数量0，最大数量10。 | 表10ManagedAgentErrorDetail | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。 **取值范围**： 长度为18个字符。 | | error_msg | String | **参数解释**： 错误信息。 **取值范围**： 长度为1-1024个字符。 | **状态码：429** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。枚举值说明：AgentArts.03000429表示请求过于频繁（触发限流）。 **取值范围**： 固定值：AgentArts.03000429。 | | error_msg | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为1-512个字符。 | **状态码：500** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释**： 错误码。枚举值说明：AgentArts.03000500表示服务器内部错误。 **取值范围**： 固定值：AgentArts.03000500。 | | error_msg | String | **参数解释**： 错误详细信息。 **取值范围**： 长度为1-512个字符。 | #### 请求示例 查询所有环境 ``` GET https://{Endpoint}/v1/core/environments ``` #### 响应示例 **状态码：200** ``` { "items" : [ { "environment_id" : "f47ac10b-58cc-4372-a567-0e02b2c3d479", "name" : "python-data-analysis", "description" : "生产环境VPC网络配置", "associated_agents" : [ { "agent_id" : "a1b2c3d4-1234-5678-abcd-e1f2a3b4c5d6", "agent_name" : "agent-l1ppk" } ], "created_at" : "2024-05-20T14:30:00Z", "updated_at" : "2024-05-20T14:30:00Z" } ], "total" : 1 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 查询成功，返回环境列表。 | | 400 | 请求参数错误。 | | 401 | 未授权。 | | 403 | 禁止访问。 | | 429 | 请求过于频繁。 | | 500 | 服务器内部错误。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-agentarts/ErrorCode.html)。