文档首页> 交换数据空间 EDS> API参考> API> 合约管理> 点对点生成合约

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

在线调试

CLI示例

查看PDF

点对点生成合约

功能介绍

点对点生成合约。

URI

POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/point-to-point

表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参数
参数	是否必选	参数类型	描述
contract_name	是	String	合约名称。参数校验规则：只能包含英文字母，数字，下划线，中文及-，并且只能以中文和英文开头，最小长度1，最大长度100。
contract_description	否	String	合约描述。参数校验规则：最大长度500。
connector_policies	是	Array of ConnectorPolicyVO objects	每个连接器对应的策略信息。
approver_id	是	String	点对点审批人。参数校验规则：最小长度1，最大长度50，匹配字母数字和符号-。
file_assets	是	Array of FileAsset objects	多资产id。

表4 ConnectorPolicyVO
参数	是否必选	参数类型	描述
connector_id	是	String	连接器ID。
policy_json	是	PolicyJsonRequest object	数据使用策略。

表5 PolicyJsonRequest
参数	是否必选	参数类型	描述
view	是	ViewDTO object	查看策略。
modify	是	ModifyDTO object	修改策略。
terminate	是	TerminateDTO object	终止策略。
approval	是	ApprovalDTO object	审批策略。
download	是	DownloadDTO object	下载策略。
use	是	UseDTO object	使用对象策略。
database	是	DatabaseDTO object	数据库策略。

表6 ViewDTO
参数	是否必选	参数类型	描述
enable	是	Boolean	是否允许。
times	否	String	次数，仅当enable参数为true时生效。
app	否	String	应用，仅当enable参数为true时生效。

表7 ModifyDTO
参数	是否必选	参数类型	描述
enable	是	Boolean	是否允许。
times	否	String	次数，仅当enable参数为true时生效。
app	否	String	应用，仅当enable参数为true时生效。

表8 TerminateDTO
参数	是否必选	参数类型	描述
enable	是	Boolean	是否允许。

表9 ApprovalDTO
参数	是否必选	参数类型	描述
enable	是	Boolean	是否允许。

**表10** DownloadDTO
参数	是否必选	参数类型	描述
enable	是	Boolean	是否允许。
times	否	String	次数，仅当enable参数为true时生效。
app	否	String	应用，仅当enable参数为true时生效。

**表11** UseDTO
参数	是否必选	参数类型	描述
users	是	String	使用人，与teams字段二选一填入。
teams	是	String	使用团队，与users字段二选一填入。
timeInterval	是	TimeIntervalDTO object	时间区间。

**表12** TimeIntervalDTO
参数	是否必选	参数类型	描述
startTime	是	String	开始时间，需要与endTime配合生效。
endTime	是	String	结束时间，需要与startTime配合生效。

**表13** DatabaseDTO
参数	是否必选	参数类型	描述
column	是	String	列过滤策略。
rows	是	Array of RowDTO objects	行过滤策略。

**表14** RowDTO
参数	是否必选	参数类型	描述
column_name	否	String	参数名称，需要与condition、value配合生效。
condition	否	String	参数条件，需要与conlumn_name、value配合生效。
value	否	String	参数条件值，需要与column_name、condition配合生效。

**表15** FileAsset
参数	是否必选	参数类型	描述
data_resource_id	是	String	数据资源id。
file_path	否	String	文件路径。
artifact_ids	是	Array of strings	资源下的文件id集合。
mask_sensitive	否	Array of ConnDataAttributeRangeVO objects	结构化文件的脱敏规则。

**表16** ConnDataAttributeRangeVO
参数	是否必选	参数类型	描述
uid	否	String	主键。
data_resource_id	否	String	数据资源ID。
data_artifact_id	否	String	数据资产ID。
data_contract_id	否	String	数据合约ID。
data_offer_id	否	String	数据offerID。
attribute_code	否	String	属性编码。
reserve_head_len	否	Integer	字段脱敏-首端保留长度。最小值：0 最大值：5000
reserve_tail_len	否	Integer	字段脱敏-尾端保留长度。最小值：0 最大值：5000
replace_character	否	String	字段脱敏-敏感信息替换字符。

响应参数

状态码： 200

**表17** 响应Body参数
参数	参数类型	描述
data	String	返回"success"。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 400

**表18** 响应Body参数
参数	参数类型	描述
data	-	返回null。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

状态码： 500

**表19** 响应Body参数
参数	参数类型	描述
data	-	返回null。
total	Long	总数。
error_code	String	错误码。
error_msg	String	错误描述。

请求示例

点对点发送合约

POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/point-to-point

{
  "contract_description" : "合约描述",
  "approver_id" : "******",
  "contract_name" : "点对点发送合约",
  "file_assets" : [ {
    "artifact_ids" : [ "f21e5c1e-ec9b******" ],
    "data_resource_id" : "7da43bc2-c301******"
  } ],
  "connector_policies" : [ {
    "connector_id" : "2747e1be-dba2*****",
    "policy_json" : {
      "view" : {
        "enable" : true,
        "times" : 100,
        "app" : "321ac118-758e******"
      },
      "modify" : {
        "enable" : false,
        "times" : "",
        "app" : ""
      },
      "download" : {
        "enable" : true,
        "times" : 100,
        "app" : "234c118-758e******"
      },
      "approval" : {
        "enable" : false
      },
      "terminate" : {
        "enable" : true
      },
      "use" : {
        "users" : "******",
        "teams" : "",
        "timeInterval" : {
          "startTime" : "2023-12-11T16:25:27Z",
          "endTime" : "2024-01-10T16:25:27Z"
        }
      },
      "database" : {
        "column" : "",
        "rows" : [ ]
      }
    }
  } ]
}

响应示例

状态码： 200

用户操作结果。

{
    "data": {
        "headers": {},
        "body": {
            "data": "success",
            "total": 0,
            "error_code": null,
            "error_msg": null
        },
        "statusCode": "OK",
        "statusCodeValue": 200
    },
    "total": 0,
    "error_code": null,
    "error_msg": null
}

状态码

状态码	描述
200	OK
400	Bad Request
500	Internal Server Error

错误码

请参见错误码。

父主题： 合约管理

上一篇：查询合约详情

下一篇：提交合约

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

点对点生成合约

功能介绍

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

相关文档

相关产品

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线