华为云用户手册

创建rf_admin_trust委托（可选） 进入华为云官网，打开控制台管理界面，鼠标移动至个人账号处，打开“ 统一身份认证 ”菜单。 图1 控制台管理界面 图2 统一身份认证菜单 进入“委托”菜单，搜索“rf_admin_trust”委托。 图3 委托列表 如果委托存在，则不用执行接下来的创建委托的步骤 如果委托不存在时执行接下来的步骤创建委托 单击步骤2界面中的“创建委托”按钮，在委托名称中输入“rf_admin_trust”，委托类型选择“云服务”，输入“ RFS ”，单击“完成”。 图4 创建委托 单击“立即授权”。 图5 委托授权 在搜索框中输入”Tenant Administrator”并勾选搜索结果，单击“下一步”。 图6 选择策略 选择“所有资源”，并单击“确定”完成配置。 图7 设置最小授权范围 “委托”列表中出现“rf_admin_trust”委托则创建成功。 图8 委托列表

资源和成本规划 该解决方案主要部署如下资源，以下费用仅供参考，具体请参考华为云官网价格详情，实际收费以账单为准。 表1 资源和成本规划（按需计费） 华为云服务 资源名称 配置示例 数量 每月预估花费 虚拟私有云 VPC deploying-embedding-and-reranker-models-demo VPC网段：172.16.0.0/16 区域：西南-贵阳一 1 0.00元 子网 Subnet deploying-embedding-and-reranker-models-demo-subnet 子网网段：172.16.1.0/24 区域：西南-贵阳一 1 0.00元 安全组 SecurityGroup deploying-embedding-and-reranker-models-demo 允许ping：0.0.0.0/0 开放端口22允许Cloud Shell 登录：121.36.59.153/32 区域：西南-贵阳一 1 0.00元 Flexus云服务器X实例 deploying-embedding-and-reranker-models-demo 按需计费：1.34/小时 区域：西南-贵阳一 规格：Flexus云服务器X实例 | 性能模式（开启）| x1e.16u.16g | 16核 | 16GB 镜像：Ubuntu 22.04 server 64bit 系统盘：通用型SSD | 40GB 1 967.82元 弹性公网IP EIP deploying-embedding-and-reranker-models-demo-eip 按需计费：0.80元/GB 区域：西南-贵阳一 线路：动态BGP 公网带宽：按流量计费 带宽大小：300Mbit/s 1 0.80元/GB 合计 - - 967.82元 + 弹性公网IP EIP费用 表2 资源和成本规划（包年包月） 华为云服务 资源名称 配置示例 数量 每月预估花费 虚拟私有云 VPC deploying-embedding-and-reranker-models-demo VPC网段：172.16.0.0/16 区域：西南-贵阳一 1 0.00元 子网 Subnet deploying-embedding-and-reranker-models-demo-subnet 子网网段：172.16.1.0/24 区域：西南-贵阳一 1 0.00元 安全组 SecurityGroup deploying-embedding-and-reranker-models-demo 允许ping：0.0.0.0/0 开放端口22允许Cloud Shell 登录：121.36.59.153/32 区域：西南-贵阳一 1 0.00元 Flexus云服务器X实例 deploying-embedding-and-reranker-models-demo 包年包月 区域：西南-贵阳一 规格：Flexus云服务器X实例 | 性能模式（开启）| x1e.16u.16g | 16核 | 16GB 镜像：Ubuntu 22.04 server 64bit 系统盘：通用型SSD | 40GB 1 650.40元 弹性公网IP EIP deploying-embedding-and-reranker-models-demo-eip 按需计费：0.80元/GB 区域：西南-贵阳一 线路：动态BGP 公网带宽：按流量计费 带宽大小：300Mbit/s 1 0.80元/GB 合计 - - 650.40元 + 弹性公网IP EIP费用

应用场景 本方案旨在通过华为云Flexus云服务器X实例高效部署和运行Embedding（bge-m3）及Reranker（bge-reranker-v2-m3）模型。bge-m3模型是一种先进的文本嵌入模型，能够将文本转换为高维向量，从而实现高效的文本相似度计算、分类等任务。bge-reranker-v2-m3是一个轻量级的重排序模型，具有强大的多语言能力，易于部署，推理速度快。借助于Flexus云服务器的强大性能和弹性扩展能力，用户可以轻松地在云端部署此模型，并根据实际需求灵活调整资源。 文本相似度计算：适用于搜索引擎、推荐系统等领域，帮助提升搜索结果的相关性和推荐准确性。 文本分类与聚类：广泛应用于内容管理、舆情分析等场景，支持自动化的信息分类与主题发现。 自然语言处理任务：如情感分析、意图识别等，助力企业更好地理解和利用非结构化数据。 搜索引擎优化：在大型搜索引擎中，重排序模型可以帮助优化搜索结果，确保用户看到的信息是最相关和最有价值的。 问答系统：在问答系统中，重排序模型可以帮助确定哪些答案是最准确和最相关的，从而提高问题解决的质量。

方案架构 该解决方案帮助您在华为云Flexus云服务器X实例（弹性云服务器 E CS ）上快速部署Embedding（bge-m3）及Reranker（bge-reranker-v2-m3）模型。 图1 方案架构图 该解决方案将会部署如下资源： 创建一个弹性公网IP EIP，用于提供访问公网和被公网访问能力。 创建一台Flexus云服务器X实例（弹性云服务器 ECS），用于部署Embedding（bge-m3）及Reranker（bge-reranker-v2-m3）模型。 创建一个安全组，通过配置安全组规则，为云服务器提供安全防护。

名词解释 华为云Flexus云服务器X实例：Flexus云服务器X实例是新一代面向中小企业和开发者打造的柔性算力云服务器。Flexus云服务器X实例功能接近ECS， 同时还具备独有特点，例如Flexus云服务器X实例具有更灵活的vCPU内存配比、支持热变配不中断业务变更规格、支持性能模式等。 弹性云服务器 ECS：是一种云上可随时自助获取、可弹性伸缩的计算服务，可帮助您打造安全、可靠、灵活、高效的应用环境。 虚拟私有云 VPC：是用户在华为云上申请的隔离的、私密的虚拟网络环境。用户可以基于VPC构建独立的云上网络空间，配合弹性公网IP、云连接、云专线等服务实现与Internet、云内私网、跨云私网互通，帮您打造可靠、稳定、高效的专属云上网络。 弹性公网IP EIP：提供独立的公网IP资源，包括公网IP地址与公网出口带宽服务。可以与弹性云服务器、裸金属服务器、虚拟IP、弹性负载均衡、NAT网关等资源灵活地绑定及解绑，提供访问公网和被公网访问能力。

计费周期和规则 按小时计费 需要至少每小时上报一次话单数据，且最好在消费时间下一个小时的0-15分钟内完成上报，譬如，用户消费时间在13:25，最好在14:00-14:15内上报，这样能及时给用户扣费，否则就会出现扣费延迟，如果无法实现实时上报，需要在2小时完成上报 按天计费 推荐每小时将已经明确的用量话单上报到云商店，如果必须每天汇总上报一次，需要保证必须在次日的00:00-00:15内完成上报，最大不能超过01:00，否则用户的扣费会延迟到下一天

前提条件 发布SaaS类产品之前，您须将您的SaaS类产品部署在华为云国际站的基础设施上，华为云云商店不接受部署在非华为云国际站的基础设施上的SaaS类产品发布申请。 发布SaaS类产品之前，您需要遵循SaaS类产品接入指南V2.0进行接口开发调测，以供华为云云商店调用。SaaS 2.0接口协议提供更高的安全性、可靠性、易用性。 发布SaaS类产品之前，请先进行应用接入调试，华为云云商店提供了应用接入调试功能，务必保证对应场景的生产接口都能调试通过，系统会针对调测通过的用例进行保存用于商品发布、修改及审核上架时接口校验，以保证用户购买您的SaaS商品后，能够正常开通。 发布SaaS类商品如涉及为用户提供网站服务（包括业务前台，管理后台portal等），您需确保您的应用不存在恶意内容，高危漏洞等。请您根据SaaS类商品安全 漏洞扫描 操作指导及安全规范的指引，对应用完成安全漏洞扫描自测试 ，商品发布时关联相应的扫描测试报告一起提交审核。

联营商品服务支持条款发布说明 联营商品服务支持条款涉及商家与买家、华为云三方，因此商家拟定条款时应使用云商店提供的模板。 接入类型 模板 SaaS、镜像、API、容器、数据资产、AI资产类 联营商品服务支持条款（SaaS、镜像、API、容器、数据资产、AI资产类）.docx License 联营商品服务支持条款（License）.docx 人工服务 云商店联营商品服务支持条款（人工服务）.docx 硬件 联营商品服务支持条款（硬件）.docx 您需根据模板内注释要求修改（如下图，下载模板后可见），请在填写之后对照检查常见错误： 未使用联营服务支持条款模板更新。 使用与本次发布商品接入类型不一致的模板更新。 条款首段：商家公司名称填写不全或与发布主体不符。您可进入商家信息页面查看公司全称。 条款首段：商品名称填写与本次上架的商品名称不一致，或是复制其他商品的协议后未修改。 “数据保护”部分，未补充《商家隐私声明》的URL链接。 父主题： 商品发布相关问题

通用商品规格发布说明 如无授权，规格名称不能直接借助华为名义，如命名为“华为XXX”。 商品规格名称的命名应有一定规则，请勿以“规格1”、“规格2”等无规格信息的简单文字，“年”、“月”等计费模式，“套”、“次”等计数单位命名。 非特殊场景（镜像、API类、AI资产类商品），请勿发布“0元”规格，避免被无限购买的风险。 软件商品的规格请勿涉及人工服务内容，如：运维服务、迁移服务、定制开发等，需要另外发布一个配套的“人工服务”商品，命名为“XXX配套服务”，再添加该规格。 发布人工服务类商品时，若商品规格涉及人天服务内容，请参考《发布多SKU 定价 的商品规格》。 API类商品规格，如设置0元套餐包，不可设置为“0元，同一用户订购次数多次”，此套餐包对同一用户，不可无限次购买，请将同一用户订购次数中多次改为一次。 父主题： 商品发布相关问题

开票要求 请开具电子版或纸质版增值税专用发票，优先选择电子版。 如开具电子专票，请将开票清单及电子发票发送至发票团队公邮: hwinvoice@huawei.com （仅接收PDF或OFD格式电子发票原件，不接收照片、 扫描件），如有疑问可联系028-62844628。 如开具纸质专票，请打印开票清单连同纸质发票一起邮寄至以下地址： 发票邮寄地址：四川省成都市高新西区西源大道1899号华为成都账务共享中心 发票接收人：华为成都财务发票团队 发票接收人电话：028-62844628 纸质发票上需要有商家公司的签字或盖章。 一个申付单可开具多张发票，请将一个申付单中的所有发票合并发送，否则将导致付款延迟。 例如：某账期金额1000元，申付单号为A，商家开具2张500元的发票，2张发票需备注申付单号A，并且一起发送或寄出，当申付金额与发票总金额一致时，华为才可发起付款。 请参照下表《开票信息》填写发票。 表1 开票信息 开票信息 对应值 发票类型 增值税专用发票 单位名称（户名） 华为云计算 技术有限公司 税号 91520900MA6J6CBN9Q 说明： 如果商家完成了“三证合一”变更，请在开具的增值税专用发票上的销货单位处使用变更后的纳税人识别号。 地址 贵州省贵安新区黔中大道交兴功路华为云数据中心 电话 15817463372 说明： 此电话号码仅供开票使用，请勿电话咨询此号码，有问题提工单处理。 开户行及账号 中国工商银行股份有限公司深圳华为支行 4000056019100216486 发票内容 请按销售的商品对应的税务类型开具； 如账单中有多个商品，可在发票里添加多个劳务名称。 税率 请按开票清单中的税率开具。 注意： 包周期的软件商品税率为6%。如涉及多个税率，不同税率的发票请分开开具。 备注 请在备注中填写申付单号和对账期次。 说明： 申付单号可在开票通知中获取。 开票清单中标*的内容为必填项，请注意补充空白项。 在发票备注栏填写申付单号和对账期次。申付单号可在开票清单查看。 开票金额请按照开票清单中的账期金额填写，如对金额有疑问可咨询邮箱partner@huaweicloud.com。 开票内容：请根据实际情况，按销售的商品属性开具。 纸质发票上需要有商家公司的签字或盖章，电子发票和开票清单不需要。 请勿合并申付单开票，同一申付单号可对应多张发票，但一张发票不可对应多个申付单号。如一个申付单上涉及不同税率的发票，请合并开具在一张发票上。 请确保开票清单中的供应商联系电话与邮件有效，如开具发票存在问题，工作人员将联系供应商负责人核实。 发票中的纳税人身份需与商业信息认证身份一致，如有变更，请联系客服协助处理。

服务监管总体流程 2025年3月26日前所下订单服务监管流程： 图1 通用商品服务监管流程 图2 联营商品、华为商品服务监管流程 2025年3月26日后所下订单服务监管流程： 图3 通用商品服务监管流程 图4 联营商品、华为商品服务监管流程 联营商品订单，赋能云场景及基地云场景需“华为云复核”，其他场景订单验收遵循商家自定义验收规则 注意：什么是赋能云场景请参照联营商品赋能云场景验收规则；什么是基地云场景请参照联营商品基地云场景验收规则。 用户服务监管操作说明，请参考《人工服务类商品服务监管（用户）》。

服务监管总体流程 图1 通用商品服务监管流程 图2 联营商品、华为商品服务监管流程 联营商品订单，赋能云场景及基地云场景需“华为云复核”，其他场景订单验收遵循商家自定义验收规则 注意：什么是赋能云场景请参照联营商品赋能云场景验收规则；什么是基地云场景请参照联营商品基地云场景验收规则。 用户服务监管操作说明，请参考《License商品线下服务监管（用户）》。 如用户对已完成服务监管的商品订单进行续费，新续费的订单将不涉及服务监管流程。

调用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" } }

错误码说明 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 更多服务错误码请参见API错误中心。 状态码 错误码 错误信息 描述 处理措施 400 IDE.00000097 输入参数校验失败。 输入参数校验失败。 检查输入参数格式。 403 IDE.00040014 无访问权限。 无访问权限。 根据错误信息，检查相应的权限是否满足。 404 IDE.00900001 激活码不存在。 激活码不存在。 检查输入的激活码。 406 IDE.00000040 HTTP访问异常。 HTTP访问异常。 请重试。如仍有问题，请联系支持工程师处理。 406 IDE.00900007 存在未支付订单。 存在未支付订单。 支付或取消未支付订单。 406 IDE.00900008 激活码数量超出配额。 激活码数量超出配额。 释放未使用的激活码或联系技术支持。

状态码 表1 状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。 父主题： 附录

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result Boolean 参数解释： 激活码是否绑定成功。 取值范围： true：绑定成功。 false：绑定失败。 status String 参数解释： 请求响应的状态，表明请求是否成功。 取值范围： success：请求响应成功。 error：请求响应失败。 状态码： 401 表3 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。详情请参见错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误描述信息。详情请参见错误码。 取值范围： 不涉及。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 result Boolean 参数解释： 激活码是否绑定成功。 取值范围： true：绑定成功。 false：绑定失败。 status String 参数解释： 请求响应的状态，表明请求是否成功。 取值范围： success：请求响应成功。 error：请求响应失败。 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。详情请参见错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误描述信息。详情请参见错误码。 取值范围： 不涉及。

响应示例 状态码：200 OK { "result" : { "size" : 1, "total_items_count" : 1, "items_before" : 0, "items" : [ { "id" : "20d*****-****-****-****-*********e4w", "order_id" : "CS24012510353I6V5", "creater_id" : "0dc311a468024a...", "spec_code" : "codeartside.basic", "status" : 0, "charging_mode" : "prePaid", "created_time" : "2024-01-25T01:58:00Z" } ], "empty" : false }, "status" : "success" } 状态码：401 { "error_msg": "权限不足", "error_code": "IDE.0.000005" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result result Object 参数解释： 查询激活码列表范围值，其中包括激活码数量和激活码信息 取值范围： 不涉及。 status String 参数解释： 请求响应的状态，表明请求是否成功。 取值范围： success：请求响应成功。 error：请求响应失败。 表3 result 参数 参数类型 描述 size Long 参数解释： 每页显示的条目数量。 取值范围： 10、20、30 total_count String 参数解释： 查询出的激活码总量。 取值范围： 0-100 iterms_before Long 参数解释： 偏移量。 取值范围： 0-100 iterms Array of LicenseV2Vo 参数解释： 激活码详情。 取值范围： 不涉及 表4 LicenseV2Vo 参数 参数类型 描述 id String 参数解释： 激活码ID。 取值范围： 一段随机数，不涉及取值范围。 order_id String 参数解释： 订单号。 取值范围： 一段随机数，不涉及取值范围。 creater_id String 参数解释： 创建者用户id。 取值范围： 一段随机数，不涉及取值范围。 spec_code String 参数解释： 规格SKU。 取值范围： 一段随机数，不涉及取值范围。 user_id String 参数解释： 用户ID。 取值范围： 一段随机数，不涉及取值范围。 machine_code String 参数解释： 使用者机器码。 取值范围： 一段随机数，不涉及取值范围。 status String 参数解释： 激活码的状态码。 取值范围： 0，1，2，3 charging_mode String 参数解释： 付费模式。 取值范围： 0，1 created_time Date 参数解释： 创建时间。 取值范围： 1970年至今。 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。详情请参见错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误描述信息。详情请参见错误码。 取值范围： 不涉及。

URI GET /v2/licenses 表1 Query参数 参数 是否必选 参数类型 描述 id 否 String 参数解释： 唯一标识，购买激活码返回值中的激活码ID。 约束限制： 不涉及。 取值范围： 由数字、大小写英文字母和-组成。 默认取值： 不涉及。 user_id 否 String 参数解释： 用户ID，在管理控制台，我的凭证，IAM用户ID。 约束限制： 不涉及。 取值范围： 由数字、大小写英文字母组成。 默认取值： 不涉及。 status 否 String 参数解释： 激活码状态。 约束限制： 不涉及。 取值范围： FREEZE：冻结 DELETED：删除 NORMAL：正常 UNPAID：未支付 默认取值： 不涉及。 limit 否 Long 参数解释： 查询的消息条数。 约束限制： 不涉及。 取值范围： [1~100]的整数。 默认取值： 15 offset 否 Long 参数解释： 偏移量。 约束限制： 不涉及。 取值范围： 最小值0 默认取值： 0

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 spec_code 是 String 参数解释： 规格(SKU)：购买的产品规格。 约束限制： 不涉及。 取值范围： publiccloud：公有云规格。 codeartside.basic：codeartside基本规格。 默认取值： 不涉及。 charging_mode 否 String 参数解释： CodeArts IDE激活码的计费模式。 约束限制： 不涉及。 取值范围： 仅支持“prePaid”，包周期计费模式。 默认取值： prePaid period_type 否 String 参数解释： 包周期计费的单位，周期类型如年、月。 约束限制： 不涉及。 取值范围： 仅支持“month”，按月包周期计费模式。 默认取值： month period_num 是 Integer 参数解释： 续费变更的周期数。 约束限制： 不涉及。 取值范围： 仅支持“1”。 默认取值： 1 is_auto_renew 否 Boolean 参数解释： 包周期的资源是否开通自动续费，非包周期资源为空。 约束限制： 不涉及。 取值范围： true：开通自动续费功能。 false：不开通自动续费功能。 默认取值： false is_auto_pay 否 Boolean 参数解释： 是否自动支付费用。 约束限制： 不涉及。 取值范围： true：自动支付费用。 false：不自动支付费用。 默认取值： false count 是 Integer 参数解释： 购买的激活码资源总数。 约束限制： 不涉及。 取值范围： [1~10]的整数。 默认取值： 1。 is_auto_bind 否 Boolean 参数解释： 激活码是否自动绑定用户。 约束限制： 不涉及。 取值范围： true：自动绑定当前用户。 false：不绑定任何用户。 默认取值： false

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 result result Object 参数解释： 返回订单ID和申请的激活码列表。 取值范围： 不涉及。 status String 参数解释： 请求响应的状态，表明请求是否成功。 取值范围： success：请求响应成功。 error：请求响应失败。 表3 result 参数 参数类型 描述 order_id String 参数解释： 返回订单ID。 取值范围： 不涉及。 license_ids Array 参数解释： 购买的激活码列表。 取值范围： 不涉及。 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 参数解释： 错误码。详情请参见错误码。 取值范围： 不涉及。 error_msg String 参数解释： 错误描述信息。详情请参见错误码。 取值范围： 不涉及。

响应示例 状态码： 200 { "result" : { "order_id" : "CS24012510353I6V5", "license_ids" : [ "20d*****-****-****-****-*********e4w" ] }, "status" : "success" } 状态码：401 { "error_msg": "权限不足", "error_code": "IDE.0.000005" }

请求示例 购买1个publiccloud规格的按月包周期计费，不开通自动续费和自动付款，且不绑定用户的CodeArts IDE激活码。 POST https://{endpoint}/v2/licenses { "spec_code" : "publiccloud", "charging_mode" : "prePaid", "period_type" : "month", "period_num" : 1, "is_auto_renew" : false, "is_auto_pay" : false, "count" : 1, "is_auto_bind" : false }

响应消息体 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "cn-north-4", ...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001" } 其中，error_code表示错误码，error_msg表示错误描述信息。

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 在构造请求中以调用获取用户Token接口为例说明了如何调用API。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户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值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 GET https://iam.cn-north-4.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ....

AK/SK认证 AK/SK签名认证方式仅支持消息体大小12M以内，12M以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK(Access Key ID)：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK(Secret Access Key)：与访问密钥ID结合使用的密钥，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

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

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 名称 描述 是否必选 备注 Content-Type 消息体的类型（格式） 是 默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token 用户Token 否 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 X-Project-ID 子项目ID 否 在多项目场景中使用 X-Domain-ID 账号ID - - 公有云API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

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