更新时间:2024-04-29 GMT+08:00
分享

上架offer

功能介绍

上架offer。

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

请求参数

表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配合生效

响应参数

状态码: 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

错误描述。

请求示例

上架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

OK

  • 用户操作结果
    {
      "data" : "success",
      "total" : 0,
      "error_code" : null,
      "error_msg" : null
    }

状态码

状态码

描述

200

OK

400

Bad Request

500

Internal Server Error

错误码

请参见错误码

分享:

    相关文档

    相关产品