华为云用户手册

响应参数 状态码： 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 错误描述。

请求参数 表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 字段脱敏-敏感信息替换字符。

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。

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EDS.00031001 Invalid parameter 无效的参数。 检查参数是否正确。 400 EDS.00031002 User does not have permission 用户无权限。 检查用户是否有操作API或者资源的权限。 400 EDS.00031601 The eds instance does not exist 实例不存在。 检查实例ID是否正确。 400 EDS.00031603 User does not join eds instance 用户未加入实例。 确认用户是否加入实例。 400 EDS.00032201 Get iam users failed 获取IAM用户失败。 联系客服寻求帮助。 400 EDS.00032202 User does not owner of the connector 用户不是连接器所有者。 检查用户是否有操作API或者资源的权限。 400 EDS.00032203 Query user failed 查询用户信息失败。 联系客服寻求帮助。 403 EDS.00012301 Domain does not allow to access OpenAPI 租户不允许访问OpenAPI。 联系客服申请访问OpenAPI。 403 EDS.00031602 Instance does not belong domain 实例不属于租户。 检查用户所属租户是否是实例所属者。 400 EDS.00031013 Offer number exceeds upper limit 选中的Offer数量超出限制。 检查选中的Offer数量是否 超出限制。 400 EDS.00031014 Invalid parameter : project_id 项目ID与Token不匹配。 检查项目ID是否正确。 400 EDS.00031015 Invalid parameter : instance_id 无效的实例ID。 检查实例id是否正确。 400 EDS.00031016 Invalid instance id and connector id pair 无效的实例、连接器ID组合。 检查实例和连接器ID是否有所属关系。 400 EDS.00031017 Method parameter type does not match 参数类型不匹配。 检查参数类型是否匹配。 400 EDS.00031018 convert time format error 转换时间格式错误。 联系客服寻求帮助。 400 EDS.00031020 Invalid tenant_id 无效的租户ID。 检查租户ID是否正确。 父主题： 附录

响应示例 状态码： 200 OK 提交合约返回结构体。 { "data" : { "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "contract_name" : "测试合约3", "result_code" : "SUCCESS", "result_description" : "success" }, "total" : 0, "error_code" : null, "error_msg" : null }

响应参数 状态码： 200 表8 响应Body参数 参数 参数类型 描述 data ContractResult object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表9 ContractResult 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 result_code String 操作结果返回码： SUCCESS：操作成功 FAILED：操作失败 枚举值： SUCCESS FAILED result_description String 操作结果描述。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

请求示例 提交合约。 POST https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts { "contract_name" : "测试合约3", "approver_id" : "************", "offer_id" : "fbf85846-3782-46dc-affb-************", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscriber_id" : "************", "need_approval" : false, "can_terminate" : true, "use_control_policies" : [ { "action" : "VIEW", "when" : { "start_time" : "2023-11-16T18:18:14Z", "end_time" : "2023-12-16T18:18:14Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "user_type" : null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : "id", "condition" : "!=", "value" : "1" } ] } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-11-16T18:18:14Z", "end_time" : "2023-12-16T18:18:14Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "user_type" : null, "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { "column": null, "rows": null } }, { "action" : "MODIFY", "when" : { "start_time" : "2023-11-16T18:18:14Z", "end_time" : "2023-12-16T18:18:14Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "user_type" : null, "application" : [ "dae4237f-9880-4fb9-a618-************" ], "additional_attributes" : { "column": null, "rows": null } } ], "contract_description" : "OpenApi demo." }

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts 表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 合约名称。 contract_description 否 String 合约描述。 owner_connector_id 是 String 提供者连接器ID。 subscribe_connector_id 是 String 订阅连接器ID。 subscriber_id 是 String 订阅人ID。 approver_id 是 String 审批人ID。 offer_id 是 String Offer ID。 need_approval 是 Boolean 是否需要审批。 注：开启【需要审批】后，下载合约资源的加工产物时需要审批。 can_terminate 是 Boolean 是否允许提供方删除数据。 use_control_policies 是 Array of UseControlPoliciesInner objects 合约使用控制策略列表。 表4 UseControlPoliciesInner 参数 是否必选 参数类型 描述 action 是 String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD when 是 TimeInterval object 限制使用时间。 how_many 否 Integer 限制使用次数。 where 否 Array of strings 限制地点列表。 who 是 Array of strings 限制用户列表。 application 是 Array of strings 限制应用列表。 additional_attributes 否 DatabaseAttributes object 策略的扩展属性。 user_type 是 String 限制用户类型。 USER ：指定用户 TEAM ：指定团队 枚举值： USER TEAM 表5 TimeInterval 参数 参数类型 描述 start_time String 起始时间。 end_time String 截止时间。 表6 DatabaseAttributes 参数 参数类型 描述 column String 可见行。 rows Arrays of RowDTO 可见列。 表7 RowDTO 参数 参数类型 描述 column_name String 参数名称。 condition String 参数条件。 value String 参数条件值。

响应参数 状态码： 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" }

请求参数 表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。

响应示例 状态码： 200 OK 合约详情。 { "data" : { "contract_id" : "AGRTconnector-****3b53a05caccd4c53b509************", "contract_name" : "测试合约3", "contract_description" : "OpenApi demo.", "owner_connector_id" : "b40b0d94-3201-4687-93aa-************", "owner_connector_name" : "连接器A", "subscribe_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "subscribe_connector_name" : "连接器B", "subscriber_name" : "************", "subscriber_id" : "************", "approver_id" : "************", "approver_name" : "************", "offer_id" : "fbf85846-3782-46dc-affb-************", "offer_name" : "offer-mysql-20231129AA", "transactional_mode" : "SUBSCRIBE", "status" : "SUCCESS", "create_time" : "2023-12-05T20:24:37Z", "need_approval" : false, "can_terminate" : true, "use_control_policies" : [ { "action" : "VIEW", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "user_type": null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : null, "condition" : "!=", "value" : "1" } ] } }, { "action" : "MODIFY", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "user_type": null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : null, "condition" : "!=", "value" : "1" } ] } }, { "action" : "DOWNLOAD", "when" : { "start_time" : "2023-12-05T20:24:37Z", "end_time" : "2023-12-25T20:24:37Z" }, "how_many" : null, "where" : [ ], "who" : [ "************" ], "user_type": null, "application" : [ "321ac118-758e-4324-9d41-************" ], "additional_attributes" : { "column" : "id,category", "rows" : [ { "column_name" : null, "condition" : "!=", "value" : "1" } ] } } ], "artifacts" : [ { "data_resource_id" : "25546208-0854-49a0-9023-************", "artifact_id" : "303b4f5f-596e-41c9-ad50-************", "artifact_code" : null, "artifact_title" : "animals", "byte_size" : 16384, "media_type" : "jdbc" } ] }, "total" : 0, "error_code" : null, "error_msg" : null }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data ContractDetail object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ContractDetail 参数 参数类型 描述 contract_id String 合约ID。 contract_name String 合约名称。 contract_description String 合约描述。 owner_connector_id String 提供者连接器ID。 owner_connector_name String 提供者连接器名称。 subscribe_connector_id String 订阅连接器ID。 subscribe_connector_name String 订阅连接器名称。 subscriber_name String 订阅人名称。 subscriber_id String 订阅人ID。 approver_id String 审批人ID。 approver_name String 审批人名称。 offer_id String Offer ID。 offer_name String offer名称。 transactional_mode String 交换模式： PEER_TO_PEER： 点对点 SUBSCRIBE：订阅 枚举值： PEER_TO_PEER SUBSCRIBE status String 合约状态： APPROVING： 审批中 RUNNING：数据传输中 SUCCESS：成功 FAILED：失败 TERMINATED：已终止 REJECTED：审批驳回 枚举值： APPROVING RUNNING SUCCESS FAILED TERMINATED REJECTED create_time String 创建时间。 need_approval Boolean 是否需要审批。 注：开启【需要审批】后，下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 use_control_policies Array of UseControlPoliciesInner objects 合约使用控制策略列表。 artifacts Array of Artifact objects 合约资产列表。 表5 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 where Array of strings 限制地点列表。 who Array of strings 限制用户列表。 application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 user_type String 限制用户类型。 USER ：指定用户 TEAM ：指定团队 枚举值： USER TEAM 表6 Artifact 参数 参数类型 描述 data_resource_id String 所属资源ID。 artifact_id String 资产ID。 artifact_code String 资产编码。 artifact_title String 文件名称。 byte_size Long 文件大小。 media_type String 资产格式类型。 表7 TimeInterval 参数 参数类型 描述 start_time String 起始时间。 end_time String 截止时间。 表8 DatabaseAttributes 参数 参数类型 描述 column String 可见行。 rows Arrays of RowDTO 可见列。 表9 RowDTO 参数 参数类型 描述 column_name String 参数名称。 condition String 参数条件。 value String 参数条件值。 状态码： 400 表10 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表11 响应Body参数 参数 参数类型 描述 data - 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/contracts/{contract_id} 表1 路径参数 参数 是否必选 参数类型 描述 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 contract_id 是 String 合约ID。 参数校验规则：最小长度1，最大长度50，匹配字母数字和符号-。 project_id 是 String 项目ID。 获取方法请参考获取项目ID。

URI DELETE /v1/{project_id}/eds/instances/{instance_id}/domains/{domain_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 domain_id 是 String 租户ID。 获取方法请参考查询用户实例列表。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 data Object 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 data Object 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ConnUserProtocol 参数 参数类型 描述 declaration_id String 协议ID。 最小长度：8 最大长度：50 content String 协议内容。 最小长度：0 最大长度：2048 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/user-protocol 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/user-protocol 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Boolean 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表5 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI POST /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/retrieve 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data String 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 data Object 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 data Object 返回null。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications/{app_id}/resources/modifyed 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的数据交换平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定数据交换平台下连接器的ID。 获取方法请参考获取连接器ID。 app_id 是 String 应用实例ID，指定交换数据平台下连接器注册的应用实例ID。 获取方法： 进入交换数据空间控制台界面，单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。 单击实例下的连接器，选择界面左侧导航栏中的“应用实例”。 在“应用实例”页面，已注册的应用实例下的“应用ID”即为应用实例ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999。 最小值：1 最大值：999 缺省值：10 artifact_id 是 String 交换资源ID，格式例如：02256dbc-95d4-4946-b583-aa53dd5436eb。 最大长度：50 获取方法： 进入交换数据空间控制台界面，单击“我的空间”，在交换数据空间实例中，选择实例，单击实例卡片上的“连接器”。 单击实例下的连接器，选择界面左侧导航栏中的“数据目录” 单击数据目录下的资源文件，在“全部数据”页签的“数据编码”即为交换资源ID。

请求示例 查询应用中用户绑定的资源列表。 GET https://eds.cn-north-7.myhuaweicloud.com/v1/09b897adea00d2a62f1fc01ab6b8b31c/eds/instances/afa45227-4baf-4a34-83a6-8de2f8ce1b9c/connectors/91cdf154-834d-4576-81ce-92de54408efc/applications/5831ac99-f313-43de-ae7e-a2abed19fddf/resources/modifyed?offset=0&limit=10&artifact_id=d238090d-facf-4042-b732-a4cec4f9a4fe

响应示例 状态码： 200 OK 应用中用户绑定的资源列表。 { "data": [ { "app_id": "5831ac99-f313-43de-ae7e-a2abed19fddf", "template_id": null, "owner_id": "999990000001035", "physical_name": "mysql_0321", "contract_id": "AGRTconnector-293789a96f42d510424fb6e213f350a4cfa0", "artifact_id": "d238090d-facf-4042-b732-a4cec4f9a4fe", "action": "MODIFY", "additional_attributes": { "task_id": "86f5ac21-5ea7-4470-b17c-7ba966946ee4" } } ], "total": 1, "error_code": null, "error_msg": null }

内核版本说明 本章节介绍文档数据库服务DDS的内核版本更新说明，补丁升级不会影响任何功能和接口。 表1 文档数据库服务DDS4.4版本说明 版本 日期 说明 4.4 2024年3月 修复了setWindowFields输出的字段缺失问题。 2024年2月 changeStream读取性能优化。 优化了过期oplog数据的清理性能。 修复了geoNear在执行explain()时的展示缺失问题。 2024年1月 修复了正则匹配时出现的概率性失效问题。 2023年12月 优化了单文档查性能。 限制reIndex危险命令的执行权限。 2023年11月 修复了内存监控功能，在命令执行后结果内容展示缺失的问题。 2023年10月 优化了ServerStatus命令获取锁的方式。 修复了节点选举时出现的概率性失效问题。 2023年9月 支持在多文档事务中创建索引和创建集合操作。 支持设置单个集合的autosplit属性。 修复了创建稀疏索引并用字段值null去查询时，与MongoDB官方4.4表现不一致的问题。 2023年8月 增加主动限制连接数能力。 兼容支持Parallel Change Stream特性。 修复了禁止读写时，在集群实例上仍可以执行聚合命令的问题。 优化了慢日志捕捉方式。 2023年7月 存储引擎压缩算法优化。 CreateIndex命令自动路由到主节点执行。 被动Compact同步逻辑优化。 2023年5月 serverStatus中的oplogTruncation项新增 totalTimeProcessingMicros、processingMethod、totalTimeTruncatingMicros、truncateCount统计。 2023年4月 优化了事务执行逻辑。 2023年3月 新增存储故障自动切换特性。 副本集支持defaultReadWriteConcern特性。 集群支持PITR特性。 2023年1月 tcmalloc内存管理策略优化。 支持分布式大事务。 2022年11月 新增compound hash index特性。 新增mutable shard key values特性。 兼容支持mirrored reads特性。 表2 文档数据库服务DDS4.2版本说明 版本 日期 说明 4.2 2024年3月 兼容支持startAfter特性。 2024年2月 changeStream读取性能优化。 优化了过期oplog数据的清理性能。 修复了geoNear在执行explain()时的展示缺失问题。 2024年1月 修复了正则匹配时出现的概率性失效问题。 2023年12月 优化了单文档查询性能。 限制reIndex危险命令的执行权限。 2023年11月 修复了内存监控功能，在命令执行后结果内容展示缺失的问题。 2023年10月 优化了ServerStatus命令获取锁的方式。 修复了节点选举时出现的概率性失效问题。 2023年9月 支持在多文档事务中创建索引和创建集合操作。 支持设置单个集合的autosplit属性。 2023年8月 增加主动限制连接数能力。 修复了有锁情况下部分会话概率性killPending的问题。 优化了慢日志捕捉方式。 2023年7月 存储引擎压缩算法优化。 CreateIndex命令自动路由到主节点执行。 被动Compact同步逻辑优化。 修复MongoDB开源社区问题SERVER-39044导致的系统session表概率性刷新失败。 2023年6月 优化副本集针对10KB文档执行update操作的性能。 修复SERVER-37408漏洞。 修复SERVER-39074漏洞。 2023年5月 修复主备倒换后writeConcern错误码匹配问题。 2023年4月 优化了事务执行逻辑。 修复了带参数执行dropIndexes()与MongoDB官方4.2表现不一致的问题。 修复了在emrc=true并且dirty Cache升高时，重启较慢的问题。 2023年3月 新增存储故障自动切换特性。 降低主备复制延迟。 集群支持PITR特性。 2023年1月 支持分布式大事务。 修复SERVER-42518漏洞。 修复SERVER-37686漏洞。 2022年11月 修复了MongoDB Compass通过SSL连接概率性出现失败的问题。 修复了find查询字段为null时，与MongoDB官方4.2表现不一致的问题。 2022年10月 新增索引一致性检查特性。 修复CVE-2020-7921漏洞。 2022年9月 创建索引调整为默认后台创建。 开放replSetGetConfig命令。 2022年6月 支持zstd压缩算法。 mongos支持releaseFreeMemory命令。 表3 文档数据库服务DDS4.0版本说明 版本 日期 说明 4.0 2024年3月 无。 2024年2月 修复了geoNear在执行explain()时的展示缺失问题。 2024年1月 修复了正则匹配时出现的概率性失效问题。 2023年12月 优化了单文档查询性能。 限制reIndex危险命令的执行权限。 2023年11月 无。 2023年10月 优化了ServerStatus命令获取锁的方式。 修复了节点选举时出现的概率性失效问题。 2023年9月 resizeOplog逻辑优化。 2023年8月 修复了禁止读写时，在集群实例上仍可以执行聚合命令的问题。 修复了有锁情况下部分会话概率性killPending的问题。 优化了慢日志捕捉方式。 2023年7月 CreateIndex命令自动路由到主节点执行。 被动Compact同步逻辑优化。 修复MongoDB开源社区问题SERVER-39044导致的系统session表概率性刷新失败。 修复Robot 3T登录集群实例，在默认设置readPreference为secondaryPreferred时，创建索引会提示NotMaster的问题。 2023年6月 提供不检查密码复杂度的开关参数enableCheckPassword。 优化索引删除步骤，提高索引删除效率。 2023年5月 修复SERVER-37408漏洞。 修复SERVER-39074漏洞。 2023年4月 修复了带参数执行dropIndexes()与MongoDB官方4.2表现不一致的问题。 修复了在emrc=true并且dirty Cache升高时，重启较慢的问题。 2023年3月 新增存储故障自动切换特性。 修复CVE-2018-20805漏洞。 2023年1月 修复SERVER-42518漏洞。 修复SERVER-37686漏洞。 2022年11月 修复了MongoDB Compass通过SSL连接概率性出现失败的问题。 2022年10月 新增索引一致性检查特性。 修复CVE-2020-7921漏洞。 2022年7月 创建索引调整为默认后台创建。 开放replSetGetConfig命令。 2022年6月 mongos支持releaseFreeMemory命令。 表4 文档数据库服务DDS3.4版本说明 版本 日期 说明 3.4 2024年3月 无。 2024年2月 无。 2024年1月 无。 2023年12月 限制reIndex危险命令的执行权限。 2023年11月 无。 2023年10月 优化了ServerStatus命令获取锁的方式 。 2023年9月 慢日志信息细化。 2023年8月 修复了禁止读写时，在集群实例上仍可以执行聚合命令的问题。 修复了有锁情况下部分会话概率性killPending的问题。 优化了慢日志捕捉方式。 2023年7月 ReleaseFreeMemory同步到3.4版本。 2023年5月 修复SERVER-37408漏洞。 修复SERVER-39074漏洞。 2023年4月 修复了集群中config备节点上activeSession更新不及时的问题。 2023年3月 新增存储故障自动切换特性。 修复CVE-2018-20805漏洞。 2023年1月 修复SERVER-42518漏洞。 修复SERVER-37686漏洞。 2022年10月 修复CVE-2020-7921漏洞。 修复heapprofile的值显式不正确的问题。 2022年7月 修复弱密码校验问题。 2022年6月 mongos日志信息脱敏。 父主题： 产品发布说明

方案架构 该解决方案部署架构图如下： 图1 方案架构图 该解决方案会部署如下资源： 创建三个弹性公网IP EIP，提供独立的公网IP资源，用于提供节点访问公网和被公网访问的能力。 创建十一台弹性云服务器ECS，其中包含三个TiDB节点用于数据计算，三个TiKV节点用于数据存储，一个TiFlash节点用于列式存储，一个中控节点用于集群部署与监控，中控节点绑定弹性公网IP；三个PD节点用于集群的协调，其中一个PD节点绑定弹性公网IP用于访问仪表盘，PD节点的弹性公网配置具体请参考3.3-开始使用 创建一个弹性负载均衡 ELB，并绑定弹性公网IP，用于访问TiDB数据库节点。

约束与限制 部署该解决方案之前，您需注册华为账号并开通华为云，完成实名认证，且账号不能处于欠费或冻结状态，如使用包周期部署确保余额充足。如果计费模式选择“包年包月”，请确保账户余额充足以便一键部署资源的时候可以自动支付；或者在一键部署的过程进入费用中心，找到“待支付订单”并手动完成支付。 请确保在部署解决方案前，使用的华为云账号有IAM的足够权限，具体请参考3.1-创建rf_admin_trust委托