云服务器内容精选

  • 响应示例 状态码: 200 OK Offer列表 { "data" : [ { "offer_id" : "e49cc59d-48a7-46b2-bfea-************", "offer_code" : "Fconnector-****88ad1de6fc124c519e56************", "offer_name" : "offer1", "offer_description" : "", "create_time" : "2023-12-01T15:06:48Z", "offer_status" : "ON_BOARD" }, { "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_code" : "Fconnector-****1fc857ef325a4a458042************", "offer_name" : "offer2", "offer_description" : "", "create_time" : "2023-11-29T10:19:53Z", "offer_status" : "ON_BOARD" } ], "total" : 2, "error_code" : null, "error_msg" : null }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 data Array of Offer objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 Offer 参数 参数类型 描述 offer_id String Offer ID。 offer_code String offer编码。 offer_name String offer名称。 offer_description String offer描述。 create_time String offer创建时间。 offer_status String offer状态: APPROVING: 审批中 APPROVE_REJECTED:审批拒绝 ON_BOARDING:上架中 ON_BOARD:已上架 ON_BOARD_FAILED:上架失败 OFF_BOARDING:下架中 OFF_BOARD:已下架 OFF_BOARD_FAILED:下架失败 枚举值: APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED 状态码: 400 表6 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表7 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 表2 Query参数 参数 是否必选 参数类型 描述 offer_name 否 String offer名称。 参数校验规则:只能包含英文字母,数字,下划线,中文及-,并且只能以中文和英文开头,最小长度1,最大长度100。 offer_status 否 String offer状态(默认返回已上架offer): APPROVING: 审批中 APPROVE_REJECTED:审批拒绝 ON_BOARDING:上架中 ON_BOARD:已上架 ON_BOARD_FAILED:上架失败 OFF_BOARDING:下架中 OFF_BOARD:已下架 OFF_BOARD_FAILED:下架失败 枚举值: APPROVING APPROVE_REJECTED ON_BOARDING ON_BOARD ON_BOARD_FAILED OFF_BOARDING OFF_BOARD OFF_BOARD_FAILED 参数校验规则:最小长度1,最大长度999999。 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset大于等于0。 最小值:0 最大值:999999 缺省值:0 limit 否 Integer 每页显示条目数量,最大数量999,超过999后只返回999(防止单页返回过大)。 最小值:1 最大值:999 缺省值:10
  • 请求示例 上架offer POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers { "data_resource_list": [{ "data_resource_id": "ab775d2***********b-17317168794e", "data_artifact_id": "f53e7e6e-8*********a4a7cdc3887b", "make_sensitive": [{ "attribute_code": "ID", "reserve_head_len": "3", "reserve_tail_len": "4" }] }], "approver_id": "*****************", "publish_type": "FULL_PUBLIC", "offer_name": "Offer002", "offer_description": "123", "subscription_type": "CONTROLLED_DATA", "policy_json": { "view": { "enables": "true", "times": "1", "app": "2***************1-3338f82c0700" }, "modify": { "enable": "false", "times": "", "app": "" }, "terminate": { "enable": "true" }, "approval": { "enable": "true" }, "download": { "enable": "true", "times": "2", "app": "306******************646d520280,215c118-***************-3338f82c0700,335ac1*************38f82c0700" }, "use": { "users": "", "teams": "", "timeInterval": { "startTime": "2024-02-01T14:46:57Z", "endTime": "2024-03-02T14:46:57Z" } }, "database": { "rows": [{ "column_name": "ID", "condition": "!=", "value": "123" }], "column": "ID,NAME,DESCRIPTION" } }, "target_ids": [ "" ], "app_item_url": "/approvalDetail?offerId=", "can_terminate": "Y" }
  • 响应参数 状态码: 200 表16 响应Body参数 参数 参数类型 描述 data String 返回offer_id。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 400 表17 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码: 500 表18 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。
  • 请求参数 表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 HIDDEN_OFFER_DESCRIPTION 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列表。 app_item_url 否 String app的url。 can_terminate 是 String 是否允许提供方删除数据。 参数校验规则:只能"N"或"Y"。 表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 首端保留长度。 reserve_tail_len 否 Integer 尾端保留长度。 表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 否 String 使用团队。 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 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID,开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID,指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。