上架offer
功能介绍
上架offer。
URI
POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/offers
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
data_resource_list |
是 |
Array of DataSource objects |
数据源列表。 |
approver_id |
是 |
String |
审批人ID。 |
publish_type |
是 |
String |
发布类型。 枚举值:
|
offer_name |
是 |
String |
邀约名称。 参数校验规则:只能包含英文字母,数字,下划线,中文及-,并且只能以中文和英文开头,最小长度1,最大长度100。 |
offer_description |
否 |
String |
邀约描述。 参数校验规则:最大长度500。 |
subscription_type |
是 |
String |
订阅类型。 枚举值:
|
policy_json |
是 |
PolicyJsonRequest object |
数据使用策略。 |
target_ids |
否 |
Array of strings |
目标ID列表。 |
app_item_url |
否 |
String |
app的url。 |
can_terminate |
是 |
String |
是否允许提供方删除数据。 参数校验规则:只能"N"或"Y"。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
data_resource_id |
是 |
String |
数据源ID。 参数校验规则:最小长度1,最大长度50,匹配字母数字和符号-。 |
data_artifact_id |
是 |
String |
数据组件ID。 参数校验规则:最小长度1,最大长度50,匹配字母数字和符号-。 |
mask_sensitive |
否 |
Array of MaskSensitive objects |
脱敏列信息。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
attribute_code |
否 |
String |
属性code。 |
reserve_head_len |
否 |
Integer |
首端保留长度。 |
reserve_tail_len |
否 |
Integer |
尾端保留长度。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
view |
否 |
ViewDTO object |
查看策略。 |
modify |
否 |
ModifyDTO object |
修改策略。 |
terminate |
否 |
TerminateDTO object |
终止策略。 |
approval |
否 |
ApprovalDTO object |
审批策略。 |
download |
否 |
DownloadDTO object |
下载策略。 |
use |
是 |
UseDTO object |
使用对象策略。 |
database |
否 |
DatabaseDTO object |
数据库策略。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
否 |
Boolean |
是否允许。 |
times |
否 |
String |
次数,仅当enable参数为true时生效。 |
app |
否 |
String |
应用,仅当enable参数为true时生效。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
否 |
Boolean |
是否允许。 |
times |
否 |
String |
次数,仅当enable参数为true时生效。 |
app |
否 |
String |
应用,仅当enable参数为true时生效。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
enable |
否 |
Boolean |
是否允许。 |
times |
否 |
String |
次数,仅当enable参数为true时生效。 |
app |
否 |
String |
应用,仅当enable参数为true时生效。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
users |
否 |
String |
使用人。 |
teams |
否 |
String |
使用团队。 |
timeInterval |
是 |
TimeIntervalDTO object |
时间区间。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
data |
String |
返回offer_id。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
data |
- |
返回null。 |
total |
Long |
总数。 |
error_code |
String |
错误码。 |
error_msg |
String |
错误描述。 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
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 |
错误码
请参见错误码。