华为云用户手册

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token，通过调用 IAM 服务“获取用户Token”接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 request_id 是 String 订阅请求id。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。 approval_reason 否 String 审批理由。 参数校验规则：最小长度1，最大长度200，以字母数字中文开头，只含有字母数字汉字下划线和符号-。 approval_result 是 Boolean 审批是否通过。 contract_name 是 String 生成合约名称。 can_terminate 否 Boolean 是否允许提供方提前终止合约。

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用他们进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，用户可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，用户需要用到账号、用户和密码信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，具有逻辑隔离能力。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 使用Token前请确保Token离过期有足够的时间，防止调用API的过程中Token过期导致调用API失败。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为获取到的Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333 。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 data ConnectorDetail object 连接器详情。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表4 ConnectorDetail 参数 参数类型 描述 connector_id String 连接器ID。 connector_name String 连接器名称。 connector_description String 连接器描述。 create_time String 连接器创建时间。 connector_status String 连接器当前状态。 枚举值： ACTIVE INACTIVE create_user_name String 连接器创建人名称。 create_user_id String 连接器创建人ID。 connector_owner_name String 连接器管理员名称。 connector_owner_Id String 连接器管理员ID。 protocol_signed Boolean 签署ids协议标识。 状态码： 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} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。

响应示例 状态码： 200 OK 连接器详情。 { "data" : { "connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "connector_name" : "连接器B", "connector_description" : "测试连接器", "create_time" : "2023-10-09T11:15:48Z", "connector_status" : "ACTIVE", "create_user_name" : "pa*******135", "create_user_id" : "0574************", "connector_owner_name" : "pa*******135", "connector_owner_Id" : "0574************", "protocol_signed" : true }, "total" : 0, "error_code" : null, "error_msg" : null}

响应参数 状态码： 200 表16 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 400 表17 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表18 响应Body参数 参数 参数类型 描述 data Object 返回数据。 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" : "9999900******", "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" : "2******", "teams" : "", "timeInterval" : { "startTime" : "2023-12-11T16:25:27Z", "endTime" : "2024-01-10T16:25:27Z" } }, "database" : { "column" : "", "rows" : [ ] } } } ]}

响应示例 状态码： 200 OK 用户操作结果。 { "data" : { "headers" : { }, "body" : { "data" : "success", "total" : 0, "error_code" : null, "error_msg" : null }, "statusCodeValue" : 200, "statusCode" : "OK" }, "total" : 0, "error_code" : null, "error_msg" : null}

请求参数 表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 ConnectorPolicyRequest objects 每个连接器对应的策略信息。 approver_id 是 String 点对点审批人。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。 file_assets 是 Array of FileAssetRequest objects 多资产id。 表4 ConnectorPolicyRequest 参数 是否必选 参数类型 描述 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配合生效。使用UTC时间格式。 endTime 是 String 结束时间，需要与startTime配合生效。使用UTC时间格式。 表13 DatabaseDTO 参数 是否必选 参数类型 描述 column 是 String 列过滤策略。 rows 是 Array of RowDTO objects 行过滤策略。 表14 RowDTO 参数 是否必选 参数类型 描述 column_name 否 String 参数名称，需要与condition、value配合生效。 condition 否 String 参数条件，需要与column_name、value配合生效。 value 否 String 参数条件值，需要与column_name、condition配合生效。 表15 FileAssetRequest 参数 是否必选 参数类型 描述 data_resource_id 是 String 数据资源ID。 file_path 否 String 文件路径。 artifact_ids 是 Array of strings 资源下的文件ID集合。

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

调用API获取项目ID 项目ID还用通过调用查询指定条件下的项目信息API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "cn-north-4", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme：表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint：指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点中获取。例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path：资源路径，也即API访问路径。从具体API的URI模块获取，例如“管理员创建IAM用户”接口的resource-path为“/v3.0/OS-USER/users”。 query-string：查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要创建IAM用户，由于IAM为全局服务，则使用任一区域的Endpoint（比如“华北-北京四”区域的Endpoint：“iam.cn-north-4.myhuaweicloud.com”），并在管理员创建IAM用户的URI部分找到resource-path（/v3.0/OS-USER/users），拼接起来如下所示。 https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于管理员创建IAM用户接口，您可以从接口的请求部分看到所需的请求参数及参数说明，将消息体加入后的请求如下所示，其中加粗的字段需要根据实际值填写。 accountid为IAM用户所属的账号ID。 username为要创建的IAM用户名。 email为IAM用户的邮箱。 **********为IAM用户的登录密码。 POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/usersContent-Type: application/json X-Sdk-Date: 20240416T095341Z Authorization: SDK-HMAC-SHA256 Access=****************, SignedHeaders=content-type;host;x-sdk-date, Signature=**************** { "user": { "domain_id": "accountid", "name": "username", "password": "**********", "email": "email", "description": "IAM User Description" } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 Authorization：签名认证信息，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 X-Sdk-Date：请求发送的时间，可选，当使用AK/SK方式认证时，使用SDK对请求进行签名的过程中会自动填充该字段。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。如果云服务资源创建在子项目中，AK/SK认证方式下，操作该资源的接口调用需要在请求消息头中携带X-Project-ID。 X-Domain-ID：账号ID，可选。AK/SK认证方式下，全局服务的接口调用时，需在请求消息头中携带X-Domain-ID。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在管理员创建IAM用户的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-4.myhuaweicloud.com/v3.0/OS-USER/users

响应示例 状态码： 200 OK 应用模板列表。 { "data" : [ { "id" : "234ac118-d58e-4324-9d41-************", "name" : "PDF_JS", "description" : "用于预览PDF文件，仅供测试", "type" : "PDF_JS", "self" : null, "natives" : true, "operation" : [ "VIEW" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" }, { "id" : "234c118-758e-4324-9d41-************", "name" : "本地下载", "description" : "用于将文件下载到本地", "type" : "LOCAL_DOWN", "self" : null, "natives" : true, "operation" : [ "DOWNLOAD" ], "status" : "NORMAL", "icon" : "icon: data:image/png;base64,iVBORw0KGgoAAAAN*** // ***代表省略的图标编码", "create_time" : "2023-05-23T21:37:02Z" } ], "total" : 2, "error_code" : null, "error_msg" : null}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of ApplicationTemplate objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ApplicationTemplate 参数 参数类型 描述 id String 应用模板ID。 name String 应用模板名称。 description String 应用模板描述。 type String 应用模板类型： STRUCTURED：支持jdbc、csv下载 TRUSTED_ENV：支持可信环境下载 LOCAL_DOWN：支持本地下载 LUCKY_EXCEL：支持excel本地预览 UNSTRUCTURED：支持obs、sftp、ftp下载 PDF_JS：支持pdf本地预览 STRUCTURED_VIEW：支持csv jdbc本地预览 WPS：wps应用 IMAGE_VIEWER：本地图片查看 枚举值： STRUCTURED TRUSTED_ENV LOCAL_DOWN LUCKY_EXCEL UNSTRUCTURED PDF_JS STRUCTURED_VIEW WPS IMAGE_VIEWER DATA_TABLE_PRO CES SING self Boolean 资源是否是自己的。 natives Boolean 是否内置应用 true：内置 false：自创 operation Array of strings 限制使用的操作。 枚举值： VIEW PROCESS DOWNLOAD status String 状态： NORMAL：正常使用状态 DISABLE：停用状态，不再分配给新的eds实例 枚举值： NORMAL DISABLE icon String 应用图标。 create_time String 创建时间。 状态码： 400 表6 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/applications/templates 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

响应示例 状态码： 200 OK Offer列表 { "data" : [ { "offer_id" : "29146bc7-c5ab-4369-8611-************", "offer_name" : "offer20231121AC-EXCEL", "offer_type" : 2, "need_approval" : null, "can_terminate" : null, "ownered_company_name" : null, "ownered_company_id" : null, "ownered_connector_name" : "连接器A", "ownered_connector_id" : "b40b0d94-3201-4687-93aa-************", "offer_creator_name" : null, "offer_creator_id" : null, "offer_description" : "", "offer_followed_info" : { "offer_subscription" : true, "offer_favorite" : true, "offer_subscription_num" : 2, "offer_favorite_num" : 0, "offer_view_num" : 1 }, "mask_sensitive" : null, "use_control_policies_template" : null } ]}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of OfferSummary objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 OfferSummary 参数 参数类型 描述 offer_id String Offer ID。 offer_name String Offer名称。 offer_type Integer Offer公开范围：公开-1、受控-2。 need_approval Boolean 是否需要审批。 注：开启【需要审批】后，下载合约资源的加工产物时需要审批。 can_terminate Boolean 是否允许提供方删除数据。 ownered_company_name String Offer所属的企业，即所属租户名。 ownered_company_id String Offer所属的企业ID，即所属租户ID。 ownered_connector_name String Offer所属的连接器，即所属连接器名。 ownered_connector_id String Offer所属的连接器ID，即所属连接器id。 offer_creator_name String Offer创建者名称。 offer_creator_id String Offer创建者ID。 offer_description String Offer描述。 subscription_type String 订阅类型： OPEN_DATA：公开数据 CONTROLLED_DATA：受控数据 offer_followed_info OfferFollowed object Offer引用信息。 mask_sensitive Array of MaskSensitive objects 结构化数据列脱敏信息。 use_control_policies_template Array of UseControlPoliciesInner objects 合约使用控制策略列表。 表6 OfferFollowed 参数 参数类型 描述 offer_subscription Boolean Offer订阅状态。 offer_favorite Boolean Offer收藏状态。 offer_subscription_num Integer Offer订阅次数。 offer_favorite_num Integer Offer收藏次数。 offer_view_num Integer Offer查看次数。 表7 MaskSensitive 参数 参数类型 描述 attribute_code String 属性code。 reserve_head_len Integer 首端保留长度。 最大值：5000 reserve_tail_len Integer 尾端保留长度。 最大值：5000 表8 UseControlPoliciesInner 参数 参数类型 描述 action String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD when TimeInterval object 限制使用时间。 how_many Integer 限制使用次数。 参数校验规则：最小值1，最大值10000。 where Where object 限制地点列表。 who Array of strings 限制用户/团队列表。（目前不支持多个用户或者团队） user_type String 限制用户类型。（团队订阅时who和user_type必填） USER ：指定用户 TEAM ：指定团队 枚举值： USER TEAM application Array of strings 限制应用列表。 additional_attributes DatabaseAttributes object 策略的扩展属性。 表9 TimeInterval 参数 参数类型 描述 start_time String 起始时间，UTC时间格式。 end_time String 截止时间，UTC时间格式。 表10 Where 参数 参数类型 描述 device_ip Array of strings 限定访问IP。 device_mac Array of strings 限定访问设备MAC。 表11 DatabaseAttributes 参数 参数类型 描述 column String 可见列。 rows Array of RowDTO objects 可见行。 表12 RowDTO 参数 参数类型 描述 column_name String 参数名称，需要与condition、value配合生效。 condition String 参数条件，需要与column_name、value配合生效。 value String 参数条件值，需要与column_name、condition配合生效。 状态码： 400 表13 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表14 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/broker/offers 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 key_words 否 String 搜索的关键字，如果是多个关键字，通过空格分开，默认为全量搜索。 ownered_company_name 否 String 限定租户名，即限定企业。 ownered_connector_name 否 String 限定连接器名。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量200，超过200后只返回200（防止单页返回过大）。 最小值：1 最大值：200 缺省值：10

EDS权限分类 表1 细化权限说明 权限 对应API接口 授权项 依赖的授权项 IAM项目 企业项目 查询指定空间实例下所有连接器 - eds:connector:list - √ × 申请开通连接器 - eds:connector:apply - √ × 创建实例 - eds:instance:create - √ × 删除连接器 - eds:connector:delete - √ × 申请加入连接器 - eds:connector:join - √ × 创建连接器 - eds:connector:create - √ × 删除空间实例 - eds:instance:delete - √ × 申请加入实例 - eds:instance:join - √ × 父主题： 权限和授权项

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 data Array of ArtifactUsage objects 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 表5 ArtifactUsage 参数 参数类型 描述 artifact_id String 资产ID。 artifact_name String 资产名称。 consumer_user_name String 消费连接器用户名称。 consumer_connector_id String 消费连接器ID。 consumer_connector_name String 消费连接器名称。 action_count_list Array of ActionCount objects 使用次数。 表6 ActionCount 参数 参数类型 描述 action String 限制使用的操作： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD count Integer 使用次数。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 data Object 返回数据。 total Long 总数。 error_code String 错误码。 error_msg String 错误描述。

响应示例 状态码： 200 OK 资产使用情况列表。 { "data" : [ { "artifact_id" : "66f6bb97-c70a-43d9-aa73-************", "artifact_name" : "customers", "consumer_user_name" : "paas_roma_l00489135", "consumer_connector_id" : "c1bf9bd7-52fc-435b-ae55-************", "consumer_connector_name" : "连接器B", "action_count_list" : [ { "action" : "MODIFY", "count" : 1 }, { "action" : "DOWNLOAD", "count" : 1 }, { "action" : "VIEW", "count" : 2 } ] } ]}

请求示例 查询数据资产统计列表。 GET https://{endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages?artifact_id=66f6bb97-c70a-43d9-aa73-************&offset=0&limit=100

URI GET /v1/{project_id}/eds/instances/{instance_id}/connectors/{connector_id}/audit-logs/artifact-usages 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。 获取方法请参考获取项目ID。 instance_id 是 String 实例ID，开通的交换数据平台实例ID。 获取方法请参考获取实例ID。 connector_id 是 String 连接器ID，指定交换数据平台下连接器的ID。 获取方法请参考获取连接器ID。 表2 Query参数 参数 是否必选 参数类型 描述 artifact_id 否 String 资产ID。 参数校验规则：最小长度1，最大长度50，匹配字母、数字和符号-。 artifact_name 否 String 资产名称。 参数校验规则：只能包含英文字母、数字、下划线、中文及-，并且只能以中文和英文开头，最小长度1，最大长度200。 action 否 String 执行动作过滤： VIEW：查看 MODIFY：加工 DOWNLOAD：下载 枚举值： VIEW MODIFY DOWNLOAD start_time 否 String 开始时间。 end_time 否 String 结束时间。 offset 否 Integer 偏移量，表示从此偏移量开始查询，offset大于等于0。 最小值：0 最大值：999999 缺省值：0 limit 否 Integer 每页显示条目数量，最大数量999，超过999后只返回999（防止单页返回过大）。 最小值：1 最大值：999 缺省值：10

入门流程 首次使用 云存储 网关服务，建议参考表1逐步操作，创建云上云下数据同步管理的云存储网关。 表1 CS G使用流程简介 操作步骤 操作说明 准备工作 注册华为云，并准备符合要求的本地待部署客户端环境，用于部署网关。 创建网关 在CSG管理控制台新建网关，下载网关安装包。 安装网关 在用户本地客户端安装网关，并获取能连接到浏览器的网关IP。 初始化网关 在CSG管理控制台和用户本地客户端，通过网关IP和访问密钥（AK/SK）连接激活网关，建立CSG管理控制台与用户本地网关的连接。网关激活成功后，在管理控制台设置缓存盘。 创建文件共享 在CSG管理控制台，创建以OBS桶目录为共享源的文件共享，并配置共享权限。 挂载文件共享 在用户本地客户端挂载NFS文件共享。挂载成功后，用户则可将本地操作数据同步上云，无缝管理云上云下数据。

操作步骤 以“CSG-gateway_3.19.11.tar.gz”版本安装包为例，说明网关软件安装步骤。 使用PuTTY/FTP等工具登录待部署服务器，以root用户登录待部署服务器，使用SFTP工具将网关软件包和对应的SHA256文件上传到待部署服务器。进入存放“CSG-gateway_3.19.11.tar.gz”的目录，执行以下命令，查看已成功下载的安装包。 ls -ltr 回显信息如下： [root@localhost csg]# ls -ltrtotal 182692-rw-------. 1 root root 99 Apr 26 22:25 CSG-gateway_3.19.11.tar.gz.sha256-rw-------. 1 root root 187071260 Apr 26 22:25 CSG-gateway_3.19.11.tar.gz 执行如下命令校验网关软件包完整性，当回显信息显示OK，表明完整性校验成功。 sha256sum -c CSG-gateway_x.x.x.tar.gz.sha256 回显信息如下： [root@localhost csg]# sha256sum -c CSG-gateway_3.19.11.tar.gz.sha256CSG-gateway_3.19.11.tar.gz: OK 执行以下命令，解压安装包。 tar -zxvf CSG-gateway_x.x.x.tar.gz 回显信息如下： # tar -zxvf CSG-gateway_3.19.11.tar.gzCSG-gateway_3.19.11/CSG-gateway_3.19.11/vars/CSG-gateway_3.19.11/vars/main.ymlCSG-gateway_3.19.11/action/CSG-gateway_3.19.11/action/env.shCSG-gateway_3.19.11/action/uninstall.shCSG-gateway_3.19.11/action/install_all.shCSG-gateway_3.19.11/action/install_rpm.shCSG-gateway_3.19.11/action/stop_all.shCSG-gateway_3.19.11/action/start_all.shCSG-gateway_3.19.11/config/CSG-gateway_3.19.11/manifest.ymlCSG-gateway_3.19.11/repo/CSG-gateway_3.19.11/repo/filegateway-om-1.0.3.20190411175311-1.x86_64.rpmCSG-gateway_3.19.11/repo/filegateway-1.0.3.20190411175311-1.x86_64.rpmYou have mail in /var/spool/mail/root 执行以下命令，查看解压后的安装包。 ls –ltr 回显信息如下： # ls -ltrtotal 191076drwxr-xr-x. 6 root root 78 Apr 11 17:56 CSG-gateway_3.19.11- rw- r--r--. 1 root root 195658900 Apr 11 18:05 CSG-gateway_3.19.11.tar.gzYou have mail in /var/spool/mail/root 进入解压后安装包action文件目录，执行以下命令安装网关所必须的rpm软件包。 sh install_rpm.sh 安装日志回显如下信息，则网关安装成功： # sh install_rpm.sh Install all rpms finished. 如果网关服务器是ECS，安装rpm软件包长时间卡住或者执行失败，建议暂时绑定弹性公网IP，重新执行sh install_rpm.sh命令，完成rpm软件包安装后解绑弹性公网IP即可。 执行以下命令安装网关。 sh appctl.sh install 安装日志回显如下信息，则网关安装成功。 install filegateway success （可选）为了系统安全进行软件安全加固。 执行以下脚本命令，限制root用户使用ssh登录网关服务器。同时选择本地服务器对应IP地址，绑定到系统服务端口。 sh security_reinforce.sh 回显信息如下： [root@gateway ~]# sh {安装包目录}/action/security_reinforce.sh[root@dfv action]# sh security_reinforce.sh-create a new user csgmanager for login startuseradd: warning: the home directory already exists.Not copying any file from skel directory into it.Creating mailbox file: File existsChanging password for user csgmanager.New password:Retype new password:passwd: all authentication tokens updated successfully.-create a new user csgmanager for login end-prohibits the root from logging in through ssh start-prohibits the root from logging in through ssh end-bind IP address startplease specify a local IPv4 address as the manager IP(used by SSH service)option [0] : 111.111.111.111/19option [1] : 222.222.222.222/19select an existing option:0please specify a local IPv4 address as the service IP(used by NFS service)option [0] : 111.111.111.111/19option [1] : 222.222.222.222/19select an existing option:1[warning] you have chosen 111.111.111.111/19 as manager IP , 222.222.222.222/19 as service IP[warning] if bind the wrong IP address may cause the service to be abnormal[warning] enter "yes" to continue, enter others to reselect:yesprocessing...Files are successfully uploaded to the cloud. Time elapsed: 0 minWaiting for the gateway to stop...Command executed successfully.Main gateway process starting.......successfully.Monitoring process starting...successfully.Cache disk activating...successfully.config tomcat server ip 111.111.111.111.bind ntp server ip 111.111.111.111.-bind IP address endexecute end 执行了安全加固命令后，无法使用root账号通过ssh登录服务器。需先使用csgmanager账号通过ssh登录服务器，然后执行“su root”，通过密码认证切换到root用户。 为了系统的安全，建议定期修改csgmanager和root的密码。 在action文件目录下，执行如下命令，启动OM进程，开始使用网关。 sh appctl.sh start OM进程回显如下信息，则网关正常运行。 start filegateway successfully

操作步骤 表1 验证项 检查项 操作步骤 新增文件能够同步到OBS中 1、登录挂载NFS文件共享的主机，使用cp命令拷贝测试文件到挂载NFS文件共享的目录。 2、等待5分钟后，登录华为云 对象存储服务 控制台，检查新增文件是否同步到NFS文件共享关联的OBS桶中。 修改文件的内容能够同步到OBS中 1、登录挂载NFS文件共享的主机，使用vim等命令修改测试文件，并保存退出。 2、等待5分钟后，登录华为云对象存储服务控制台，下载测试文件，检查OBS桶中的对应文件是否更新。 删除文件能够同步删除OBS中对应的文件 1、登录挂载NFS文件共享的主机，使用rm命令删除测试文件。 2、等待5分钟后，登录华为云对象存储服务控制台，检查OBS桶中对应文件是否删除。 网关监控数据正常 登录华为云云存储网关控制台，在网关列表，单击名称链接进入网关详情，单击缓存空间使用率右上角的更多监控，查看当前网关的“带宽”、“IOPS”、“内存利用率”等指标是否有监控数据。 数据上云期间，会占用部分带宽用以数据上传。如果您当前使用的华为云专线网络，且该专线同时被用于其他业务，为了不影响该专线上其他业务正常运行，建议您在评估后为云部署网关设置合理的限流带宽。 设置限流带宽流程： (1) 进入CSG控制台网关列表; (2) 单击要设置限流带宽的网关名称； (3) 单击“更多”，单击“编辑”； (4) 设置“限流带宽”值，单位为MB/s，默认值为0不限流； (5) 单击“确认”；稍等一分钟左右即可生效；