云服务器内容精选

  • 响应示例 状态码: 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 } ] }
  • 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 表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 错误描述。
  • 响应参数 状态码: 200 表16 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 400 表17 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表18 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 请求示例 上架offer POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers { "app_item_url" : "/approvalDetail?offerId=", "approver_id" : "99999000******", "data_resource_list" : [ { "data_resource_id" : "7da43bc2******", "data_artifact_id" : "" } ], "offer_description" : "", "offer_name" : "上架offer", "publish_type" : "SPECIFY_SPACE_EXPOSURE", "subscription_type" : "CONTROLLED_DATA", "target_ids" : [ "connector-1868" ], "policy_json" : { "view" : { "enable" : true, "times" : "", "app" : "321ac118******" }, "modify" : { "enable" : false, "times" : "", "app" : "" }, "download" : { "enable" : true, "times" : "", "app" : "234c118******" }, "approval" : { "enable" : false }, "terminate" : { "enable" : true }, "use" : { "users" : "", "timeInterval" : { "startTime" : "2023-12-11T16:09:33+08:00", "endTime" : "2024-01-10T16:09:33+08:00" } }, "database" : { "column" : "", "rows" : [ ] } } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token,通过调用 IAM 服务“获取用户Token”接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 data_resource_list 否 Array of DataSource objects 数据源列表。 approver_id 是 String 审批人ID。 publish_type 是 String 发布类型。 枚举值: FULL_PUBLIC SPECIFY_SPACE_EXPOSURE SPACE_GROUP_PUBLIC offer_name 是 String 邀约名称。 参数校验规则:只能包含英文字母,数字,下划线,中文及-,并且只能以中文和英文开头,最小长度1,最大长度100。 offer_description 否 String 邀约描述。 参数校验规则:最大长度500。 subscription_type 是 String 订阅类型。 枚举值: OPEN_DATA CONTROLLED_DATA policy_json 否 PolicyJsonRequest object 数据使用策略。 target_ids 否 Array of strings 目标ID列表。 表4 DataSource 参数 是否必选 参数类型 描述 data_resource_id 是 String 数据源ID。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 data_artifact_id 否 String 数据组件ID。 参数校验规则:最小长度1,最大长度50,匹配字母、数字和符号-。 mask_sensitive 否 Array of MaskSensitive objects 脱敏列信息。 表5 MaskSensitive 参数 是否必选 参数类型 描述 attribute_code 否 String 属性code。 reserve_head_len 否 Integer 首端保留长度。 最大值:5000 reserve_tail_len 否 Integer 尾端保留长度。 最大值:5000 表6 PolicyJsonRequest 参数 是否必选 参数类型 描述 view 否 ViewDTO object 查看策略。 modify 否 ModifyDTO object 修改策略。 terminate 否 TerminateDTO object 终止策略。 approval 否 ApprovalDTO object 审批策略。 download 否 DownloadDTO object 下载策略。 use 否 UseDTO object 使用对象策略。 database 否 DatabaseDTO object 数据库策略。 表7 ViewDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许查看。 times 否 String 次数,仅当enable参数为true时生效。 app 否 String 应用,仅当enable参数为true时生效。 表8 ModifyDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许修改。 times 否 String 次数,仅当enable参数为true时生效。 app 否 String 应用,仅当enable参数为true时生效。 表9 TerminateDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许提供方提前终止合约。 表10 ApprovalDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否需要审批。 表11 DownloadDTO 参数 是否必选 参数类型 描述 enable 是 Boolean 是否允许下载。 times 否 String 次数,仅当enable参数为true时生效。 app 否 String 应用,仅当enable参数为true时生效。 表12 UseDTO 参数 是否必选 参数类型 描述 users 否 String 使用人,与teams字段二选一填入 teams 否 String 使用团队,与users字段二选一填入 timeInterval 否 TimeIntervalDTO object 时间区间。 表13 TimeIntervalDTO 参数 是否必选 参数类型 描述 startTime 是 String 开始时间,需要与endTime配合生效。使用UTC时间格式。 endTime 是 String 结束时间,需要与startTime配合生效。使用UTC时间格式。 表14 DatabaseDTO 参数 是否必选 参数类型 描述 column 是 String 列过滤策略。 rows 是 Array of RowDTO objects 行过滤策略。 表15 RowDTO 参数 是否必选 参数类型 描述 column_name 否 String 参数名称,需要与condition、value配合生效。 condition 否 String 参数条件,需要与column_name、value配合生效。 value 否 String 参数条件值,需要与column_name、condition配合生效。
  • URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID,开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。