# 获取运行服务清单 - ListEnvs #### 功能介绍 本接口用于获取租户在工业数字模型驱动引擎（Industrial Digital Model Engine，简称iDME）中的运行服务清单。该清单包含运行服务的基本信息、状态及配置详情。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/iDME/doc?api=ListEnvs)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-idme/idme_api_0017.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | dme:envs:list | List | - | g:EnterpriseProjectId | dme:envs:get | - | #### URI GET /v1/{project_id}/envs 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，用于标识资源所属的项目空间。 获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-idme/idme_api_0024.html)。 **约束限制：** 不涉及。 **取值范围：** 由英文字母和数字组成，长度为1-36个字符。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | page_num | 否 | Integer | **参数解释：** 分页查询的页码，用于控制当前返回的页数。 **约束限制：** 无。 **取值范围：** 大于等于0的整数。 **默认取值：** 0。 | | page_size | 否 | Integer | **参数解释：** 每页返回的记录数，用于控制分页大小。 **约束限制：** 无。 **取值范围：** 正整数，最大值为500。 **默认取值：** 10。 | | env_types | 否 | String | **参数解释**： 服务的类型。 **约束限制：** 无。 **取值范围：** - STUDIO：iDME设计服务。 - CLOUD_BASIC：基础版数据建模引擎。 - CLOUD_BASIC_LITE：基础版-Lite数据建模引擎。 - CLOUD_TRIAL：体验版数据建模引擎。 - EDGE_BASIC：基础版数据建模引擎（边缘云）。 - CLOUD_LINKX：基础版数字主线引擎。 - CLOUD_LINKX_LITE：基础版-Lite数字主线引擎。 - EDGE_LINKX：基础版数字主线引擎（边缘云）。 **默认取值：** 不涉及。 | #### 请求参数 无 #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | page_num | Integer | **参数解释：** 分页查询的页数。 **取值范围：** 大于等于0的整数。 | | page_size | Integer | **参数解释：** 分页查询时，每页最多展示的记录数。 **取值范围：** 正整数，最大值为500。 | | total_size | Integer | **参数解释：** 总条数。 **取值范围：** 不涉及。 | | total_pages | Integer | **参数解释：** 总页数。 **取值范围：** 不涉及。 | | result | Array of [result] objects | **参数解释：** 运行服务详情。 **取值范围：** 不涉及。 | 表4result | 参数 | 参数类型 | 描述 | |:---|:---|:---| | project_id | String | **参数解释：** 项目ID。 **取值范围：** 由英文字母和数字组成，长度为1-36个字符。 | | region_id | String | **参数解释：** 区域ID。 **取值范围：** 不涉及。 | | env_id | String | **参数解释：** 运行服务的唯一标识。 **取值范围：** 不涉及。 | | env_name | String | **参数解释：** 运行服务的名称。 **取值范围：** 不涉及。 | | env_status | String | **参数解释：** 运行服务的状态。 **取值范围：** - RUNNING：运行中。 - CREATING：创建中。 - CREATING_FAIL：创建失败。 - DELETING：删除中。 - DELETING_FAIL：删除失败。 - CHANGING：变更中。 - FREEZE：已冻结。 - UNAVAILABLE：不可用。 - POLICE_FREEZE：公安冻结。 - EXPANDING：扩容中。 - UPGRADING：升级中。 - UPGRADING_FAIL：升级失败。 | | env_type | String | **参数解释**： 服务的类型。 **取值范围：** - STUDIO：iDME设计服务。 - CLOUD_BASIC：基础版数据建模引擎。 - CLOUD_BASIC_LITE：基础版-Lite数据建模引擎。 - CLOUD_TRIAL：体验版数据建模引擎。 - EDGE_BASIC：基础版数据建模引擎（边缘云）。 - CLOUD_LINKX：基础版数字主线引擎。 - CLOUD_LINKX_LITE：基础版-Lite数字主线引擎。 - EDGE_LINKX：基础版数字主线引擎（边缘云）。 | | env_app_link_status | String | **参数解释：** 运行服务上所部署应用的当前运行状态。 **取值范围：** - RUNNING：应用运行中。 - RUNNING_ERROR：运行异常。 - DEPLOYING：部署中。 - DEPLOY_ERROR：部署异常。 - UNINSTALLING：卸载中。 - UNINSTALL_ERROR：卸载异常。 | | env_app_link_status_msg | String | **参数解释：** 应用部署过程中各阶段的实时状态。如遇部署异常，可通过此信息快速定位并查看异常原因。 **取值范围：** 不涉及。 | | endpoint | String | **参数解释：** 访问方式。 **取值范围：** 不涉及。 | | job_id | String | **参数解释：** 创建运行服务的jobId。 **取值范围：** 不涉及。 | | env_conf_info | String | **参数解释：** 运行服务的配置信息。 **取值范围：** 不涉及。 | | env_app_link_id | String | **参数解释：** 环境应用关联ID。 **取值范围：** 不涉及。 | | app_id | String | **参数解释：** 运行服务上所部署应用的唯一标识。 **取值范围：** 由英文和数字组成。当唯一标识为应用名称时，长度为1-36个字符；当唯一标识为应用ID时，长度固定为32个字符。 | | app_version | String | **参数解释：** 运行服务上所部署应用的版本。 **取值范围：** 不涉及。 | | app_name_en | String | **参数解释：** 运行服务上所部署应用的英文名称。 **取值范围**： 不涉及。 | | app_name_cn | String | **参数解释：** 运行服务上所部署应用的中文名称。 **取值范围：** 不涉及。 | | app_environment | String | **参数解释：** 应用环境。 **取值范围：** 不涉及。 | | enabled | Boolean | **参数解释：** 应用是否可用。 **取值范围：** - true：应用可用。 - false：应用不可用。 | | expire_time | Long | **参数解释：** 运行服务的过期时间。 **取值范围：** 不涉及。 | | last_deploy_time | Long | **参数解释：** 运行服务上最后一次部署应用的时间。 **取值范围：** 不涉及。 | | deploy_user_id | String | **参数解释：** 运行服务上最近一次部署应用的IAM用户ID。 **取值范围：** 不涉及。 | | charging_mode | String | **参数解释：** 计费模式。 **取值范围：** 不涉及。 | | create_time | Long | **参数解释：** 运行服务的创建时间。 **取值范围：** 不涉及。 | | resource_id | String | **参数解释：** 绑定主资源ID。 **取值范围：** 不涉及。 | | resource_spec_code | String | **参数解释：** 资源规格编码。 **取值范围：** 不涉及。 | | org_code | String | **参数解释：** 组织编码。 **取值范围：** 不涉及。 | | org_name | String | **参数解释：** 组织名称。 **取值范围：** 不涉及。 | | app_login_url | String | **参数解释：** 应用登录首页。 **取值范围：** 不涉及。 | | deployable | Boolean | **参数解释：** 是否支持部署。 **取值范围：** - true：支持部署。 - false：不支持部署。 | | app_create_time | String | **参数解释：** 应用创建时间。 **取值范围：** 不涉及。 | | database_type | String | **参数解释：** 数据库类型。 **取值范围：** - mysql：关系型数据库管理系统。 - postgresql：对象-关系型数据库管理系统。 | | uninstallable | Boolean | **参数解释：** 是否支持卸载。 **取值范围：** - true：支持卸载。 - false：不支持卸载。 | | vpc_id | String | **参数解释：** 虚拟私有云ID。 **取值范围：** 不涉及。 | | enterprise_project_id | String | **参数解释：** 企业项目ID。 **取值范围：** 不涉及。 | | read_write_user_limit | String | **参数解释：** 读写用户数量。 **取值范围：** 不涉及。 | | runtime_instance_limit | String | **参数解释：** 运行服务节点数量。 **取值范围：** 不涉及。 | | private_ip_id | String | **参数解释：** 内网ID。 **取值范围：** 不涉及。 | | private_ip | String | **参数解释：** 内网IP。 **取值范围：** 不涉及。 | | security_group_id | String | **参数解释：** 安全组ID。 **取值范围：** 不涉及。 | | workflow_used_status | String | **参数解释：** 流程引擎开启状态。 **取值范围：** - UNUPGRADE：未升级。 - UPGRADE_SUCCESS：升级成功。 - UPGRADE_FAIL：升级失败。 - UPGRADING：升级中。 | | experiences_deployable | Boolean | **参数解释：** 是否可部署体验版。 **取值范围：** - true：可部署体验版。 - false：不可部署体验版。 | | change_able | Boolean | **参数解释：** 是否可变更。 **取值范围：** - true：可变更。 - false：不可变更。 | | delete_able | Boolean | **参数解释：** 是否可删除。 **取值范围：** - true：可删除。 - false：不可删除。 | | grace_time | String | **参数解释：** 宽限期结束时间。 **取值范围：** 不涉及。 | | release_time | String | **参数解释：** 资源释放时间。 **取值范围：** 不涉及。 | | frozen_time | String | **参数解释：** 冻结时间。 **取值范围：** 不涉及。 | | linkx_quota_resp | String | **参数解释：** LinkX-F配额详情。 **取值范围：** 不涉及。 | | structured_data_package_limit | String | **参数解释：** 结构化数据增量包。 此类型增量包可对节点的结构化数据容量进行扩容。单个结构化数据增量包可提供20GB的结构化数据容量。 **取值范围：** 不涉及。 | | file_data_package_limit | String | **参数解释：** 文件数据增量包。 此类型增量包可对节点的文件数据容量进行扩容。单个文件数据增量包可提供500GB的文件数据容量。 **取值范围：** 不涉及。 | | hostname | String | **参数解释：** 默认域名。 **取值范围：** 不涉及。 | | custom_hostname | String | **参数解释：** 用户自定义域名。 **取值范围：** 不涉及。 | | public_ip | String | **参数解释：** 公网IP。 **取值范围：** 不涉及。 | | access_control_type | String | **参数解释：** 访问控制模式。 **取值范围：** - white：白名单模式，仅允许指定的IP地址访问。 - black：黑名单模式，禁止指定的IP地址访问。 - null：无限制，允许所有IP地址访问。 | | hostname_waf_status | String | **参数解释：** 默认域名WAF防护状态。 **取值范围：** - 0：未防护。 - 1：已防护。 | | custom_hostname_waf_status | String | **参数解释：** 自定义域名WAF防护状态。 **取值范围：** - 0：未防护。 - 1：已防护。 | | control_custom_ips | String | **参数解释：** 访问控制IP列表。 **取值范围：** 不涉及。 | | internal_ip | String | **参数解释：** 内网地址。 **取值范围：** 不涉及。 | | internal_ip_status | String | **参数解释：** 内网访问开启状态。 **取值范围：** - OPENED：开启成功。 - OPENING_FAIL：开启失败。 - OPENING：开启中。 - CLOSED：关闭成功。 - CLOSING_FAIL：关闭失败。 - CLOSING：关闭中。 | | transaction_status | String | **参数解释：** 事务状态。 **取值范围：** - CLOSE：关闭。 - OPEN_SUCCESS：开启成功。 - OPEN_FAIL：开启失败。 - OPENING：开启中。 - CLOSE_FAIL：关闭失败。 | | custom_hostname_effective_status | String | **参数解释：** 客户自定义域名是否生效。 **取值范围：** - 0：未生效。 - 1：已生效。 | #### 请求示例 筛选环境类型为STUDIO的运行服务。 ``` GET https://{endpoint}/v1/1234567890/envs?page_num=1&page_size=1&env_types=STUDIO ``` #### 响应示例 **状态码：200** 表示查询成功。 ``` { "page_num" : null, "page_size" : null, "total_size" : null, "total_pages" : null, "result" : [ { "project_id" : "", "region_id" : "", "env_id" : "", "env_name" : "", "env_status" : "RUNNING", "env_app_link_status" : null, "env_app_link_status_msg" : null, "endpoint" : null, "job_id" : null, "env_conf_info" : "", "env_app_link_id" : null, "app_id" : null, "app_version" : null, "app_name_en" : null, "app_name_cn" : null, "enabled" : true, "expire_time" : null, "last_deploy_time" : null, "deploy_user_id" : null, "charging_mode" : "", "create_time" : null, "resource_id" : "", "deployable" : true, "uninstallable" : true, "org_code" : null, "org_name" : null, "app_login_url" : "", "vpc_id" : null, "enterprise_project_id" : "0", "read_write_user_limit" : null, "runtime_instance_limit" : null, "private_ip_id" : "not null", "private_ip" : null, "security_group_id" : "", "workflow_used_status" : null, "internal_ip" : null, "internal_ip_status" : null, "transaction_status" : "CLOSE", "app_environment" : "prod", "experiences_deployable" : true, "change_able" : true, "delete_able" : true, "grace_time" : "2026-06-28T10:00:00Z", "release_time" : "2026-06-30T10:00:00Z", "frozen_time" : "2026-06-27T10:00:00Z", "linkx_quota_resp" : "{}" } ] } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 表示查询成功。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-idme/ErrorCode.html)。