华为云用户手册

购买资源包 通用文件系统同时提供包年包月计费模式，您可以购买资源包实现包年包月计费。暂不支持退订资源包，请提前规划资源的使用额度和时长。 在SFS管理控制台左侧导航栏选择“资源包管理”。 单击页面右上角“购买资源包”。 图1 购买通用文件系统资源包 配置资源包参数。 表1 配置资源包参数 参数 说明 区域 选择资源包所属区域。 区域专属资源包，不支持共享给其他区域使用，请根据您资源所在地谨慎选择。 资源包规格 选择资源包规格。 通用文件系统资源包无法扩容，但可以叠加购买。 购买时长 选择购买时长。 购买数量 输入购买数量。 购买数量必须在1~3000之间。 生效时间 选择生效时间：支付完成后立即生效/指定时间生效。 如果支付时间晚于指定生效时间，资源包将在支付后立即生效。 企业项目 勾选“限定企业项目使用”可限定企业项目使用资源包，即仅在所选企业项目下的通用文件系统才能使用此资源包进行抵扣，同时也需满足资源包所属区域匹配的要求。如果未限定则全部企业项目均可使用。该选项仅对企业账号展示。 资源包示意 根据以上配置显示资源包示意图，包括资源包的基础配置和折合单价，以及相比按需计费所节省费用的百分比。 单击“立即购买”。 确认订单无误后，单击“去支付”。 若发现订单有误，也可单击“上一步”修改订单后再继续购买。 根据界面提示进行订单支付。 资源包购买注意事项： 支持续订，暂不支持退订。资源包到期后，不会影响您通用文件系统的使用和数据安全。您只要保证云服务账号上有足够的余额，系统会自动以按需计费的模式进行结算。

操作步骤 登录弹性文件服务管理控制台。 在文件系统列表中查看所有文件系统的基本信息，参数说明如表1所示。 表1 参数说明 参数 说明 名称 已创建的文件系统名称，例如：sfs-name-001。 可用区 文件系统所在的可用区。 状态 文件系统的状态，包含“可用”、“不可用”、“已冻结”、“正在创建”、“正在删除”、“删除错误”、“创建失败”、“正在扩容”、“扩容错误”、“正在缩容”、“缩容错误”和“缩容失败”。 类型 文件系统的类型。 协议类型 文件系统的协议类型为NFS或CIFS。 已用容量(GB) 文件系统存放数据已使用的空间。 说明： 该数据不是实时数据，平均15分钟刷新一次。SFS容量型文件系统已用容量小于1MB时，将不会显示已用容量。 最大容量（GB） 文件系统的最大使用容量。 已上传文件数 文件系统内已上传的文件数量。 说明： 通用文件系统展示该字段。 该数据不是实时数据，平均15分钟刷新一次。 是否加密 已经创建的文件系统的加密状态，包括“是”和“否”。 企业项目 文件系统归属的企业项目。 挂载地址 文件系统的挂载地址，NFS类型的格式为：文件系统域名:/路径，或文件系统IP:/，或域名地址:/；CIFS类型的格式为：\\文件系统域名\路径。 说明： 由于挂载地址名称较长，需要拉宽该栏以便完整显示。 操作 SFS容量型包含“容量调整”、“查看监控指标”和“删除”操作。 SFS Turbo包含“扩容”、“删除”、“查看监控指标”、“续订”和“退订”操作。 通用文件系统包含“删除”操作。 说明： 包年/包月的SFS Turbo文件系统创建完成后，大约1到2分钟后，才能执行续订、退订等操作。 单击文件系统名称，可查看更多的文件系统信息。 图1 SFS Turbo文件系统的扩展信息 图2 通用文件系统的扩展信息 图3 SFS容量型文件系统的扩展信息 （可选）通过文件系统名称关键字、密钥ID或文件系统状态来过滤查看指定的文件系统。

计费项 弹性文件服务不同类型的文件系统，如SFS容量型文件系统、通用文件系统、SFS Turbo文件系统都可按需计费。SFS容量型文件系统、通用文件系统、SFS Turbo文件系统计费项都是存储空间费用；其中SFS Turbo文件系统的HPC缓存型除存储空间计费外，还可以按“带宽大小”计费项来计费。 表1 SFS容量型文件系统的计费模型 资费项 计费项 计费项说明 计费公式 计费模式 存储费用 存储空间 文件系统所使用的存储容量和使用时长 存储费用=每GB费率*使用容量*使用时长 按需计费 包年包月 表2 通用文件系统的计费模型 资费项 计费项 计费项说明 计费公式 计费模式 存储费用 存储空间 文件系统所使用的存储容量和使用时长 存储费用=每GB费率*使用容量*使用时长 按需计费 包年包月 表3 SFS Turbo文件系统的计费模型 适用类型 资费项 计费项 计费项说明 计费公式 计费模式 标准型、标准型-增强版、性能型、性能型-增强版、20MB/s/TiB、40MB/s/TiB、125MB/s/TiB、250MB/s/TiB、500MB/s/TiB、1000MB/s/TiB、HPC缓存型 存储费用 存储空间 文件系统所购买的存储容量和使用时长 存储费用=每GB费率*购买容量*使用时长 按需计费 包年包月 HPC缓存型 带宽费用 带宽大小 根据缓存带宽大小和使用时长计费 带宽费用=每GB费率*带宽大小*使用时长 按需计费 通用文件系统低频存储计费： 计费模型：标准存储每GB费率*存储容量*标准存储使用时长+低频存储每GB费率*存储容量*低频存储使用时长 示例：系统预设的生命周期规则中“转换为低频访问存储天数”为14天，那14天及之前就按标准存储费用计费，14天后按低频存储费用计费。

在续费管理页面开通自动续费 登录管理控制台。 单击“控制台”页面上方“费用”，在下拉菜单中选择“续费管理”。 进入“续费管理”页面。 自定义查询条件。 可在“自动续费项”页签查询已经开通自动续费的资源。 可对“手动续费项”、“到期转按需项”、“到期不续费项”页签的资源开通自动续费。 图3 续费管理 为包年/包月资源开通自动续费。 单个资源开通自动续费：选择需要开通自动续费的资源包，单击操作列“开通自动续费”。 图4 单个资源开通自动续费 批量资源开通自动续费：选择需要开通自动续费的资源包，单击列表左上角的“开通自动续费”。 图5 多个资源开通自动续费 选择续费时长，并根据需要设置自动续费次数，单击“开通”。 图6 开通自动续费

适用计费项 SFS容量型/通用文件系统 默认为按需计费模式。即创建文件系统免费，按实际使用的存储容量和时长收费，以小时为单位，按每小时整点结算，不设最低消费标准。结算时，时长不足1小时的，按1小时计费。 表1 SFS容量型/通用文件系统计费模型 计费项 计费项 存储空间计费 文件系统所占用的存储空间容量和使用时长 SFS Turbo文件系统 SFS Turbo文件系统默认为按需计费模式，按您购买时选择的存储容量和时长收费，而不是以实际的使用量收费（其中，HPC缓存型文件系统还可按带宽大小收费）。以小时为单位，按每小时整点结算。结算时，时长不足1小时的，按1小时计费。 表2 SFS Turbo 计费模型 计费项 计费因子 SFS Turbo 存储空间 HPC缓存型 存储空间 带宽大小

变更配置后对计费的影响 如果您在购买按需计费资源后变更了资源规格，会产生一个新订单并开始按新规格的价格计费，旧订单自动失效。 如果您在一个小时内变更了资源规格，将会产生多条计费信息。每条计费信息的开始时间和结束时间对应不同规格在该小时内的生效时间。 例如，您在9:00:00购买了一个按需计费的SFS Turbo 40MB/s/TiB文件系统，存储容量是500GB，并在9:30:00扩容为600GB，那么在9:00:00 ~ 10:00:00间会产生两条计费信息。 第一条对应9:00:00 ~ 9:30:00，文件系统容量按照500GB计费。 第二条对应9:30:00 ~ 10:00:00，文件系统容量按照600GB计费。

请求示例 修改指定service_id和schema_id的契约的契约内容和摘要。 PUT https://{endpoint}/v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id} { "schema": "---\nswagger: \"2.0\"\ninfo:\n version: \"1.0.0\"\n title: \"swagger definition for com.service.provider.controller.ProviderImpl\"\n x-java-interface: \"cse.gen.springmvc.provider.provider.ProviderImplIntf\"\nbasePath: \"/provider\"\nconsumes:\n- \"application/json\"\nproduces:\n- \"application/json\"\npaths:\n /helloworld:\n get:\n operationId: \"helloworld\"\n produces:\n - \"application/json\"\n parameters:\n - name: \"name\"\n in: \"query\"\n required: true\n type: \"string\"\n responses:\n 200:\n description: \"response of 200\"\n schema:\n type: \"string\"\n", "summary": "test" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Authorization 否 String 若微服务引擎专享版开启了安全认证，此参数必填。否则，无此参数。 开启了安全认证的微服务引擎专享版Token，格式为： Authorization:Bearer {Token} Token获取方法，请参考获取微服务引擎专享版用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 schema 是 String 契约内容。 summary 否 String 新加入参数，后面创建schema，请尽量提供schema的摘要。

响应参数 状态码： 400 表4 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表5 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

URI PUT /v4/{project_id}/registry/microservices/{service_id}/schemas/{schema_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 微服务引擎专业版，请填租户项目id，长度为1~64，获取方法请参考获取项目ID。也可以填固定值default。 微服务引擎专享版，请填固定值：default。 service_id 是 String 微服务唯一标识。字符长度为1~64，正则表达式为^.*$。获取方法请参考查询所有微服务信息。 schema_id 是 String 微服务契约唯一标识。字符长度为1~160，正则表达式为^[a-zA-Z0-9]{1,160}$|^[a-zA-Z0-9][a-zA-Z0-9_-.]{0,158}[a-zA-Z0-9]$。获取方法请参考查询微服务的所有契约。

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

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则Content-type中需声明字符编码方式为utf-8，例如，Content-Type: application/json;utf-8。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中： username为登录用户名。 ********为用户登录密码。 domainname为用户所属的账号名称。 xxxxxxxxxxxxxxxxxx为project的名称，即从地区和终端节点处获取到的“区域”名称。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } scope参数定义了Token的作用范围，取值为project或domain。上面示例中取值为project，表示获取的Token仅能访问指定project下的资源。取值为domain时，表示获取的token可以访问指定账号下所有资源。scope参数的详细说明，请参考获取用户Token。 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl命令行、postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID：子项目ID，可选，在多项目场景中使用。 X-Domain-ID：账号ID。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

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

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 id String 微服务引擎专享版专享版ID。 name String 微服务引擎专享版名称。 jobId Integer 微服务引擎专享版执行任务ID。 状态码： 400 表7 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。 状态码： 500 表8 响应Body参数 参数 参数类型 描述 errorCode String 错误代码。 errorMessage String 错误信息。 detail String 详细定位信息。

请求示例 创建一个名称为“test”微服务引擎专享版，其计费模式为按需计费，规格为cse.s1.small2，可用区为test，关闭安全认证，微服务引擎的部署类型为CSE2。 POST https://{endpoint}/v2/{project_id}/enginemgr/engines { "name": "test", "description": "test", "payment": "1", "flavor": "cse.s1.small2", "azList": ["test"], "authType": "NONE", "vpc": "vpc-demotest", "vpcId": "09902850-9454-4715-9764-018f0c37022", "networkId": "88550801-e892-4f8e-b21b-f7147f6229", "subnetCidr": "192.168.0.5/26", "specType": "CSE2, "inputs": { "nodeFlavor": "s6.large.2" } }

请求示例 创建一个名称为development-env的“虚拟机”类型的环境，环境所在VPC的id为29d55020-ae0e-4a18-871c-93e6976ee7bd。 { "name": "development-env", "description": "", "charge_mode": "provided", "deploy_mode": "container", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "b6862a62-d916-11e9-bdf1-0255ac101fd9", "type": "cce" } ], "optional_resources": [ { "id": "default", "type": "cse" } ] }

响应示例 { "id": "00078e9d-a61c-476e-ac63-a10c9cb2638e", "name": "development-env", "alias": null, "description": "", "project_id": "e7d2e9c589e5445e808a8ff0d1235aca", "enterprise_project_id": "0", "charge_mode": "provided", "deploy_mode": "container", "vpc_id": "29d55020-ae0e-4a18-871c-93e6976ee7bd", "base_resources": [ { "id": "b6862a62-d916-11e9-bdf1-0255ac101fd9", "type": "cce" } ], "optional_resources": [ { "id": "default", "type": "cse" } ], "creator": "ss-test", "create_time": 1610418873730, "update_time": 1610418873730 }

请求消息 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 消息体的类型（格式）。 X-Auth-Token 是 String 调用接口的认证方式分为Token和AK/SK两种。如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考获取用户Token。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 环境名称。 由英文字母、数字、中划线（-）、下划线（_）组成，并以英文字母开头，英文字母或者数字结尾，英文字母不区分大小写，长度为2~64个字符。 alias 否 String 环境别名。 最大长度为64个字符。 deploy_mode 是 String 指定环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 description 否 String 环境描述。 最大长度为128个字符。 enterprise_project_id 否 String 企业项目ID。 charge_mode 否 String 收费模式，支持provided、on_demanded、monthly。默认provided，表示使用用户提供的已有资源，无需收费。on_demanded表示按需收费，monthly表示包月收费。 vpc_id 是 String 虚拟私有云ID。 base_resources 是 Array of objects 基础资源，请参考表4。 optional_resources 否 Array of objects 可选资源，请参考表4。 表4 resource参数 参数 是否必选 参数类型 描述 id 是 String 资源ID。 type 是 String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。 name 否 String 资源名称。

响应消息 表5 响应参数 参数 参数类型 描述 id String 环境ID。 name String 环境名称。 alias String 环境别名。 description String 环境描述。 project_id String 项目ID。 enterprise_project_id String 企业项目ID。 charge_mode String 收费模式。 deploy_mode String 环境类型。 virtualmachine：虚拟机。 container：Kubernetes。 mixed ：虚拟机和Kubernetes。 vpc_id String 虚拟私有云ID。 base_resources Array of objects 基础资源，请参考表6，返回为空。 optional_resources Array of objects 可选资源，请参考表6，返回为空。 creator String 创建人。 create_time Integer 创建时间。 update_time Integer 修改时间。 表6 resource参数 参数 参数类型 描述 id String 资源ID。 name String 资源名称。 type String 基础资源：cce、ecs、as。 可选资源：rds、dcs、elb、cse等其他类型。

功能介绍 环境是用于应用部署和运行的计算、存储、网络等基础资源的集合。ServiceStage把相同VPC下的计算资源（如云服务引擎CCE、弹性云服务器ECS等）、网络资源（如弹性负载均衡ELB、弹性公网EIP等）和中间件（如分布式缓存DCS、云数据库RDS、微服务引擎CSE等）组合为一个环境，如：开发环境，测试环境，预生产环境，生产环境。环境内网络互通，可以按环境维度来管理资源、部署服务，减少具体基础资源运维管理的复杂性。 此API用来创建环境。

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：自定义策略中授权项定义的内容即为权限。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 IAM项目(Project)/企业项目(Enterprise Project)：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。管理员可以在授权项列表中查看授权项是否支持IAM项目或企业项目，“√”表示支持，“×”表示暂不支持。关于IAM项目与企业项目的区别，请参考IAM与企业管理的区别。 ServiceStage的支持自定义策略授权项，请参考表1。 表1 ServiceStage授权项明细 权限 对应API接口 授权项 IAM项目 企业项目 创建应用 POST /v3/{project_id}/cas/applications servicestage:app:create √ √ 删除应用 DELETE /v3/{project_id}/cas/applications/{application_id} servicestage:app:delete √ √ 更新应用 PUT /v3/{project_id}/cas/applications/{application_id} servicestage:app:modify √ √ 查看应用列表 GET /v3/{project_id}/cas/applications servicestage:app:list √ √ 查询应用信息 GET /v3/{project_id}/cas/applications/{application_id} servicestage:app:get √ √ 修改工程 - servicestage:project:modify √ √ 创建工程 - servicestage:project:create √ √ 审批应用 - servicestage:app:approve √ √ 查看流水线列表 - servicestage:pipeline:list √ √ 修改构建 - servicestage:assembling:modify √ √ 审批流水线 - servicestage:pipeline:review √ √ 执行流水线 - servicestage:pipeline:execute √ √ 查看构建信息 - servicestage:project:get √ √ 删除构建 - servicestage:assembling:delete √ √ 删除流水线 - servicestage:pipeline:delete √ √ 删除工程 - servicestage:project:delete √ √ 修改流水线 - servicestage:pipeline:modify √ √ 创建构建 - servicestage:assembling:create √ √ 查看构建列表 - servicestage:assembling:list √ √ 查看构建信息 - servicestage:assembling:get √ √ 查看工程列表 - servicestage:project:list √ √ 查看流水线信息 - servicestage:pipeline:get √ √ 创建流水线 - servicestage:pipeline:create √ √

产品功能 镜像全生命周期管理 容器镜像服务支持镜像的全生命周期管理，包括镜像的上传、下载、删除等。 私有镜像仓库 容器镜像服务提供私有镜像库，并支持细粒度的权限管理，可以为不同用户分配相应的访问权限（读取、编辑、管理）。 镜像加速 容器镜像服务通过华为自主专利的镜像下载加速技术，使CCE集群下载镜像时在确保高并发下能获得更快的下载速度。 镜像仓库触发器 容器镜像服务支持容器镜像版本更新自动触发部署。您只需要为镜像设置一个触发器，通过触发器，可以在每次镜像版本更新时，自动更新使用该镜像部署的应用。

产品简介 容器镜像服务（SoftWare Repository for Container，简称SWR）是一种支持镜像全生命周期管理的服务， 提供简单易用、安全可靠的镜像管理功能，帮助您快速部署容器化服务。 通过使用容器镜像服务，您无需自建和维护镜像仓库，即可享有云上的镜像安全托管及高效分发服务，并且可配合云容器引擎 CCE、云容器实例 CCI使用，获得容器上云的顺畅体验。 容器镜像服务共享版免费，企业版收费。共享版和企业版的差异详见共享版及企业版对比。企业版的计费项包括购买仓库的费用、制品存储的费用和制品传输流量费用

访问方式 华为云提供了Web化的服务管理平台（即管理控制台）和基于HTTPS请求的API（Application programming interface）管理方式。 API方式 如果用户需要将容器镜像服务集成到第三方系统，用于二次开发，请使用API方式访问容器镜像服务。具体操作请参见《容器镜像服务API参考》。 管理控制台方式 其他相关操作，请使用管理控制台方式访问容器镜像服务。如果用户已在云平台注册，可直接登录管理控制台，从主页选择“容器镜像服务”。 如果未注册，请参考如何注册华为云管理控制台的用户，进行账号注册。

开始使用 导入依赖模块 import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" ocr "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/ocr/v1/region" ) 配置认证信息 配置AK、SK信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作。 func main() { ak := os.Getenv("HUAWEICLOUD_SDK_AK") sk := os.Getenv("HUAWEICLOUD_SDK_SK") auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). Build() } 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 初始化客户端（二选一） 指定云服务region方式（推荐） // 初始化指定云服务的客户端 New{Service}Client，以初始化华北-北京四（cn-north-4）区域服务为例 func main() { client := ocr.NewOcrClient( ocr.OcrClientBuilder(). WithRegion(region.ValueOf("cn-north-4")). WithCredential(auth). Build()) } 指定云服务endpoint方式 func main() { // 指定终端节点，以OCR服务北京四的endpoint为例 endpoint:="https://ocr.cn-north-4.myhuaweicloud.com" // 使用endpoint方式，在认证信息中需新增projectId auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() // 初始化指定云服务的客户端 New{Service}Client client := ocr.NewOcrClient( ocr.OcrClientBuilder(). WithEndpoint(endpoint). WithCredential(auth). Build()) } endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看 地区和终端节点 。 发送请求并查看响应 // 以调用通用表格识别接口 RecognizeGeneralTable 为例 request := &model.RecognizeGeneralTableRequest{} urlGeneralTableRequestBody:= "图片的url" request.Body = &model.GeneralTableRequestBody{ Url: &urlGeneralTableRequestBody, } response, err := client.RecognizeGeneralTable(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } 异常处理 表1 异常处理 一级分类 一级分类说明 ServiceResponseError 服务响应异常 url.Error url异常 response, err := client.RecognizeGeneralTable(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) }

开始使用 导入依赖模块 package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; // 对用户身份进行认证 import com.huaweicloud.sdk.core.auth.BasicCredentials; // 请求异常类 import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; // 导入OCR客户端 import com.huaweicloud.sdk.ocr.v1.region.OcrRegion; import com.huaweicloud.sdk.ocr.v1.*; import com.huaweicloud.sdk.ocr.v1.model.*; 配置客户端连接参数 默认配置 // 使用默认配置 HttpConfig config = HttpConfig.getDefaultHttpConfig(); 网络代理（可选） // 根据需要配置网络代理，网络代理默认的协议为 `http` 协议 config.withProxyHost("proxy.huaweicloud.com") .withProxyPort(8080) .withProxyUsername("test") .withProxyPassword("test"); 超时配置（可选） // 默认连接超时时间为60秒，可根据需要调整 config.withTimeout(60); SSL配置（可选） // 根据需要配置是否跳过SSL证书验证 // 执行SDK时出现javax.net.ssl.SSLHandshakeException: Received fatal alert: handshake_failure报错，可添加此代码，跳过SSL证书验证 config.withIgnoreSSLVerification(true); 配置认证信息 配置AK、SK、project_id信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。有两种认证方式，分别如下。 初始化认证信息： String ak = System.getenv("HUAWEICLOUD_SDK_AK"); String sk = System.getenv("HUAWEICLOUD_SDK_SK"); 认证用的 ak 和 sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 如果没有设置环境变量，可以去掉System.getenv方法调用，直接填写对应的 ak、sk，例如：String ak = "ak"; String sk = "sk"。 使用永久AK和SK BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withProjectId(projectId); 使用临时AK和SK BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withSecurityToken(securityToken) .withProjectId(projectId) 认证参数说明： ak、sk：访问密钥信息，获取方法请参见准备工作。 projectId：华为云项目ID，获取方法请参见准备工作。 securityToken：临时认证场景下的安全票据，可以通过token获取或者通过委托授权获取。 初始化客户端（二选一） 指定region方式（推荐） // 增加region依赖 import com.huaweicloud.sdk.ocr.v1.region.OcrRegion; // 初始化客户端认证信息，使用当前客户端初始化方式可不填 projectId/domainId ICredential auth = new BasicCredentials() .withAk(ak) .withSk(sk); // 初始化指定云服务的客户端 {Service}Client ，以初始化OCR服务的 OcrClient 为例 OcrClient Client = OcrClient.newBuilder() .withHttpConfig(config) .withCredential(auth) .withRegion(OcrRegion.valueOf("cn-north-4")) .build(); 指定云服务endpoint方式 // 指定终端节点，以OCR服务北京四的 endpoint 为例 String endpoint = "https://ocr.cn-north-4.myhuaweicloud.com"; // 初始化客户端认证信息，需要填写相应 projectId/domainId，以初始化 BasicCredentials 为例 BasicCredentials basicCredentials = new BasicCredentials() .withAk(ak) .withSk(sk) .withProjectId(projectId); // 初始化指定云服务的客户端 {Service}Client ，以初始化 Region 级服务OCR的 OcrClient 为例 OcrClient ocrClient = OcrClient.newBuilder() .withHttpConfig(config) .withCredential(basicCredentials) .withEndpoint(endpoint) .build(); endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看 地区和终端节点 。 发送请求并查看响应 // 以调用通用表格识别接口 RecognizeGeneralTable 为例 RecognizeGeneralTableRequest request = new RecognizeGeneralTableRequest(); GeneralTableRequestBody body = new GeneralTableRequestBody(); body.withUrl("图片的url"); request.withBody(body); try { RecognizeGeneralTableResponse response = client.recognizeGeneralTable(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } 异常处理 表1 异常处理 一级分类 一级分类说明 二级分类 二级分类说明 ConnectionException 连接类异常 HostUnreachableException 网络不可达、被拒绝。 SslHandShakeException SSL认证异常。 RequestTimeoutException 响应超时异常 CallTimeoutException 单次请求，服务器处理超时未返回。 RetryOutageException 在重试策略消耗完成后，仍无有效的响应。 ServiceResponseException 服务器响应异常 ServerResponseException 服务端内部错误，Http响应码：[500,]。 ClientRequestException 请求参数不合法，Http响应码：[400, 500) // 异常处理 try { RecognizeGeneralTableRequest request = new RecognizeGeneralTableRequest(); RecognizeGeneralTableResponse response = client.recognizeGeneralTable(request); System.out.println(response.toString()); } catch(ServiceResponseException e) { logger.error("HttpStatusCode: " + e.getHttpStatusCode()); logger.error("RequestId: " + e.getRequestId()); logger.error("ErrorCode: " + e.getErrorCode()); logger.error("ErrorMsg: " + e.getErrorMsg()); }

安装SDK 使用SDK前，需要安装“HuaweiCloud.SDK.Core”和“HuaweiCloud.SDK.Ocr”，有两种安装方式，分别如下。 使用 .NET CLI 工具 dotnet add package HuaweiCloud.SDK.Core dotnet add package HuaweiCloud.SDK.Ocr 使用 Package Manager Install-Package HuaweiCloud.SDK.Core Install-Package HuaweiCloud.SDK.Ocr

开始使用 导入依赖模块 using System; using System.Collections.Generic; using HuaweiCloud.SDK.Core; using HuaweiCloud.SDK.Core.Auth; using HuaweiCloud.SDK.Ocr; using HuaweiCloud.SDK.Ocr.V1; using HuaweiCloud.SDK.Ocr.V1.Model; 配置客户端连接参数 默认配置 // 使用默认配置 var config = HttpConfig.GetDefaultConfig(); 网络代理（可选） // 根据需要配置网络代理 config.ProxyHost = "proxy.huaweicloud.com"; config.ProxyPort = 8080; config.ProxyUsername = "test"; config.ProxyPassword = "test"; 超时配置（可选） // 默认超时时间为120秒，可根据需要调整 config.Timeout = 120; SSL配置（可选） // 根据需要配置是否跳过SSL证书验证 config.IgnoreSslVerification = true; 配置认证信息 配置AK、SK信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。AK、SK获取方法请参见准备工作。 const string ak = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_AK"); const string sk = Environment.GetEnvironmentVariable("HUAWEICLOUD_SDK_SK"); var auth = new BasicCredentials(ak, sk); 认证用的 ak 和sk 硬编码到代码中或者明文存储都有很大的安全风险，建议在配置文件或者环境变量中密文存放，使用时解密，确保安全。 本示例以 ak 和 sk 保存在环境变量中来实现身份验证为例，运行本示例前请先在本地环境中设置环境变量HUAWEICLOUD_SDK_AK和HUAWEICLOUD_SDK_SK。 初始化客户端（二选一） 指定云服务region方式（推荐） // 初始化指定云服务的客户端 {Service}Client ，以初始化OCR服务的 OcrClient 为例 var client = OcrClient.NewBuilder() .WithCredential(auth) .WithRegion(OcrRegion.ValueOf("cn-north-4")) .WithHttpConfig(config) .Build(); 指定云服务endpoint方式 // 指定终端节点，以OCR服务北京四的 endpoint 为例 String endpoint = "https://ocr.cn-north-4.myhuaweicloud.com"; // 初始化客户端认证信息，需要填写相应 projectId，以初始化 BasicCredentials 为例 var auth = new BasicCredentials(ak, sk, projectId); // 初始化指定云服务的客户端 {Service}Client，以初始化OCR服务的 OcrClient 为例 var client = OcrClient.NewBuilder() .WithCredential(auth) .WithEndPoint(endpoint) .WithHttpConfig(config) .Build(); endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看 地区和终端节点 。 发送请求并查看响应 // 以调用通用表格识别接口 RecognizeGeneralTable 为例 var req = new RecognizeGeneralTableRequest { }; req.Body = new GeneralTableRequestBody() { Url = "图片的url" }; try { var resp = client.RecognizeGeneralTable(req); var respStatusCode = resp.HttpStatusCode; Console.WriteLine(respStatusCode); } 异常处理 表1 异常处理 一级分类 一级分类说明 二级分类 二级分类说明 ConnectionException 连接类异常 HostUnreachableException 网络不可达、被拒绝。 SslHandShakeException SSL认证异常。 RequestTimeoutException 响应超时异常 CallTimeoutException 单次请求，服务器处理超时未返回。 RetryOutageException 在重试策略消耗完成后，仍无有效的响应。 ServiceResponseException 服务器响应异常 ServerResponseException 服务端内部错误，Http响应码：[500,]。 ClientRequestException 请求参数不合法，Http响应码：[400, 500) try { var resp = client.RecognizeGeneralTable(req); var respStatusCode = resp.HttpStatusCode; Console.WriteLine(respStatusCode); } catch (RequestTimeoutException requestTimeoutException) { Console.WriteLine(requestTimeoutException.ErrorMessage); } catch (ServiceResponseException clientRequestException) { Console.WriteLine(clientRequestException.HttpStatusCode); Console.WriteLine(clientRequestException.ErrorCode); Console.WriteLine(clientRequestException.ErrorMsg); } catch (ConnectionException connectionException) { Console.WriteLine(connectionException.ErrorMessage); }

文字识别SDK概述 文字识别（Optical Character Recognition，简称OCR）将图片或扫描件中的文字识别成可编辑的文本。可代替人工录入，提升业务效率。支持身份证、驾驶证、行驶证、发票、通用表格、通用文字等场景文字识别。 文字识别以开放API（Application Programming Interface，应用程序编程接口）的方式提供给用户，用户通过实时访问和调用API获取推理结果，帮助用户提升业务效率。 文字识别服务软件开发工具包（OCR SDK，Optical Character Recognition Service Software Development Kit）是对OCR服务提供的REST API进行的封装，以简化用户的开发工作。用户直接调用OCR SDK提供的接口函数即可实现使用OCR服务业务能力的目的。 我们针对不同语言的SDK提供了开发指南： 表1 不同语言SDK的开发指南 编程语言 开发指南 Java Java SDK 开发指南 Python Python SDK 开发指南 Node.js Node.js SDK 开发指南 PHP PHP SDK 开发指南 C++ C++ SDK 开发指南 Go Go SDK 开发指南 NET NET SDK 开发指南