华为云用户手册

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

调用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。

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

响应示例 状态码： 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}

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 - √ × 父主题： 权限和授权项

调用API获取连接器ID 连接器ID还可通过调用查询连接器列表API获取。 获取连接器ID的接口为GET https://{eds-endpoint}/v1/{project_id}/eds/instances/{instance_id}/connectors/user-connectors，响应体中data下的“connector_id”即为连接器ID。 eds-endpoint为EDS的终端节点，EDS部署在“华北-北京四”区域，Endpoint为“eds-combine.cn-north-4.myhuaweicloud.com”，“华南-广州-友好用户环境”区域，Endpoint为“eds-combine.cn-south-4.myhuaweicloud.com”。 project_id为项目ID，开通服务后可在控制台查询，查询方法请参考获取项目ID。 instance_id为实例ID，创建实例后可在控制台查询，查询方法请参考获取实例ID。

API概览 交换数据空间 服务接口的分类与说明如表1所示。 表1 API概览 类型 说明 offer管理 包括搜索offer列表、查询offer详情等接口。 订阅管理 包括订阅offer、我的订阅等接口。 合约管理 提供查询合约、终止合约等接口。 应用管理 提供新增应用、查询应用模板列表等接口。 审计日志 提供查询数据资产的审计日志列表、查询数据资产统计列表等接口。 实例管理 提供实例添加客租户、查询用户实例列表等接口。 连接器管理 提供查询连接器列表、查询用户连接器列表等接口。 团队管理 提供查询指定连接器下的团队列表的接口。 用户管理 提供添加连接器用户、从连接器移除用户等接口。

请求示例 查询数据资产统计列表。 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

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

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文件共享。挂载成功后，用户则可将本地操作数据同步上云，无缝管理云上云下数据。

操作步骤 表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) 单击“确认”；稍等一分钟左右即可生效；

操作步骤 以“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

操作步骤 以root用户登录本地服务器。 挂载前，查看本地服务器系统是否安装NFS客户端。 表1 查询和安装NFS客户端 操作系统 查询命令 回显信息（已安装） 安装命令 Red Hat、Fedora或Oracle Enterprise Linux、Euler OS 2.3 rpm -qa|grep nfs libnfsidmapnfs-utils sudo yum -y install nfs-utils SUSE或OpenSUSE rpm -qa|grep nfs nfsidmap nfs-client zypper install nfs-client Debian或Ubuntu dpkg -l nfs-common nfs-common sudo apt-get install nfs-common 不同操作系统回显信息不同，如果回显表1信息，说明已经成功安装NFS客户端，则执行步骤3；如果未回显表中信息，则需执行表中安装命令安装NFS客户端。 登录客户端执行如下命令，创建本地挂载路径。 mkdir /本地路径 执行如下命令，挂载文件共享。 mount -t nfs -o vers=3,timeo=600,nolock 网关IP:/共享名称 /本地路径 执行如下命令，查看文件共享挂载结果。 df –h 在/etc/rc.local中追加如下加粗部分，确保操作系统重启时，能够自动挂载文件共享。 #!/bin/bash# THIS FILE IS ADDED FOR COMPATIBILITY PURPOSES## It is highly advisable to create own systemd services or udev rules# to run scripts during boot instead of using this file.## In contrast to previous versions due to parallel execution during boot# this script will NOT be run after all other services.## Please note that you must run 'chmod +x /etc/rc.d/rc.local' to ensure# that this script will be executed during boot.touch /var/lock/subsys/localmount -t nfs -o vers=3,timeo=600,nolock 网关IP:/共享名称 /本地路径 挂载成功后，用户可以在客户端使用CSG提供的NFS文件共享服务，进行相应的文件共享操作。

操作步骤 登录CSG管理控制台。 在网关列表选择网关，单击待操作网关名称。 进入当前网关详情页面。 目前一个网关仅支持创建一个文件共享，一个文件共享对应一个桶目录或桶文件夹目录。 单击“创建文件共享”，进入文件共享创建页面，如图1。 图1 创建文件共享 设置共享名称，选择“桶”，输入“名称后缀”。 “桶”：在下拉列表中选择桶，作为文件共享源。因CSG目前仅支持数据上传到标准存储类型的桶，故下拉列表中仅显示未加密的标准存储类型桶。如果桶不存在，需先在OBS创建可用标准存储类型桶，再刷新桶列表选择。创建桶详细操作指导，请参考OBS创建桶。 （可选）“桶内文件夹”：桶中一级或多级文件夹名称，例如：一级文件夹/二级文件夹/....。设置后共享层级到文件夹层，网关读/写该文件夹中存储数据。自定义“名称后缀”允许包含数字、字母，及特殊字符“-”“_”，多层级间以“/”连接，且长度范围为0~64个字符。 “文件共享名称”：文件共享名称由桶名和桶内文件夹组成，格式为“桶名/名称后缀”。共享名称全局唯一，不能与任何已有共享名称重复，且创建成功后不能修改名称，创建时请设置合适的桶名。共享名称创建完成后作为文件共享的虚拟路径。 用户自定义的“桶内文件夹”对应桶中文件夹名称。如果桶中无该名称文件夹，将在桶中生成自定义名称的文件夹。 “文件共享名称”路径下文件的绝对路径总长度不能超过1024字符。 设置用户映射权限，选择“用户权限”。 “用户权限”：通过NFS协议中用户映射，可将客户端虚拟/实际用户或用户组的ID映射给正在对NFS进行读/写操作的用户，这个用户则具有映射用户或用户组ID所允许的权限。 “None”：默认取值，表示所有用户及所属用户组无映射。 “Root_Squash”：表示将Root用户及所属用户组映射为匿名用户或用户组。 “All_Squash”：表示将所有用户及所属用户组都映射为匿名用户或用户组。 （可选）设置客户端读/写权限。输入“只读客户端列表”和“读写客户端列表”。 “只读客户端列表”：只能读取OBS桶中对象的客户端。可输入多个客户端IP，用逗号隔开，支持输入IP、IP段、通配符“*”。 “读写客户端列表”：能读取OBS桶中对象和写入数据到OBS桶中的客户端。可输入多个客户端IP，用英文逗号隔开，支持输入IP、IP段、通配符“*”。 当一个客户端IP被同时设置了只读权限和读写权限时，取最大的权限生效，即有读写权限。 当客户端列表置空，即未设置客户端读/写权限时，禁止所有客户端对共享的OBS桶目录读/写权限。 当客户端列表置*，表示OBS桶目录对所有客户端开放，即所有客户端对共享的OBS桶目录有读/写权限。 确认信息无误后，单击“立即创建”，创建文件共享。

端口要求 为了保障数据安全、防止来自公网的NFS连接，建议运行云存储网关的服务器的端口配置如表2。 表2 端口使用说明 端口 协议 使用说明 22端口 TCP 使用端口通过SSH协议访问CSG管理控制台主机，对用户内部网络内服务器选择性开放。 123端口 UDP NTP客户端地址用于提供时间同步服务。 7443端口 TCP CSG初始配置Web服务端口，通过认证访问密钥（AK/SK）使用端口激活网关，对执行激活网关CSG管理控制台服务器开放。 111，20048端口 TCP/UDP 使用端口连接文件共享，对挂载NFS文件共享的客户端开放。 2049，2051，2052端口 TCP 使用端口连接文件共享，对挂载NFS文件共享的客户端开放。 10000-11023端口 TCP NFS文件锁服务端口，当多客户端文件锁时触发。

组网要求 客户端可以使用NFS协议通过公网挂载并访问，但是NFS协议传输未加密，出于安全考虑，不建议将本地客户端与云存储网关通过公网互联。推荐用户数据中心网关组网使用以下网络平面： 数据面网络：NFS客户端通过数据面网络将业务数据写入网关。 华为云专线网络：用户本地网关通过云专线（Direct Connect，DC）连接API网关和OBS，接收网关控制台配置命令和上报网关状态、监控数据到控制台，以及业务数据上传到OBS。 云专线需能连接到用户本地网关，并能连接到华为云对象存储服务、云解析服务和API网关服务的网络。 管理面网络：通过管理网络连接网关和配置网关。 NAS存储网络（有条件必选）：当外接NAS作为网关缓存时，网关通过该网络将数据写到NAS存储。

在线测试模板操作步骤 点击“执行测试”按钮； 执行测试时，根据商家的模板，开通云资源时会产生一定费用（部署时可查看费用明细），测试完成后，请及时删除已开通的资源，避免产生持续扣费。 进入 RFS 控制台，创建资源栈选择“已有模板”，模板来源选择“URL”； 进入“配置参数”页面，按照页面提示填写配置参数后进入下一页； 进入“资源栈设置”页面，完成资源栈设置； 确认配置参数和资源栈设置无误后，点击创建执行计划； 查看费用明细，如下图所示，此处商家需要确保模板中包含的云资源都能正常询出价格，如果不能正常询出价格，可参考：预估执行计划价格； 如费用明细无误，单击部署后，等待资源部署成功； 部署成功后，即华为云 资源编排 服务RFS完成了应用软件自动部署模板的开发。 本示例创建的云资源需要商家支付相应的费用，当商家不需要这些资源的时候，请删除资源栈并及时删除这些资源。

请求消息 请求参数说明请参见下表： 请求方法：POST 参数 是否必选 类型 取值范围 说明 activity M String 20 接口请求标识，用于区分接口请求场景。 异步申请License场景取值：getLicenseAsync instanceId M String 64 业务资源实例ID effectiveTime M String 32 License生效utc时间 expireTime O String 32 License失效utc时间，包周期类型必输 eventId M String 64 云商店业务流水号，用于商家服务器结合设备指纹，区分是否是同一次申请License的请求，支持License传输中断等业务需要重试的场景 deviceFingerprint O String 1024 设备指纹或硬件识别编码，用于需要绑定设备物理标识信息生成License的场景 testFlag O String 2 是否为调试请求。 1：调试请求 0：非调试请求 默认取值为“0”。 请求消息示例： curl -X POST 'https://www.isvwebsite.com/saasproduce?signature=11C4C*********31DEF5C515*******B8A3A6D8******7A48×tamp=1680508066618&nonce=50D83FDECAED6CCD8EF597F2A577950527928BA287D04E6036E92B2806FD17DA' -H 'Accept:application/json' -H 'Content-Type:application/json;charset=utf8' -d'{"activity":"getLicenseAsync","eventId":"8****e5694*****c8","instanceId":"RA2****4LVS","effectiveTime":"2023-10-27 10:30:15 z","expireTime":"2024-10-27 10:30:15 z","deviceFingerprint":"8******6034e2*****60e1"}'

接口说明 用户通过云商店向商家申请License。 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。 云商店会对接口异常的情况做监控，如商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。 云商店服务有可能重发请求，针对同一请求，商家的服务器应当返回相同的License，不应该创建新的License，返回之前成功创建的License即可。 申请License流程如下图所示： 上传License流程如下图所示：

响应消息 响应参数说明请参见下表： 参数 是否必选 类型 取值范围 说明 resultCode M String 6 调用结果码。 000000：表示资源同步开通 000004：表示资源异步开通 具体请参见《调用结果码说明》。 resultMsg O String 255 调用结果描述。 请及时关注商家信息中客服邮箱以及云商店账号绑定的邮箱的通知，收到调用失败通知邮件及时处理接口异常。 云商店会对接口异常的情况做监控，如商品频繁出现因接口异常的情况，云商店将对该商品做下架处理。 响应消息示例： { "resultCode":"000000", "resultMsg":"success." }

获取软件包下载地址 在做应用自动化部署时，商家需要将软件包上传到云商店资产中心，资产的创建和软件包的上传请参考《新增资产操作指导》。 资产创建成功后，商家将获得资产ID、资产类型和资产的版本，如下图所示。 资产ID、资产类型和资产版本将在Terraform模板中使用，商家可以通过Data Sources：huaweicloud_koogallery_assets，查询托管在云商店的软件包，示例代码如下，商家可以在Shell和PowerShell脚本中通过${ software_url_decode }获得软件包的下载地址，获得下载地址后，商家可以下载软件包并进行解压安装。 data "huaweicloud_koogallery_assets" "assets" { asset_id = "asset_id" deployed_type = "software_package" asset_version = "V1.0" }locals { software_url = data.huaweicloud_koogallery_assets.assets.assets[0].software_pkg_deployed_object[0].internal_path software_url_decode = jsondecode("\"${local.software_url}\"") } 父主题： 发布应用资产，上传软件包和模板

常见问题 1、通过自动部署交付能使用折扣优惠和券吗？ 可以，自动部署时通过自动支付方式购买的云资源，自动支付时支持使用折扣优惠、代金券、储值卡和现金券，使用顺序如下： 折扣优惠（每次只能使用一项）→代金券（每次只能使用一张）→现金券或储值卡（每次可使用多张，可同时使用）→账户余额（先扣现金额度后扣信用额度）或月末结算（硬件订单除外） 若自动支付时，系统匹配到折扣优惠、代金券、储值卡和现金券都满足要求，则可按使用顺序同时使用。更多信息请参考《自动支付》。 2、License商品对接了自动部署以后，会影响现有的License下单吗? 不影响，License商品对接自动部署以后，只在订单确认页多了一些提示信息，其他的均和非自动部署商品下单一致。 3、License商品对接了自动部署以后，影响服务监管吗？ 不影响，自动部署和服务监管是解耦的。如果商品支持自动部署，客户购买完成以后，在已购服务列表会展示“启动部署”的入口，如下图所示，客户可以选择使用自动部署，也可以选择按照之前的方式，联系ISV，由ISV进行交付。 4、License商品对接自动部署，需要重新发布一个License商品吗？ 不需要，只需要为支持自动部署的规格关联资产即可，如下图所示。更多信息请参考《自动部署接入指南》。 父主题： 自动部署接入指南