获取运行服务清单
功能介绍
本接口用于获取租户在工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME)的运行服务清单。
URI
GET /v1/{project_id}/envs
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 只能由英文字母、数字组成,且长度为[1-36]个字符。 默认取值: 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
page_num |
否 |
Integer |
参数解释: 分页查询的页数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
page_size |
否 |
Integer |
参数解释: 分页查询时,每页最多展示的记录数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
env_types |
否 |
String |
参数解释: 服务的类型。 取值范围:
默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
page_num |
Integer |
参数解释: 分页查询的页数。 取值范围: 不涉及。 默认取值: 1。 |
|
page_size |
Integer |
参数解释: 分页查询时,每页最多展示的记录数。 取值范围: 不涉及。 默认取值: 10。 |
|
total_size |
Integer |
参数解释: 总共条数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
total_pages |
Integer |
参数解释: 总共页数。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
result |
Array of result objects |
参数解释: 运行服务详情。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
project_id |
String |
参数解释: 项目ID。 取值范围: 只能由英文字母、数字组成,且长度为36个字符。 默认取值: 不涉及。 |
|
region_id |
String |
参数解释: 区域ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
env_id |
String |
参数解释: 运行服务的ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
env_name |
String |
参数解释: 运行服务的名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
env_status |
String |
参数解释: 运行服务的状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
env_type |
String |
参数解释: 服务的类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
env_app_link_status |
String |
参数解释: 运行服务与应用间的状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
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 |
参数解释: 部署的应用ID。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
app_version |
String |
参数解释: 部署的应用版本。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
app_name_en |
String |
参数解释: 部署应用的英文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
app_name_cn |
String |
参数解释: 部署应用的中文名称。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
app_environment |
String |
参数解释: 应用环境。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
enabled |
Boolean |
参数解释: 应用是否可用。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
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 |
参数解释: 是否支持部署。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
app_create_time |
String |
参数解释: 应用创建时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
database_type |
String |
参数解释: 数据库类型。 取值范围: 只是Mysql和Postgresql。 默认取值: 不涉及。 |
|
uninstallable |
Boolean |
参数解释: 是否支持卸载。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
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 |
参数解释: 流程引擎开启状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
experiences_deployable |
String |
参数解释: 是否可部署体验版。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
change_able |
String |
参数解释: 是否可变更。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
delete_able |
String |
参数解释: 是否删除。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
grace_time |
String |
参数解释: 宽限期结束时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
release_time |
String |
参数解释: 资源释放时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
frozen_time |
String |
参数解释: 冻结时间。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
linkx_quota_resp |
String |
参数解释: LinkX-F配额详情。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
structured_data_package_limit |
String |
参数解释: 结构化数据增量包。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
file_data_package_limit |
String |
参数解释: 文件数据增量包。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
hostname |
String |
参数解释: 默认域名。 取值范围: 不涉及。 |
|
custom_hostname |
String |
参数解释: 用户自定义域名。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
public_ip |
String |
参数解释: 公网IP。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
access_control_type |
String |
参数解释: 访问控制类型。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
hostname_waf_status |
String |
参数解释: 默认域名WAF防护状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
custom_hostname_waf_status |
String |
参数解释: 自定义域名WAF防护状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
control_custom_ips |
String |
参数解释: 访问控制IP列表。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
internal_ip |
String |
参数解释: 内网地址。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
internal_ip_status |
String |
参数解释: 内网访问开启状态。 取值范围: 不涉及。 默认取值: 不涉及。 |
|
custom_hostname_effective_status |
String |
参数解释: 客户自定义域名是否生效。 取值范围: 0:未生效,1:已生效。 默认取值: 不涉及。 |
请求示例
无
响应示例
状态码:200
OK
{
"page_num" : null,
"page_size" : null,
"total_size" : null,
"total_pages" : null,
"result" : [ {
"project_id" : "",
"region_id" : "",
"env_id" : "",
"env_name" : "",
"env_status" : "",
"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" : "",
"expire_time" : null,
"last_deploy_time" : null,
"deploy_user_id" : null,
"charging_mode" : "",
"create_time" : null,
"resource_id" : "",
"deployable" : "",
"uninstallable" : ""
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK |
错误码
请参见错误码。