云服务器内容精选

  • 服务访问配置概述 在公有云场景下,将应用成功部署到基础版数据建模引擎上后,可使用iDME提供的默认公网 域名 访问应用运行态。为了提升应用运行态的访问安全性,建议开启域名防护和进行访问控制配置。如果还想在Internet上使用自定义域名来访问应用运行态,您可以通过配置自定义域名实现。如果想实现安全的HTTPS访问,您可以通过配置HTTPS证书实现应用运行态的安全访问。如果想通过内网IP地址访问应用运行态,您可以开启内网访问。 仅公有云场景下的基础版数据建模引擎支持以下配置: 配置自定义域名 配置域名防护 配置访问控制 配置HTTPS证书 配置内网访问 在边缘云场景下,您可以通过将弹性公网IP绑定到数据建模引擎上,部署在此运行服务的应用便可与公网通信。绑定弹性公网IP后,如您不再需要与公网通信时,也可将服务与弹性公网IP解绑。详细操作请参见绑定和解绑弹性公网IP。 以下为您介绍服务访问配置管理中各配置的详细操作步骤: 在进行服务访问配置操作之前,请确保已获取管理员权限的 IAM 用户的账号和密码。
  • 绑定和解绑弹性公网IP 弹性公网IP(Elastic IP,简称EIP)提供独立的公网IP资源,包括公网IP地址与公网出口带宽服务。弹性公网IP可以与弹性云服务器、裸金属服务器、虚拟IP、弹性负载均衡、NAT网关等资源灵活地绑定,提供访问公网和被公网访问的能力。 绑定弹性公网IP:通过将弹性公网IP绑定到边缘云场景下的基础版数据建模引擎上,部署在此运行服务的应用便可与公网通信。此时,您便可通过公网地址访问应用运行态。 解绑弹性公网IP:绑定弹性公网IP后,如您不再需要与公网通信时,可将服务与弹性公网IP解绑。 登录iDME控制台。 在左侧导航栏中,单击“数据建模引擎”,进入数据建模引擎页面。 (可选)如果同时有部署在“公有云”上和“边缘云”上的服务,请切换到边缘云。 找到待操作的运行服务,通过服务名称链接进入详情页。 单击“连接管理”,进入连接管理页签。 绑定弹性公网IP。 单击“绑定”,弹出绑定公网IP窗口。 选择需要绑定的弹性公网IP,单击“确定”。 完成绑定后,可以在详情页查看已绑定的弹性公网IP。 如果没有可用的弹性公网IP,单击“查看弹性公网IP地址”,创建新的弹性公网IP。 如果待绑定弹性公网IP的运行服务已部署应用,在完成绑定弹性公网IP后,需重新部署应用才可在该应用运行态生效。 解绑弹性公网IP。 单击“解绑”,弹出解绑公网IP窗口。 根据提示输入指令,单击“确定”。
  • 基础版应用运行态 根据基础版数据建模引擎部署位置不同,对应的应用运行态的登录方式有所不同。 表1 应用运行态登录方式 部署位置 登录方式 IP地址 使用场景 说明 公有云 默认公网域名 基础版数据建模引擎默认提供公网IP 基础版数据建模引擎默认提供公网域名。 成本低,易用性高。 自定义域名 - 在Internet上使用自定义域名来访问应用运行态。 用户需要备案自定义域名并绑定至对应的基础版数据建模引擎上,详细请参见配置自定义域名。 内网访问 内网IP地址 当运行服务与弹性云服务器(Elastic Cloud Server,简称E CS )处于同一区域时,绑定虚拟私有云(Virtual Private Cloud,简称VPC)并部署应用后,便可通过API接口在用户ECS上访问应用运行态。 安全性更高,传输速率更高,网络延迟减少。详细请参见配置内网访问。 边缘云 用户内网登录 用户内网IP地址 在边缘云场景下,使用SSF提供的用户登录认证和用户管理能力,实现用户本地登录认证。 安全性更高,传输速率更高,网络延迟减少。 用户需要购买智能边缘小站。 公网登录 弹性公网IP地址 不能通过内网IP地址访问应用运行态时,使用公网访问。 成本低,易用性高。 用户需要绑定弹性公网IP,请参考绑定和解绑弹性公网IP。
  • 操作步骤 获取接口相关信息。 URI格式:GET /v1/{project_id}/apps 详情请参见获取租户下的应用清单。 在Request Header中增加“X-Auth-Token”。 发送“GET https://{iDME Endpoint}/v1/{project_id}/apps”。 {project_id}请从获取项目ID获取。 查看请求响应结果。 请求成功时,响应参数如下: { "result": [ { "id": "44145d41ae294e111111eafd4da32ea8", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1690427901000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1690427901000, "name_cn": "TestApp", "name_en": "TestApp", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "beta", "owners": [ "user_1", "idme_container1" ] }, { "id": "c787dcd484944ad11111dd18693e4eb2", "project_id": "cf49a20d85294c93b1111111ca9454bc", "mark_for_delete": 0, "create_by": "59779076d1dc********c91c2c54bd7a", "create_time": 1689622165000, "update_by": "59779076d1dc********c91c2c54bd7a", "update_time": 1689622165000, "name_cn": "工业产品问卷调查", "name_en": "Questionnaire_Survey", "desc_cn": "", "desc_en": "", "database_type": "mysql", "environment": "dev", "owners": [ "dme-console" ] } ], "page_num": 1, "page_size": 500, "total_size": 2, "total_pages": 1 } 请求异常时,错误码请参见错误码。
  • 前提条件 已开通工业数字模型驱动引擎(Industrial Digital Model Engine,简称iDME),并根据开通区域确定调用API的Endpoint,详细信息请参见地区与终端节点。 当您使用Token认证方式完成认证鉴权时,需要获取用户Token并在调用接口时增加“X-Auth-Token”到业务接口请求消息头中。Token认证,具体操作请参考认证鉴权。 通过IAM服务获取到的Token有效期为24小时,需要使用同一个Token鉴权时,可以先将Token缓存,避免频繁调用。
  • URI DELETE /v1/{project_id}/envs/{env_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 env_id 是 String 参数解释: 运行服务的ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 app_id 是 String 参数解释: 待卸载应用的ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • URI DELETE /v1/{project_id}/apps/{app_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 app_id 是 String 参数解释: 应用ID。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 id String 参数解释: 应用ID。 取值范围: 不涉及。 project_id String 参数解释: 项目ID。 取值范围: 不涉及。 mark_for_delete Integer 参数解释: 删除标记。 取值范围: 0:未删除 1:删除 create_by String 参数解释: 创建人。 取值范围: 不涉及。 create_time Long 参数解释: 创建时间。 取值范围: 不涉及。 update_by String 参数解释: 更新人。 取值范围: 不涉及。 update_time Long 参数解释: 更新时间。 取值范围: 不涉及。 name_cn String 参数解释: 应用的中文名称。 取值范围: 应用名称只能包含中文、英文字母、数字、“_”、“-”,且不能为XDM,最大长度128字符。 name_en String 参数解释: 应用的英文名称。 取值范围: 英文长度128个字符以内,只允许大写字母开头,且不能为XDM,且只包含字母和数字。 desc_cn String 参数解释: 应用的中文描述。 取值范围: 只能包含中文、大小写英文字母、数字、括号、“_”、“-”、空格、标点符号,最大长度1024个字符。 desc_en String 参数解释: 应用的英文描述。 取值范围: 只能包含大小写英文字母、数字、“_”、“-”、空格、标点符号,最大长度1024个字符。 database_type String 参数解释: 应用的数据库类型。 取值范围: 支持MySQL和PostgreSQL。 environment String 参数解释: 运行服务的环境标识。 取值范围: dev:用于开发环境。 sit:用于功能测试环境。 uat:用于用户测试环境。 train:用于培训环境。 beta:用于灰度部署环境。 production:用于生产环境。 versions String 参数解释: 应用责任人。 取值范围: 不涉及。 migrating Boolean 参数解释: 判断是否在迁移中。 取值范围: true:迁移中。 false:未迁移。
  • 响应示例 状态码: 200 OK { "id" : "", "project_id" : "", "mark_for_delete" : 0, "create_by" : "", "create_time" : 1685987901000, "update_by" : "", "update_time" : 1685987901000, "name_cn" : "wdqw222", "name_en" : "QDwqwq222", "desc_cn" : "QDwqwq222", "desc_en" : "qewqew222", "database_type" : "mysql", "environment" : "dev", "versions" : null }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 参数解释: IAM用户的token。 获取方法请参见获取IAM用户Token。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及 表3 请求Body参数 参数 是否必选 参数类型 描述 app_name_cn 是 String 参数解释: 应用的中文名称。 约束限制: 不涉及。 取值范围: 应用名称只能包含中文、英文字母、数字、“_”、“-”,且不能为XDM,最大长度128字符 默认取值: 不涉及。 app_name_en 是 String 参数解释: 应用的英文名称 约束限制: 不涉及。 取值范围: 英文长度128个字符以内,只允许大写字母开头,且不能为XDM,且只包含字母和数字。 默认取值: 不涉及。 app_desc 否 String 参数解释: 应用的中文描述。 约束限制: 不涉及。 取值范围: 只能包含中文、大小写英文字母、数字、括号、“_”、“-”、空格、标点符号,最大长度1024个字符。 默认取值: 不涉及。 app_desc_en 否 String 参数解释: 应用的中文描述。 约束限制: 不涉及。 取值范围: 只能包含大小写英文字母、数字、“_”、“-”、空格、标点符号,最大长度1024个字符。 默认取值: 不涉及。 operate_type 否 String 参数解释: 操作类型。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 app_env 是 String 参数解释: 环境标识。 约束限制: 不涉及。 取值范围: dev:用于开发环境。 sit:用于功能测试环境。 uat:用于用户测试环境。 train:用于培训环境。 beta:用于灰度部署环境。 production:用于生产环境。 默认取值: 不涉及。 database_type 是 String 参数解释: 数据库类型。 约束限制: 不涉及。 取值范围: 支持MySQL和PostgreSQL 默认取值: 不涉及。 app_user_list 是 Array of AppUserList objects 参数解释: 应用责任人。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 integration_mode 是 String 参数解释 集成模式。 约束限制: 不涉及。 取值范围: API SDK 默认取值: 不涉及。 metadata_synchronization 否 Boolean 参数解释: 元模型同步。 约束限制: 不涉及。 取值范围: true:同步元模型 false: 不同步元模型 默认取值: 不涉及。 表4 AppUserList 参数 是否必选 参数类型 描述 id 否 String 用户ID。 name 否 String 用户名。
  • 响应示例 状态码: 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 表2 响应Body参数 参数 参数类型 描述 page_num Integer 参数解释: 分页查询的页数。 取值范围: 不涉及。 page_size Integer 参数解释: 分页查询时,每页最多展示的记录数。 取值范围: 不涉及。 total_size Integer 参数解释: 总共条数。 取值范围: 不涉及。 total_pages Integer 参数解释: 总共页数。 取值范围: 不涉及。 result Array of result objects 参数解释: 运行服务详情。 取值范围: 不涉及。 表3 result 参数 参数类型 描述 project_id String 参数解释: 项目ID。 取值范围: 不涉及。 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配额详情。 取值范围: 不涉及。 structured_data_package_limit String 参数解释: 结构化数据增量包。 取值范围: 不涉及。 search_data_package_limit String 参数解释: 搜索服务增量包。 取值范围: 不涉及。 file_data_package_limit String 参数解释: 文件数据增量包。 取值范围: 不涉及。 baseline_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列表。 取值范围: 不涉及。
  • 调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”,其中{Endpoint}为IAM的终端节点,可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 响应示例 状态码: 200 OK { "result": [ { "id": "", "project_id": "", "mark_for_delete": 0, "create_by": "", "create_time": 1673474220000, "update_by": "", "update_time": 1682984766000, "name_cn": "", "name_en": "", "desc_cn": "", "desc_en": "", "database_type": "", "environment": "", “migrating_status”:"" "owners": [ "op_svc_idme_container1", "dme-console" ] } ], "page_num": 1, "page_size": 15, "total_size": 13, "total_pages": 1 }
  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 page_num Integer 参数解释: 分页查询时,每页最多展示的记录数。 取值范围: 不涉及。 page_size Integer 参数解释: 分页查询的页数。 取值范围: 不涉及。 total_size Integer 参数解释: 总共条数。 取值范围: 不涉及。 total_pages Integer 参数解释: 总页数。 取值范围: 不涉及。 result Array of result objects 参数解释: 应用详情。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 表3 result 参数 参数类型 描述 id String 参数解释: 应用ID。 取值范围: 不涉及。 project_id String 参数解释: 项目ID。 取值范围: 不涉及。 mark_for_delete Integer 参数解释: 删除标记。 取值范围: 不涉及。 create_by String 参数解释: 创建人。 取值范围: 不涉及。 create_time Long 参数解释: 创建时间。 取值范围: 不涉及。 update_by String 参数解释: 更新人。 取值范围: 不涉及。 update_time Long 参数解释: 更新时间。 取值范围: 不涉及。 name_cn String 参数解释: 应用的中文名称。 取值范围: 不涉及。 name_en String 参数解释: 应用的英文名称。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 desc_cn String 参数解释: 应用的中文描述。 取值范围: 不涉及。 desc_en String 参数解释: 应用的英文描述。 取值范围: 不涉及。 database_type String 参数解释: 应用的数据库类型。 取值范围: 不涉及。 environment String 参数解释: 运行服务的环境标识。 取值范围: 不涉及。 owners Array of strings 参数解释: 应用责任人。 取值范围: 不涉及。