云服务器内容精选

  • 响应示例 状态码: 200 OK Offer列表 { "data" : [ { "offer_id" : "29146bc7-c5ab-4369-8611-************", "offer_name" : "offer20231121AC-EXCEL", "offer_type" : 2, "need_approval" : null, "can_terminate" : null, "ownered_company_name" : null, "ownered_company_id" : null, "ownered_connector_name" : "连接器A", "ownered_connector_id" : "b40b0d94-3201-4687-93aa-************", "offer_creator_name" : null, "offer_creator_id" : null, "offer_description" : "", "offer_followed_info" : { "offer_subscription" : true, "offer_favorite" : true, "offer_subscription_num" : 2, "offer_favorite_num" : 0, "offer_view_num" : 1 }, "mask_sensitive" : null, "use_control_policies_template" : null } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of OfferSummary objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 OfferSummary 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 offer_type Integer Offer公开范围:公开-1、受控-2。 need_approval Boolean 是否需要审批。 注:开启【需要审批】后,下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 ownered_company_name String Offer所属的企业,即所属租户名。 ownered_company_id String Offer所属的企业ID,即所属租户ID。 ownered_connector_name String Offer所属的连接器,即所属连接器名。 ownered_connector_id String Offer所属的连接器ID,即所属连接器id。 offer_creator_name String Offer创建者名称。 offer_creator_id String Offer创建者ID。 offer_description String Offer描述。 subscription_type String 订阅类型: OPEN_DATA:公开数据 CONTROLLED_DATA:受控数据 offer_followed_info OfferFollowed object Offer引用信息。 mask_sensitive Array of MaskSensitive objects 结构化数据列脱敏信息。 use_control_policies_template Array of UseControlPoliciesInner objects 合约使用控制策略列表。 表6 OfferFollowed 参数 参数类型 描述 offer_subscription Boolean Offer订阅状态。 offer_favorite Boolean Offer收藏状态。 offer_subscription_num Integer Offer订阅次数。 offer_favorite_num Integer Offer收藏次数。 offer_view_num Integer Offer查看次数。 表7 MaskSensitive 参数 参数类型 描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 最大值:5000 reserve_tail_len Integer 尾端保留长度。 最大值:5000 表8 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤: VIEW:查看 MODIFY:加工 DOWNLOAD:下载 枚举值: VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 参数校验规则:最小值1,最大值10000。 where Where object 限制地点列表。 who Array of strings 限制用户/团队列表。(目前不支持多个用户或者团队) user_type String 限制用户类型。(团队订阅时who和user_type必填) USER :指定用户 TEAM :指定团队 枚举值: USER TEAM application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 表9 TimeInterval 参数 参数类型 描述 start_time String 起始时间,UTC时间格式。 end_time String 截止时间,UTC时间格式。 表10 Where 参数 参数类型 描述 device_ip Array of strings 限定访问IP。 device_mac Array of strings 限定访问设备MAC。 表11 DatabaseAttributes 参数 参数类型 描述 column String 可见列。 rows Array of RowDTO objects 可见行。 表12 RowDTO 参数 参数类型 描述 column_name String 参数名称,需要与condition、value配合生效。 condition String 参数条件,需要与column_name、value配合生效。 value String 参数条件值,需要与column_name、condition配合生效。 状态码: 400 表13 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表14 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 key_words 否 String 搜索的关键字,如果是多个关键字,通过空格分开,默认为全量搜索。 ownered_company_name 否 String 限定租户名,即限定企业。 ownered_connector_name 否 String 限定连接器名。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 响应示例 状态码: 200 OK 查看实例化应用列表。 { "data" : [ { "type" : "UNSTRUCTURED", "name" : "OBS4", "id" : "70d5c8d0-fe76-4cf0-9d30-***********", "temp_id" : "335ac118-758e-4324-9d41-***********", "temp_name" : "文档下载", "natives" : false, "operation" : [ "DOWNLOAD" ], "description" : "abc", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "connection" : { "datasource_type" : "OBS", "connection" : null }, "create_user_id" : "test-***********", "create_user_name" : "test-***********", "create_date" : "2023-11-21T16:50:53Z" } ], "total" : 1, "error_code" : null, "error_msg" : null }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of AppInfo objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 AppInfo 参数 参数类型 描述 type String 实例化的应用类型: STRUCTURED:支持jdbc、csv下载 TRUSTED_ENV:支持可信环境下载 LOCAL_DOWN:支持本地下载 LUCKY_EXCEL:支持excel本地预览 UNSTRUCTURED:支持 obs、sftp、ftp下载 PDF_JS:支持pdf本地预览 STRUCTURED_VIEW:支持csv jdbc本地预览 WPS:wps应用 IMAGE_VIEWER:本地图片查看 枚举值: STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER name String 应用名称。 id String 应用ID。 temp_id String 应用模板ID。 temp_name String 应用模板名称。 natives Boolean 是否内置应用 true:内置 false:自创 operation Array of strings 应用操作。 枚举值: VIEW PRO CES S DOWNLOAD description String 应用描述。 icon String 应用图标。 connection DataSourceConnect object 应用连接信息。 create_user_id String 创建人ID。 create_user_name String 创建人名称。 create_date String 创建时间。 表6 DataSourceConnect 参数 参数类型 描述 datasource_type String 数据源类型。 枚举值: MRS _HIVE ORACLE MYSQL DWS GAUSS_DB FTP SFTP OBS WPS API connection DataSourceConnection object 数据源连接信息。 表7 DataSourceConnection 参数 参数类型 描述 obs_connection ObsConnection object OBS数据源连接信息。 表8 ObsConnection 参数 参数类型 描述 endpoint String OBS访问地址。 参数校验规则:最小长度1,最大长度1000,匹配 域名 正则表达式。 bucket_name String OBS名称。 参数校验规则:最小长度1,最大长度100,匹配字母、数字、下划线、.及-。 access_key String OBS永久访问密钥。 参数校验规则:最大长度1024。 secret_key String OBS永久密钥。 参数校验规则:最大长度1024。 path String OBS访问路径。 参数校验规则:最小长度1,最大长度100,只能包含英文字母、数字、下划线、中文、/、\及-。 状态码: 400 表9 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表10 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10 app_name 否 String 实例化APP名称。 ids 否 Array 实例化APP ID。 operations 否 Array 执行动作过滤。 枚举值: VIEW PROCESS DOWNLOAD status 否 Array 状态: NORMAL:正常使用状态 DISABLE:停用状态,不再分配给新的eds实例 枚举值: NORMAL DISABLE
  • 调用API获取连接器ID 连接器ID还可通过调用查询连接器列表API获取。 获取连接器ID的接口为GET https://{eds-endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors,响应体中data下的“connector_id”即为连接器ID。 eds-endpoint为EDS的终端节点,EDS部署在“华北-北京四”区域,Endpoint为“eds-combine.cn-north-4.myhuaweicloud.com”,“华南-广州-友好用户环境”区域,Endpoint为“eds-combine.cn-south-4.myhuaweicloud.com”。 project_id为项目ID,开通服务后可在控制台查询,查询方法请参考获取项目ID。 instance_id为实例ID,创建实例后可在控制台查询,查询方法请参考获取实例ID。
  • 管理数据资产 数据资产管理创建完成后,用户可以根据需要对主题域分组、主题域、业务对象等进行修改、删除等操作,具体操作如表7所示。 表7 操作说明 操作 说明 编辑主题域分组信息 单击主题域分组名称,在界面右侧基础信息区域单击“编辑”。 参考表2修改主题域分组信息,单击“确定”。 删除主题域分组 单击主题域分组名称,在界面右侧主题域分组名称区域单击“删除”。 在弹框中单击“确定”。 为主题域分组关联组织 单击创建的主题域分组,在界面右侧关联组织区域单击“添加关联”。 在弹框中选择组织子类型,然后选择子类型下的组织,单击“确定”。 为主题域分组解绑组织 单击主题域分组名称,在界面右侧关联组织区域单击“解绑”。 在弹框中单击“确定”。 编辑主题域信息 单击主题域分组名称,在界面右侧关联主题域区域单击操作列的“编辑”,修改主题域信息,单击“确定”。 单击主题域名称,在界面右侧基础信息区域单击“编辑”,修改主题域信息,单击“确定”。 删除主题域 单击主题域分组名称,在界面右侧关联主题域区域单击操作列的“删除”,在弹框中单击“确定”。 单击主题域名称,在界面右侧主题域名称区域单击“删除”,在弹框中单击“确定”。 编辑业务对象信息 单击主题域名称,在界面右侧关联业务对象区域单击操作列的“编辑”,修改业务对象信息,单击“确定”。 单击业务对象名称,在界面右侧基础信息区域单击“编辑”,修改业务对象信息,单击“确定”。 删除业务对象 单击主题域名称,在界面右侧关联业务对象区域单击操作列的“删除”,在弹框中单击“确定”。 单击业务对象名称,在界面右侧业务对象名称区域单击“删除”,在弹框中单击“确定”。 为业务对象关联业务能力 单击业务对象名称,在界面右侧关联业务能力区域单击“添加关联”。 在弹框中选择业务能力子类型,然后选择子类型下的业务能力,单击“确定”。 为业务对象解绑业务能力 单击业务对象名称,在界面右侧关联业务能力区域单击“解绑”。 在弹框中单击“确定”。 编辑逻辑实体信息 单击业务对象名称,在界面右侧关联逻辑实体区域单击操作列的“编辑”,修改逻辑实体信息,单击“确定”。 单击逻辑实体名称,在界面右侧基础信息区域单击“编辑”,修改逻辑实体信息,单击“确定”。 删除逻辑实体 单击业务对象名称,在界面右侧关联逻辑实体区域单击操作列的“删除”,在弹框中单击“确定”。 单击逻辑实体名称,在界面右侧逻辑实体名称区域单击“删除”,在弹框中单击“确定”。 为逻辑数据实体关联数据集 单击逻辑数据实体名称,在界面右侧关联数据集区域单击“添加”。 在弹框中选择数据集子类型,然后选择子类型下的数据集,单击“确定”。 为逻辑数据实体解绑数据集 单击逻辑数据实体名称,在界面右侧关联数据集区域单击“解绑”。 在弹框中单击“确定”。 编辑属性信息 单击逻辑实体名称,在界面右侧关联属性区域单击操作列的“编辑”,修改属性信息,单击“确定”。 单击属性名称,在界面右侧基础信息区域单击“编辑”,修改属性信息,单击“确定”。 删除属性 单击逻辑实体名称,在界面右侧关联属性区域单击操作列的“删除”,在弹框中单击“确定”。 单击属性名称,在界面右侧属性名称区域单击“删除”,在弹框中单击“确定”。 为实体属性关联数据集字段 单击实体属性名称,在界面右侧关联数据集字段区域单击“添加”。 在弹框中选择数据集字段,单击“确定”。 为实体属性解绑数据集字段 单击属性名称,在界面右侧关联数据集字段区域单击“解绑”。 在弹框中单击“确定”。
  • 更多操作 数据连接创建完成后,用户可以根据需要对数据连接进行修改、删除等操作,具体操作如表3所示。 表3 操作说明 操作 说明 查看数据连接详情 单击数据连接列表数据连接名称,查看数据连接详情。 编辑数据连接 单击数据连接列表操作列的“编辑”,对已有的数据连接配置信息进行重新修改,部分字段不可编辑。 删除数据连接 单击数据连接列表操作列的“删除”,在弹框中单击“确定”。 测试连接 测试连接即测试元模型与数据源之间是否能够联通,是采集任务能够正常执行的重要前提条件。 单击数据连接列表操作列的“测试连接”即可。
  • 以地图方式展示企业架构 进入DMAP数小二实例控制台界面。 登录 交换数据空间 控制台,在页面左侧导航栏选择“DMAP数小二”,然后选择DMAP实例,单击“开始使用”。 租户可执行此步骤。 登录DMAP数小二。 组织成员可执行此步骤。 单击“架构地图”,在页面右上角单击“地图”,页面切换为地图模式。 选择架构,如选择为“业务架构”。 选择架构下的元数据,如选择为“价值流”。 选择领域,按领域进行筛选,如选择为“业务单元”,表示在业务架构下,查看与选择的业务单元有关联的价值流。 如图1,页面以地图方式展示已选择的架构的关系图以及实体基本信息,单击“查看详情”,查看实体详情。 图1 以地图方式展示价值流
  • 以目录方式展示企业架构 进入DMAP数小二实例控制台界面。 登录交换数据空间控制台,在页面左侧导航栏选择“DMAP数小二”,然后选择DMAP实例,单击“开始使用”。 租户可执行此步骤。 登录DMAP数小二。 组织成员可执行此步骤。 单击“架构地图”,在页面右上角单击“目录”,页面切换为目录模式。 选择架构,如选择为“业务架构”。 选择架构下的元数据,如选择为“价值流”。 选择领域,按领域进行筛选,如选择为“业务单元”,表示在业务架构下,查看与选择的行政单元有关联的价值流。 如图2,页面以目录方式展示已选择的架构,单击价值流或价值流阶段,在页面右侧展示详情。 图2 以目录方式展示价值流
  • 审批订阅申请 进入DMAP数小二实例控制台界面。 登录交换数据空间控制台,在页面左侧导航栏选择“DMAP数小二”,然后选择DMAP实例,单击“开始使用”。 租户可执行此步骤。 登录DMAP数小二。 组织成员可执行此步骤。 在页面右上角单击,然后选择“我的待办”,进入“我的待办”页面。 在“我的待办”页面查看“未处理”或“已处理”的任务。 单击“未处理”的任务标题,查看任务申请详情。如为报告发布审批任务,在审批页面查看报告详情。 在“审批意见”区域进行“同意”或“驳回”操作,并填写审批意见。 在“审批记录”区域查看审批历史记录。 图1 审批订阅申请 单击“提交”,审批完成。
  • 更多操作 流程创建完成后,用户可以根据需要对流程进行修改、删除等操作,具体操作如表7所示。 表7 操作说明 操作 说明 编辑流程类信息 在流程目录处单击流程类名称,在界面右侧流程类名称区域单击“编辑”。 参考表1修改流程类信息,单击“确定”。 删除流程类 在流程目录处单击流程类名称,在界面右侧流程类名称区域单击“删除”。 在弹框中单击“确定”。 修改流程组信息 在流程目录处单击流程类名称,在界面右侧关联流程组区域单击操作列的“编辑”,参考表2修改流程组信息,单击“确定”。 在流程目录处单击流程组名称,在界面右侧流程组名称区域单击“编辑”,参考表2修改流程组信息,单击“确定”。 删除流程组 在流程目录处单击流程类名称,在界面右侧关联流程组区域单击操作列的“删除”,在弹框中单击“确定”。 在流程目录处单击流程组名称,在界面右侧流程组名称区域单击“删除”,在弹框中单击“确定”。 修改流程信息 在流程目录处单击流程组名称,在界面右侧关联流程区域单击操作列的“编辑”,参考表3修改流程信息,单击“确定”。 在流程目录处单击流程名称,在界面右侧流程名称区域单击“编辑”,参考表3修改流程信息,单击“确定”。 删除流程 在流程目录处单击流程组名称,在界面右侧关联流程区域单击操作列的“删除”,在弹框中单击“确定”。 在流程目录处单击流程名称,在界面右侧流程名称区域单击“删除”,在弹框中单击“确定”。 删除子流程 在流程目录处单击流程名称,在界面右侧关联子流程区域单击操作列的“删除”,在弹框中单击“确定”。 在流程目录处单击子流程名称,在界面右侧子流程名称区域单击“删除”,在弹框中单击“确定”。 修改子流程信息 在流程目录处单击流程名称,在界面右侧关联子流程区域单击操作列的“编辑”,参考表5修改子流程信息,单击“确定”。 在流程目录处单击子流程名称,在界面右侧子流程名称区域单击“编辑”,参考表5修改子流程信息,单击“确定”。 解绑组织 在流程目录处单击流程类/流程组/流程/子流程名称,在界面右侧关联组织区域单击“解绑”,在弹框中单击“确定”。 解绑业务能力 在流程目录处单击流程组名称,在界面右侧关联业务能力区域单击“解绑”,在弹框中单击“确定”。 解绑应用 在流程目录处单击流程/子流程名称,在界面右侧关联应用区域单击“解绑”,在弹框中单击“确定”。
  • 以目录方式展示数据资产 进入DMAP数小二实例控制台界面。 登录交换数据空间控制台,在页面左侧导航栏选择“DMAP数小二”,然后选择DMAP实例,单击“开始使用”。 租户可执行此步骤。 登录DMAP数小二。 组织成员可执行此步骤。 单击“数据地图”,在页面右上角单击“目录”,页面切换为目录模式。 选择数据类型,如选择为“数据资产”。 选择领域,按领域进行筛选,如选择为“功能领域”,表示查看与选择的功能领域有关联的主题域。 页面以目录方式展示已选择的数据资产,单击主题域,在页面右侧展示详情。
  • 更多操作 如您仅拥有平台用户权限,则只支持查看数据资产详情。 如您拥有其他角色权限,如信息架构师、数据管家等,数据地图以目录方式展示数据资产时,根据拥有的权限支持对数据资产进行编辑、删除等操作。 在数据地图页面,以目录方式展示数据资产时,您还可以执行如下所示更多操作。 表1 更多操作 更多操作 说明 数据资产页签相关操作 详细请参考通过DMAP数小二创建数据资产。 数据资源页签相关操作 详细请参考通过DMAP数小二创建数据资源。 数据标准页签相关操作 详细请参考通过DMAP数小二创建数据标准。